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

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::CreateDataSourceRequest

Defined in:

gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:credentials]

Instance Attribute Summary

• #aws_account_id ⇒ String

  The Amazon Web Services account ID.

• #credentials ⇒ Types::DataSourceCredentials

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

• #data_source_id ⇒ String

  An ID for the data source.

• #data_source_parameters ⇒ Types::DataSourceParameters

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

• #folder_arns ⇒ Array<String>

  When you create the data source, Amazon QuickSight adds the data source to these folders.

• #name ⇒ String

  A display name for the data source.

• #permissions ⇒ Array<Types::ResourcePermission>

  A list of resource permissions on the data source.

• #ssl_properties ⇒ Types::SslProperties

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

• #tags ⇒ Array<Types::Tag>

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

• #type ⇒ String

  The type of the data source.

• #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.

Instance Attribute Details

#aws_account_id ⇒ String

The Amazon Web Services account ID.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 5055

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

#credentials ⇒ Types::DataSourceCredentials

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

Returns:

• (Types::DataSourceCredentials)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 5055

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

#data_source_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 5055

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

#data_source_parameters ⇒ Types::DataSourceParameters

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

Returns:

• (Types::DataSourceParameters)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 5055

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

#folder_arns ⇒ Array<String>

When you create the data source, Amazon QuickSight adds the data source to these folders.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 5055

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

#name ⇒ String

A display name for the data source.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 5055

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

#permissions ⇒ Array<Types::ResourcePermission>

A list of resource permissions on the data source.

Returns:

• (Array<Types::ResourcePermission>)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 5055

class CreateDataSourceRequest < Struct.new(
  :aws_account_id,
  :data_source_id,
  :name,
  :type,
  :data_source_parameters,
  :credentials,
  :permissions,
  :vpc_connection_properties,
  :ssl_properties,
  :tags,
  :folder_arns)
  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:

• (Types::SslProperties)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 5055

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

#tags ⇒ Array<Types::Tag>

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

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 5055

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

#type ⇒ String

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

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 5055

class CreateDataSourceRequest < Struct.new(
  :aws_account_id,
  :data_source_id,
  :name,
  :type,
  :data_source_parameters,
  :credentials,
  :permissions,
  :vpc_connection_properties,
  :ssl_properties,
  :tags,
  :folder_arns)
  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:

• (Types::VpcConnectionProperties)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 5055

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