Class: Aws::QuickSight::Types::DataSourceCredentials

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

Note:

When making an API call, you may pass DataSourceCredentials data as a hash:

{
  credential_pair: {
    username: "Username", # required
    password: "Password", # required
    alternate_data_source_parameters: [
      {
        amazon_elasticsearch_parameters: {
          domain: "Domain", # required
        },
        athena_parameters: {
          work_group: "WorkGroup",
        },
        aurora_parameters: {
          host: "Host", # required
          port: 1, # required
          database: "Database", # required
        },
        aurora_postgre_sql_parameters: {
          host: "Host", # required
          port: 1, # required
          database: "Database", # required
        },
        aws_iot_analytics_parameters: {
          data_set_name: "DataSetName", # required
        },
        jira_parameters: {
          site_base_url: "SiteBaseUrl", # required
        },
        maria_db_parameters: {
          host: "Host", # required
          port: 1, # required
          database: "Database", # required
        },
        my_sql_parameters: {
          host: "Host", # required
          port: 1, # required
          database: "Database", # required
        },
        postgre_sql_parameters: {
          host: "Host", # required
          port: 1, # required
          database: "Database", # required
        },
        presto_parameters: {
          host: "Host", # required
          port: 1, # required
          catalog: "Catalog", # required
        },
        rds_parameters: {
          instance_id: "InstanceId", # required
          database: "Database", # required
        },
        redshift_parameters: {
          host: "Host",
          port: 1,
          database: "Database", # required
          cluster_id: "ClusterId",
        },
        s3_parameters: {
          manifest_file_location: { # required
            bucket: "S3Bucket", # required
            key: "S3Key", # required
          },
        },
        service_now_parameters: {
          site_base_url: "SiteBaseUrl", # required
        },
        snowflake_parameters: {
          host: "Host", # required
          database: "Database", # required
          warehouse: "Warehouse", # required
        },
        spark_parameters: {
          host: "Host", # required
          port: 1, # required
        },
        sql_server_parameters: {
          host: "Host", # required
          port: 1, # required
          database: "Database", # required
        },
        teradata_parameters: {
          host: "Host", # required
          port: 1, # required
          database: "Database", # required
        },
        twitter_parameters: {
          query: "Query", # required
          max_rows: 1, # required
        },
      },
    ],
  },
  copy_source_arn: "CopySourceArn",
}

Data source credentials. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#copy_source_arnString

The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When CopySourceArn is not null, the credential pair from the data source in the ARN is used as the credentials for the DataSourceCredentials structure.

Returns:

  • (String)


3537
3538
3539
3540
3541
3542
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3537

class DataSourceCredentials < Struct.new(
  :credential_pair,
  :copy_source_arn)
  SENSITIVE = []
  include Aws::Structure
end

#credential_pairTypes::CredentialPair

Credential pair. For more information, see CredentialPair.



3537
3538
3539
3540
3541
3542
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3537

class DataSourceCredentials < Struct.new(
  :credential_pair,
  :copy_source_arn)
  SENSITIVE = []
  include Aws::Structure
end