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 compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allowlist. 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:



2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2786

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)


2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2786

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)


2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2786

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 AWS Region for each AWS account.

Returns:

  • (String)


2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2786

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.



2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2786

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.



2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2786

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)


2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2786

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)


2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2786

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 QuickSight connects to your underlying source.



2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2786

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)


2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2786

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)


2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2786

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 QuickSight to use a VPC connection when connecting to your underlying source.



2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2786

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