Class: Aws::QuickSight::Types::UpdateDataSourceRequest

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 UpdateDataSourceRequest data as a hash:

{
  aws_account_id: "AwsAccountId", # required
  data_source_id: "ResourceId", # required
  name: "ResourceName", # required
  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
    },
    oracle_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
    },
    amazon_open_search_parameters: {
      domain: "Domain", # required
    },
    exasol_parameters: {
      host: "Host", # required
      port: 1, # required
    },
  },
  credentials: {
    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
          },
          oracle_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
          },
          amazon_open_search_parameters: {
            domain: "Domain", # required
          },
          exasol_parameters: {
            host: "Host", # required
            port: 1, # required
          },
        },
      ],
    },
    copy_source_arn: "CopySourceArn",
  },
  vpc_connection_properties: {
    vpc_connection_arn: "Arn", # required
  },
  ssl_properties: {
    disable_ssl: false,
  },
}

See Also:

Constant Summary collapse

SENSITIVE = 
[:credentials]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_id ⇒ String

The Amazon Web Services account ID.

Returns:

  • (String) 


14209
14210
14211
14212
14213
14214
14215
14216
14217
14218
14219
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 14209

class UpdateDataSourceRequest < Struct.new(
  :aws_account_id,
  :data_source_id,
  :name,
  :data_source_parameters,
  :credentials,
  :vpc_connection_properties,
  :ssl_properties)
  SENSITIVE = [:credentials]
  include Aws::Structure
end

#credentials ⇒ Types::DataSourceCredentials

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

Returns:



14209
14210
14211
14212
14213
14214
14215
14216
14217
14218
14219
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 14209

class UpdateDataSourceRequest < Struct.new(
  :aws_account_id,
  :data_source_id,
  :name,
  :data_source_parameters,
  :credentials,
  :vpc_connection_properties,
  :ssl_properties)
  SENSITIVE = [:credentials]
  include Aws::Structure
end

#data_source_id ⇒ String

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Returns:

  • (String) 


14209
14210
14211
14212
14213
14214
14215
14216
14217
14218
14219
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 14209

class UpdateDataSourceRequest < Struct.new(
  :aws_account_id,
  :data_source_id,
  :name,
  :data_source_parameters,
  :credentials,
  :vpc_connection_properties,
  :ssl_properties)
  SENSITIVE = [:credentials]
  include Aws::Structure
end

#data_source_parameters ⇒ Types::DataSourceParameters

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

Returns:



14209
14210
14211
14212
14213
14214
14215
14216
14217
14218
14219
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 14209

class UpdateDataSourceRequest < Struct.new(
  :aws_account_id,
  :data_source_id,
  :name,
  :data_source_parameters,
  :credentials,
  :vpc_connection_properties,
  :ssl_properties)
  SENSITIVE = [:credentials]
  include Aws::Structure
end

#name ⇒ String

A display name for the data source.

Returns:

  • (String) 


14209
14210
14211
14212
14213
14214
14215
14216
14217
14218
14219
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 14209

class UpdateDataSourceRequest < Struct.new(
  :aws_account_id,
  :data_source_id,
  :name,
  :data_source_parameters,
  :credentials,
  :vpc_connection_properties,
  :ssl_properties)
  SENSITIVE = [:credentials]
  include Aws::Structure
end

#ssl_properties ⇒ Types::SslProperties

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

Returns:



14209
14210
14211
14212
14213
14214
14215
14216
14217
14218
14219
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 14209

class UpdateDataSourceRequest < Struct.new(
  :aws_account_id,
  :data_source_id,
  :name,
  :data_source_parameters,
  :credentials,
  :vpc_connection_properties,
  :ssl_properties)
  SENSITIVE = [:credentials]
  include Aws::Structure
end

#vpc_connection_properties ⇒ Types::VpcConnectionProperties

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

Returns:



14209
14210
14211
14212
14213
14214
14215
14216
14217
14218
14219
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 14209

class UpdateDataSourceRequest < Struct.new(
  :aws_account_id,
  :data_source_id,
  :name,
  :data_source_parameters,
  :credentials,
  :vpc_connection_properties,
  :ssl_properties)
  SENSITIVE = [:credentials]
  include Aws::Structure
end