The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Paws::Quicksight::CreateDataSource - Arguments for method CreateDataSource on Paws::Quicksight

DESCRIPTION

This class represents the parameters used for calling the method CreateDataSource on the Amazon QuickSight service. Use the attributes of this class as arguments to method CreateDataSource.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDataSource.

SYNOPSIS

    my $quicksight = Paws->service('Quicksight');
    my $CreateDataSourceResponse = $quicksight->CreateDataSource(
      AwsAccountId => 'MyAwsAccountId',
      DataSourceId => 'MyResourceId',
      Name         => 'MyResourceName',
      Type         => 'ADOBE_ANALYTICS',
      Credentials  => {
        CopySourceArn  => 'MyCopySourceArn',    # OPTIONAL
        CredentialPair => {
          Password                      => 'MyPassword',    # min: 1, max: 1024
          Username                      => 'MyUsername',    # min: 1, max: 64
          AlternateDataSourceParameters => [
            {
              AmazonElasticsearchParameters => {
                Domain => 'MyDomain',    # min: 1, max: 64

              },    # OPTIONAL
              AthenaParameters => {
                WorkGroup => 'MyWorkGroup',    # min: 1, max: 128; OPTIONAL
              },    # OPTIONAL
              AuroraParameters => {
                Database => 'MyDatabase',    # min: 1, max: 128
                Host     => 'MyHost',        # min: 1, max: 256
                Port     => 1,               # min: 1, max: 65535

              },    # OPTIONAL
              AuroraPostgreSqlParameters => {
                Database => 'MyDatabase',    # min: 1, max: 128
                Host     => 'MyHost',        # min: 1, max: 256
                Port     => 1,               # min: 1, max: 65535

              },    # OPTIONAL
              AwsIotAnalyticsParameters => {
                DataSetName => 'MyDataSetName',    # min: 1, max: 128

              },    # OPTIONAL
              JiraParameters => {
                SiteBaseUrl => 'MySiteBaseUrl',    # min: 1, max: 1024

              },    # OPTIONAL
              MariaDbParameters => {
                Database => 'MyDatabase',    # min: 1, max: 128
                Host     => 'MyHost',        # min: 1, max: 256
                Port     => 1,               # min: 1, max: 65535

              },    # OPTIONAL
              MySqlParameters => {
                Database => 'MyDatabase',    # min: 1, max: 128
                Host     => 'MyHost',        # min: 1, max: 256
                Port     => 1,               # min: 1, max: 65535

              },    # OPTIONAL
              OracleParameters => {
                Database => 'MyDatabase',    # min: 1, max: 128
                Host     => 'MyHost',        # min: 1, max: 256
                Port     => 1,               # min: 1, max: 65535

              },    # OPTIONAL
              PostgreSqlParameters => {
                Database => 'MyDatabase',    # min: 1, max: 128
                Host     => 'MyHost',        # min: 1, max: 256
                Port     => 1,               # min: 1, max: 65535

              },    # OPTIONAL
              PrestoParameters => {
                Catalog => 'MyCatalog',    # max: 128
                Host    => 'MyHost',       # min: 1, max: 256
                Port    => 1,              # min: 1, max: 65535

              },    # OPTIONAL
              RdsParameters => {
                Database   => 'MyDatabase',      # min: 1, max: 128
                InstanceId => 'MyInstanceId',    # min: 1, max: 64

              },    # OPTIONAL
              RedshiftParameters => {
                Database  => 'MyDatabase',     # min: 1, max: 128
                ClusterId => 'MyClusterId',    # min: 1, max: 64; OPTIONAL
                Host      => 'MyHost',         # min: 1, max: 256
                Port      => 1,                # max: 65535; OPTIONAL
              },    # OPTIONAL
              S3Parameters => {
                ManifestFileLocation => {
                  Bucket => 'MyS3Bucket',    # min: 1, max: 1024
                  Key    => 'MyS3Key',       # min: 1, max: 1024

                },

              },    # OPTIONAL
              ServiceNowParameters => {
                SiteBaseUrl => 'MySiteBaseUrl',    # min: 1, max: 1024

              },    # OPTIONAL
              SnowflakeParameters => {
                Database  => 'MyDatabase',     # min: 1, max: 128
                Host      => 'MyHost',         # min: 1, max: 256
                Warehouse => 'MyWarehouse',    # max: 128

              },    # OPTIONAL
              SparkParameters => {
                Host => 'MyHost',    # min: 1, max: 256
                Port => 1,           # min: 1, max: 65535

              },    # OPTIONAL
              SqlServerParameters => {
                Database => 'MyDatabase',    # min: 1, max: 128
                Host     => 'MyHost',        # min: 1, max: 256
                Port     => 1,               # min: 1, max: 65535

              },    # OPTIONAL
              TeradataParameters => {
                Database => 'MyDatabase',    # min: 1, max: 128
                Host     => 'MyHost',        # min: 1, max: 256
                Port     => 1,               # min: 1, max: 65535

              },    # OPTIONAL
              TwitterParameters => {
                MaxRows => 1,            # min: 1
                Query   => 'MyQuery',    # min: 1, max: 256

              },    # OPTIONAL
            },
            ...
          ],    # min: 1, max: 50; OPTIONAL
        },    # OPTIONAL
      },    # OPTIONAL
      DataSourceParameters => {
        AmazonElasticsearchParameters => {
          Domain => 'MyDomain',    # min: 1, max: 64

        },    # OPTIONAL
        AthenaParameters => {
          WorkGroup => 'MyWorkGroup',    # min: 1, max: 128; OPTIONAL
        },    # OPTIONAL
        AuroraParameters => {
          Database => 'MyDatabase',    # min: 1, max: 128
          Host     => 'MyHost',        # min: 1, max: 256
          Port     => 1,               # min: 1, max: 65535

        },    # OPTIONAL
        AuroraPostgreSqlParameters => {
          Database => 'MyDatabase',    # min: 1, max: 128
          Host     => 'MyHost',        # min: 1, max: 256
          Port     => 1,               # min: 1, max: 65535

        },    # OPTIONAL
        AwsIotAnalyticsParameters => {
          DataSetName => 'MyDataSetName',    # min: 1, max: 128

        },    # OPTIONAL
        JiraParameters => {
          SiteBaseUrl => 'MySiteBaseUrl',    # min: 1, max: 1024

        },    # OPTIONAL
        MariaDbParameters => {
          Database => 'MyDatabase',    # min: 1, max: 128
          Host     => 'MyHost',        # min: 1, max: 256
          Port     => 1,               # min: 1, max: 65535

        },    # OPTIONAL
        MySqlParameters => {
          Database => 'MyDatabase',    # min: 1, max: 128
          Host     => 'MyHost',        # min: 1, max: 256
          Port     => 1,               # min: 1, max: 65535

        },    # OPTIONAL
        OracleParameters => {
          Database => 'MyDatabase',    # min: 1, max: 128
          Host     => 'MyHost',        # min: 1, max: 256
          Port     => 1,               # min: 1, max: 65535

        },    # OPTIONAL
        PostgreSqlParameters => {
          Database => 'MyDatabase',    # min: 1, max: 128
          Host     => 'MyHost',        # min: 1, max: 256
          Port     => 1,               # min: 1, max: 65535

        },    # OPTIONAL
        PrestoParameters => {
          Catalog => 'MyCatalog',    # max: 128
          Host    => 'MyHost',       # min: 1, max: 256
          Port    => 1,              # min: 1, max: 65535

        },    # OPTIONAL
        RdsParameters => {
          Database   => 'MyDatabase',      # min: 1, max: 128
          InstanceId => 'MyInstanceId',    # min: 1, max: 64

        },    # OPTIONAL
        RedshiftParameters => {
          Database  => 'MyDatabase',     # min: 1, max: 128
          ClusterId => 'MyClusterId',    # min: 1, max: 64; OPTIONAL
          Host      => 'MyHost',         # min: 1, max: 256
          Port      => 1,                # max: 65535; OPTIONAL
        },    # OPTIONAL
        S3Parameters => {
          ManifestFileLocation => {
            Bucket => 'MyS3Bucket',    # min: 1, max: 1024
            Key    => 'MyS3Key',       # min: 1, max: 1024

          },

        },    # OPTIONAL
        ServiceNowParameters => {
          SiteBaseUrl => 'MySiteBaseUrl',    # min: 1, max: 1024

        },    # OPTIONAL
        SnowflakeParameters => {
          Database  => 'MyDatabase',     # min: 1, max: 128
          Host      => 'MyHost',         # min: 1, max: 256
          Warehouse => 'MyWarehouse',    # max: 128

        },    # OPTIONAL
        SparkParameters => {
          Host => 'MyHost',    # min: 1, max: 256
          Port => 1,           # min: 1, max: 65535

        },    # OPTIONAL
        SqlServerParameters => {
          Database => 'MyDatabase',    # min: 1, max: 128
          Host     => 'MyHost',        # min: 1, max: 256
          Port     => 1,               # min: 1, max: 65535

        },    # OPTIONAL
        TeradataParameters => {
          Database => 'MyDatabase',    # min: 1, max: 128
          Host     => 'MyHost',        # min: 1, max: 256
          Port     => 1,               # min: 1, max: 65535

        },    # OPTIONAL
        TwitterParameters => {
          MaxRows => 1,            # min: 1
          Query   => 'MyQuery',    # min: 1, max: 256

        },    # OPTIONAL
      },    # OPTIONAL
      Permissions => [
        {
          Actions   => [ 'MyString', ... ],    # min: 1, max: 16
          Principal => 'MyPrincipal',          # min: 1, max: 256

        },
        ...
      ],    # OPTIONAL
      SslProperties => {
        DisableSsl => 1,    # OPTIONAL
      },    # OPTIONAL
      Tags => [
        {
          Key   => 'MyTagKey',      # min: 1, max: 128
          Value => 'MyTagValue',    # min: 1, max: 256

        },
        ...
      ],    # OPTIONAL
      VpcConnectionProperties => {
        VpcConnectionArn => 'MyArn',

      },    # OPTIONAL
    );

    # Results:
    my $Arn            = $CreateDataSourceResponse->Arn;
    my $CreationStatus = $CreateDataSourceResponse->CreationStatus;
    my $DataSourceId   = $CreateDataSourceResponse->DataSourceId;
    my $RequestId      = $CreateDataSourceResponse->RequestId;
    my $Status         = $CreateDataSourceResponse->Status;

    # Returns a L<Paws::Quicksight::CreateDataSourceResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/quicksight/CreateDataSource

ATTRIBUTES

REQUIRED AwsAccountId => Str

The AWS account ID.

Credentials => Paws::Quicksight::DataSourceCredentials

The credentials QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.

REQUIRED DataSourceId => Str

An ID for the data source. This ID is unique per AWS Region for each AWS account.

DataSourceParameters => Paws::Quicksight::DataSourceParameters

The parameters that QuickSight uses to connect to your underlying source.

REQUIRED Name => Str

A display name for the data source.

Permissions => ArrayRef[Paws::Quicksight::ResourcePermission]

A list of resource permissions on the data source.

SslProperties => Paws::Quicksight::SslProperties

Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.

Tags => ArrayRef[Paws::Quicksight::Tag]

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

REQUIRED Type => Str

The type of the data source. Currently, the supported types for this operation are: ATHENA, AURORA, AURORA_POSTGRESQL, AMAZON_ELASTICSEARCH, MARIADB, MYSQL, POSTGRESQL, PRESTO, REDSHIFT, S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA. Use ListDataSources to return a list of all data sources.

AMAZON_ELASTICSEARCH is for Amazon managed Elasticsearch Service.

Valid values are: "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "ORACLE", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER", "TIMESTREAM"

VpcConnectionProperties => Paws::Quicksight::VpcConnectionProperties

Use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateDataSource in Paws::Quicksight

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues