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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#alternate_data_source_parameters ⇒ Array<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:



8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8083

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,
  :secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

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

Returns:

  • (String) 


8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8083

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,
  :secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#created_time ⇒ Time

The time that this data source was created.

Returns:

  • (Time) 


8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8083

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,
  :secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#data_source_id ⇒ String

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

Returns:

  • (String) 


8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8083

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,
  :secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#data_source_parameters ⇒ Types::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.

Returns:



8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8083

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,
  :secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#error_info ⇒ Types::DataSourceErrorInfo

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

Returns:



8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8083

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,
  :secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_time ⇒ Time

The last time that this data source was updated.

Returns:

  • (Time) 


8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8083

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,
  :secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

A display name for the data source.

Returns:

  • (String) 


8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8083

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,
  :secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#secret_arn ⇒ String

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

Returns:

  • (String) 


8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8083

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,
  :secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#ssl_properties ⇒ Types::SslProperties

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

Returns:



8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8083

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,
  :secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The HTTP status of the request.

Returns:

  • (String) 


8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8083

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,
  :secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

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

Returns:

  • (String) 


8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8083

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,
  :secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_connection_properties ⇒ Types::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.

Returns:



8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8083

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,
  :secret_arn)
  SENSITIVE = []
  include Aws::Structure
end