Class: AWSCDK::QuickSight::CfnDataSource::DataSourceCredentialsProperty

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

Overview

Data source credentials.

This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(copy_source_arn: nil, credential_pair: nil, key_pair_credentials: nil, secret_arn: nil) ⇒ DataSourceCredentialsProperty

Returns a new instance of DataSourceCredentialsProperty.

Parameters:



993
994
995
996
997
998
999
1000
1001
1002
 
# File 'quick_sight/cfn_data_source.rb', line 993

def initialize(copy_source_arn: nil, credential_pair: nil, key_pair_credentials: nil, secret_arn: nil)
  @copy_source_arn = copy_source_arn
  Jsii::Type.check_type(@copy_source_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "copySourceArn") unless @copy_source_arn.nil?
  @credential_pair = credential_pair.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDataSource::CredentialPairProperty.new(**credential_pair.transform_keys(&:to_sym)) : credential_pair
  Jsii::Type.check_type(@credential_pair, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhdGFTb3VyY2UuQ3JlZGVudGlhbFBhaXJQcm9wZXJ0eSJ9XX19")), "credentialPair") unless @credential_pair.nil?
  @key_pair_credentials = key_pair_credentials.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDataSource::KeyPairCredentialsProperty.new(**key_pair_credentials.transform_keys(&:to_sym)) : key_pair_credentials
  Jsii::Type.check_type(@key_pair_credentials, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhdGFTb3VyY2UuS2V5UGFpckNyZWRlbnRpYWxzUHJvcGVydHkifV19fQ==")), "keyPairCredentials") unless @key_pair_credentials.nil?
  @secret_arn = secret_arn
  Jsii::Type.check_type(@secret_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secretArn") unless @secret_arn.nil?
end

Instance Attribute Details

#copy_source_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use.

When CopySourceArn is not null, the credential pair from the data source in the ARN is used as the credentials for the DataSourceCredentials structure.

Returns:

  • (String, nil)

See Also:



1010
1011
1012
 
# File 'quick_sight/cfn_data_source.rb', line 1010

def copy_source_arn
  @copy_source_arn
end

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

Credential pair.

For more information, see [CredentialPair](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CredentialPair.html) .

Returns:

See Also:



1017
1018
1019
 
# File 'quick_sight/cfn_data_source.rb', line 1017

def credential_pair
  @credential_pair
end

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

The credentials for connecting using key-pair.

Returns:

See Also:



1022
1023
1024
 
# File 'quick_sight/cfn_data_source.rb', line 1022

def key_pair_credentials
  @key_pair_credentials
end

#secret_arn ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



1027
1028
1029
 
# File 'quick_sight/cfn_data_source.rb', line 1027

def secret_arn
  @secret_arn
end

Class Method Details

.jsii_properties ⇒ Object 



1029
1030
1031
1032
1033
1034
1035
1036
 
# File 'quick_sight/cfn_data_source.rb', line 1029

def self.jsii_properties
  {
    :copy_source_arn => "copySourceArn",
    :credential_pair => "credentialPair",
    :key_pair_credentials => "keyPairCredentials",
    :secret_arn => "secretArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
 
# File 'quick_sight/cfn_data_source.rb', line 1038

def to_jsii
  result = {}
  result.merge!({
    "copySourceArn" => @copy_source_arn,
    "credentialPair" => @credential_pair,
    "keyPairCredentials" => @key_pair_credentials,
    "secretArn" => @secret_arn,
  })
  result.compact
end