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

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

Overview

Constant Summary collapse

SENSITIVE =
[:credentials]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_idString

The Amazon Web Services account ID.

Returns:

  • (String)


6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 6208

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

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



6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 6208

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_idString

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

Returns:

  • (String)


6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 6208

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_parametersTypes::DataSourceParameters

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



6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 6208

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_arnsArray<String>

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

Returns:

  • (Array<String>)


6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 6208

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

#nameString

A display name for the data source.

Returns:

  • (String)


6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 6208

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

#permissionsArray<Types::ResourcePermission>

A list of resource permissions on the data source.

Returns:



6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 6208

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_propertiesTypes::SslProperties

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



6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 6208

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

#tagsArray<Types::Tag>

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

Returns:



6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 6208

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

#typeString

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)


6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 6208

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_propertiesTypes::VpcConnectionProperties

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



6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 6208

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