Class: AWSCDK::QuickSight::CfnDataSourceProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
quick_sight/cfn_data_source_props.rb

Overview

Properties for defining a CfnDataSource.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, type:, alternate_data_source_parameters: nil, aws_account_id: nil, credentials: nil, data_source_id: nil, data_source_parameters: nil, error_info: nil, folder_arns: nil, permissions: nil, ssl_properties: nil, tags: nil, vpc_connection_properties: nil) ⇒ CfnDataSourceProps

Returns a new instance of CfnDataSourceProps.

Parameters:



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'quick_sight/cfn_data_source_props.rb', line 22

def initialize(name:, type:, alternate_data_source_parameters: nil, aws_account_id: nil, credentials: nil, data_source_id: nil, data_source_parameters: nil, error_info: nil, folder_arns: nil, permissions: nil, ssl_properties: nil, tags: nil, vpc_connection_properties: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @alternate_data_source_parameters = alternate_data_source_parameters
  Jsii::Type.check_type(@alternate_data_source_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5EYXRhU291cmNlLkRhdGFTb3VyY2VQYXJhbWV0ZXJzUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "alternateDataSourceParameters") unless @alternate_data_source_parameters.nil?
  @aws_account_id = 
  Jsii::Type.check_type(@aws_account_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "awsAccountId") unless @aws_account_id.nil?
  @credentials = credentials.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDataSource::DataSourceCredentialsProperty.new(**credentials.transform_keys(&:to_sym)) : credentials
  Jsii::Type.check_type(@credentials, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhdGFTb3VyY2UuRGF0YVNvdXJjZUNyZWRlbnRpYWxzUHJvcGVydHkifV19fQ==")), "credentials") unless @credentials.nil?
  @data_source_id = data_source_id
  Jsii::Type.check_type(@data_source_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataSourceId") unless @data_source_id.nil?
  @data_source_parameters = data_source_parameters.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDataSource::DataSourceParametersProperty.new(**data_source_parameters.transform_keys(&:to_sym)) : data_source_parameters
  Jsii::Type.check_type(@data_source_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhdGFTb3VyY2UuRGF0YVNvdXJjZVBhcmFtZXRlcnNQcm9wZXJ0eSJ9XX19")), "dataSourceParameters") unless @data_source_parameters.nil?
  @error_info = error_info.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDataSource::DataSourceErrorInfoProperty.new(**error_info.transform_keys(&:to_sym)) : error_info
  Jsii::Type.check_type(@error_info, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhdGFTb3VyY2UuRGF0YVNvdXJjZUVycm9ySW5mb1Byb3BlcnR5In1dfX0=")), "errorInfo") unless @error_info.nil?
  @folder_arns = folder_arns
  Jsii::Type.check_type(@folder_arns, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "folderArns") unless @folder_arns.nil?
  @permissions = permissions
  Jsii::Type.check_type(@permissions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5EYXRhU291cmNlLlJlc291cmNlUGVybWlzc2lvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "permissions") unless @permissions.nil?
  @ssl_properties = ssl_properties.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDataSource::SSLPropertiesProperty.new(**ssl_properties.transform_keys(&:to_sym)) : ssl_properties
  Jsii::Type.check_type(@ssl_properties, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhdGFTb3VyY2UuU3NsUHJvcGVydGllc1Byb3BlcnR5In1dfX0=")), "sslProperties") unless @ssl_properties.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @vpc_connection_properties = vpc_connection_properties.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDataSource::VPCConnectionPropertiesProperty.new(**vpc_connection_properties.transform_keys(&:to_sym)) : vpc_connection_properties
  Jsii::Type.check_type(@vpc_connection_properties, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhdGFTb3VyY2UuVnBjQ29ubmVjdGlvblByb3BlcnRpZXNQcm9wZXJ0eSJ9XX19")), "vpcConnectionProperties") unless @vpc_connection_properties.nil?
end

Instance Attribute Details

#alternate_data_source_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

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:

See Also:



69
70
71
 
# File 'quick_sight/cfn_data_source_props.rb', line 69

def alternate_data_source_parameters
  @alternate_data_source_parameters
end

#aws_account_id ⇒ String? (readonly)

The AWS account ID.

Returns:

  • (String, nil)

See Also:



74
75
76
 
# File 'quick_sight/cfn_data_source_props.rb', line 74

def 
  @aws_account_id
end

#credentials ⇒ AWSCDK::IResolvable, ... (readonly)

The credentials Amazon Quick Sight that uses to connect to your underlying source.

Currently, only credentials based on user name and password are supported.

Returns:

See Also:



81
82
83
 
# File 'quick_sight/cfn_data_source_props.rb', line 81

def credentials
  @credentials
end

#data_source_id ⇒ String? (readonly)

An ID for the data source.

This ID is unique per AWS Region for each AWS account.

Returns:

  • (String, nil)

See Also:



88
89
90
 
# File 'quick_sight/cfn_data_source_props.rb', line 88

def data_source_id
  @data_source_id
end

#data_source_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

The parameters that Amazon Quick Sight uses to connect to your underlying source.

Returns:

See Also:



93
94
95
 
# File 'quick_sight/cfn_data_source_props.rb', line 93

def data_source_parameters
  @data_source_parameters
end

#error_info ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



98
99
100
 
# File 'quick_sight/cfn_data_source_props.rb', line 98

def error_info
  @error_info
end

#folder_arns ⇒ Array<String>? (readonly)

Returns:

  • (Array<String>, nil)

See Also:



101
102
103
 
# File 'quick_sight/cfn_data_source_props.rb', line 101

def folder_arns
  @folder_arns
end

#name ⇒ String (readonly)

A display name for the data source.

Returns:

  • (String)

See Also:



55
56
57
 
# File 'quick_sight/cfn_data_source_props.rb', line 55

def name
  @name
end

#permissions ⇒ AWSCDK::IResolvable, ... (readonly)

A list of resource permissions on the data source.

Returns:

See Also:



106
107
108
 
# File 'quick_sight/cfn_data_source_props.rb', line 106

def permissions
  @permissions
end

#ssl_properties ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



111
112
113
 
# File 'quick_sight/cfn_data_source_props.rb', line 111

def ssl_properties
  @ssl_properties
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

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

Returns:

See Also:



116
117
118
 
# File 'quick_sight/cfn_data_source_props.rb', line 116

def tags
  @tags
end

#type ⇒ String (readonly)

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)

See Also:



62
63
64
 
# File 'quick_sight/cfn_data_source_props.rb', line 62

def type
  @type
end

#vpc_connection_properties ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



121
122
123
 
# File 'quick_sight/cfn_data_source_props.rb', line 121

def vpc_connection_properties
  @vpc_connection_properties
end

Class Method Details

.jsii_properties ⇒ Object 



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'quick_sight/cfn_data_source_props.rb', line 123

def self.jsii_properties
  {
    :name => "name",
    :type => "type",
    :alternate_data_source_parameters => "alternateDataSourceParameters",
    :aws_account_id => "awsAccountId",
    :credentials => "credentials",
    :data_source_id => "dataSourceId",
    :data_source_parameters => "dataSourceParameters",
    :error_info => "errorInfo",
    :folder_arns => "folderArns",
    :permissions => "permissions",
    :ssl_properties => "sslProperties",
    :tags => "tags",
    :vpc_connection_properties => "vpcConnectionProperties",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'quick_sight/cfn_data_source_props.rb', line 141

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "type" => @type,
    "alternateDataSourceParameters" => @alternate_data_source_parameters,
    "awsAccountId" => @aws_account_id,
    "credentials" => @credentials,
    "dataSourceId" => @data_source_id,
    "dataSourceParameters" => @data_source_parameters,
    "errorInfo" => @error_info,
    "folderArns" => @folder_arns,
    "permissions" => @permissions,
    "sslProperties" => @ssl_properties,
    "tags" => @tags,
    "vpcConnectionProperties" => @vpc_connection_properties,
  })
  result.compact
end