AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::QuickSight::Types::CreateDataSourceRequest

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

{
  aws_account_id: "AwsAccountId", # required
  data_source_id: "ResourceId", # required
  name: "ResourceName", # required
  type: "ADOBE_ANALYTICS", # required, accepts 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, AMAZON_OPENSEARCH
  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
    },
  },
  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
          },
        },
      ],
    },
    copy_source_arn: "CopySourceArn",
  },
  permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  vpc_connection_properties: {
    vpc_connection_arn: "Arn", # required
  },
  ssl_properties: {
    disable_ssl: false,
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[:credentials]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_idString

The Amazon Web Services account ID.

Returns:

  • (String)


1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1965

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

#credentialsTypes::DataSourceCredentials

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



1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1965

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

#data_source_idString

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

Returns:

  • (String)


1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1965

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

#data_source_parametersTypes::DataSourceParameters

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



1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1965

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

#nameString

A display name for the data source.

Returns:

  • (String)


1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1965

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

#permissionsArray<Types::ResourcePermission>

A list of resource permissions on the data source.

Returns:



1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1965

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

#ssl_propertiesTypes::SslProperties

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



1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1965

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

#tagsArray<Types::Tag>

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

Returns:



1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1965

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

#typeString

The type of the data source. To return a list of all data sources, use ListDataSources.

Use AMAZON_ELASTICSEARCH for Amazon Elasticsearch Service.

Returns:

  • (String)


1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1965

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

#vpc_connection_propertiesTypes::VpcConnectionProperties

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



1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1965

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