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::DataSource

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

Overview

The structure of a data source.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#alternate_data_source_parametersArray<Types::DataSourceParameters>

A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.

Returns:



3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3879

class DataSource < Struct.new(
  :arn,
  :data_source_id,
  :name,
  :type,
  :status,
  :created_time,
  :last_updated_time,
  :data_source_parameters,
  :alternate_data_source_parameters,
  :vpc_connection_properties,
  :ssl_properties,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#arnString

The Amazon Resource Name (ARN) of the data source.

Returns:

  • (String)


3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3879

class DataSource < Struct.new(
  :arn,
  :data_source_id,
  :name,
  :type,
  :status,
  :created_time,
  :last_updated_time,
  :data_source_parameters,
  :alternate_data_source_parameters,
  :vpc_connection_properties,
  :ssl_properties,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#created_timeTime

The time that this data source was created.

Returns:

  • (Time)


3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3879

class DataSource < Struct.new(
  :arn,
  :data_source_id,
  :name,
  :type,
  :status,
  :created_time,
  :last_updated_time,
  :data_source_parameters,
  :alternate_data_source_parameters,
  :vpc_connection_properties,
  :ssl_properties,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#data_source_idString

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

Returns:

  • (String)


3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3879

class DataSource < Struct.new(
  :arn,
  :data_source_id,
  :name,
  :type,
  :status,
  :created_time,
  :last_updated_time,
  :data_source_parameters,
  :alternate_data_source_parameters,
  :vpc_connection_properties,
  :ssl_properties,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#data_source_parametersTypes::DataSourceParameters

The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.



3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3879

class DataSource < Struct.new(
  :arn,
  :data_source_id,
  :name,
  :type,
  :status,
  :created_time,
  :last_updated_time,
  :data_source_parameters,
  :alternate_data_source_parameters,
  :vpc_connection_properties,
  :ssl_properties,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#error_infoTypes::DataSourceErrorInfo

Error information from the last update or the creation of the data source.



3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3879

class DataSource < Struct.new(
  :arn,
  :data_source_id,
  :name,
  :type,
  :status,
  :created_time,
  :last_updated_time,
  :data_source_parameters,
  :alternate_data_source_parameters,
  :vpc_connection_properties,
  :ssl_properties,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_timeTime

The last time that this data source was updated.

Returns:

  • (Time)


3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3879

class DataSource < Struct.new(
  :arn,
  :data_source_id,
  :name,
  :type,
  :status,
  :created_time,
  :last_updated_time,
  :data_source_parameters,
  :alternate_data_source_parameters,
  :vpc_connection_properties,
  :ssl_properties,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

A display name for the data source.

Returns:

  • (String)


3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3879

class DataSource < Struct.new(
  :arn,
  :data_source_id,
  :name,
  :type,
  :status,
  :created_time,
  :last_updated_time,
  :data_source_parameters,
  :alternate_data_source_parameters,
  :vpc_connection_properties,
  :ssl_properties,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#ssl_propertiesTypes::SslProperties

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



3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3879

class DataSource < Struct.new(
  :arn,
  :data_source_id,
  :name,
  :type,
  :status,
  :created_time,
  :last_updated_time,
  :data_source_parameters,
  :alternate_data_source_parameters,
  :vpc_connection_properties,
  :ssl_properties,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The HTTP status of the request.

Returns:

  • (String)


3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3879

class DataSource < Struct.new(
  :arn,
  :data_source_id,
  :name,
  :type,
  :status,
  :created_time,
  :last_updated_time,
  :data_source_parameters,
  :alternate_data_source_parameters,
  :vpc_connection_properties,
  :ssl_properties,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The type of the data source. This type indicates which database engine the data source connects to.

Returns:

  • (String)


3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3879

class DataSource < Struct.new(
  :arn,
  :data_source_id,
  :name,
  :type,
  :status,
  :created_time,
  :last_updated_time,
  :data_source_parameters,
  :alternate_data_source_parameters,
  :vpc_connection_properties,
  :ssl_properties,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_connection_propertiesTypes::VpcConnectionProperties

The VPC connection information. You need to use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.



3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3879

class DataSource < Struct.new(
  :arn,
  :data_source_id,
  :name,
  :type,
  :status,
  :created_time,
  :last_updated_time,
  :data_source_parameters,
  :alternate_data_source_parameters,
  :vpc_connection_properties,
  :ssl_properties,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end