Class: AWSCDK::QuickSight::CfnDataSource::KeyPairCredentialsProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnDataSource::KeyPairCredentialsProperty

Defined in:

quick_sight/cfn_data_source.rb

Overview

The combination of username, private key and passphrase that are used as credentials.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-keypaircredentials.html

Instance Attribute Summary

• #key_pair_username ⇒ String readonly

  Username.

• #private_key ⇒ String readonly

  PrivateKey.

• #private_key_passphrase ⇒ String^? readonly

  PrivateKeyPassphrase.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(key_pair_username:, private_key:, private_key_passphrase: nil) ⇒ KeyPairCredentialsProperty constructor

  A new instance of KeyPairCredentialsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(key_pair_username:, private_key:, private_key_passphrase: nil) ⇒ KeyPairCredentialsProperty

Returns a new instance of KeyPairCredentialsProperty.

Parameters:

• key_pair_username (String) —

  Username.

• private_key (String) —

  PrivateKey.

• private_key_passphrase (String, nil) (defaults to: nil) —

  PrivateKeyPassphrase.

# File 'quick_sight/cfn_data_source.rb', line 1422

def initialize(key_pair_username:, private_key:, private_key_passphrase: nil)
  @key_pair_username = key_pair_username
  Jsii::Type.check_type(@key_pair_username, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "keyPairUsername")
  @private_key = private_key
  Jsii::Type.check_type(@private_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "privateKey")
  @private_key_passphrase = private_key_passphrase
  Jsii::Type.check_type(@private_key_passphrase, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "privateKeyPassphrase") unless @private_key_passphrase.nil?
end

Instance Attribute Details

#key_pair_username ⇒ String (readonly)

Username.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-keypaircredentials.html#cfn-quicksight-datasource-keypaircredentials-keypairusername

# File 'quick_sight/cfn_data_source.rb', line 1435

def key_pair_username
  @key_pair_username
end

#private_key ⇒ String (readonly)

PrivateKey.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-keypaircredentials.html#cfn-quicksight-datasource-keypaircredentials-privatekey

# File 'quick_sight/cfn_data_source.rb', line 1440

def private_key
  @private_key
end

#private_key_passphrase ⇒ String^? (readonly)

PrivateKeyPassphrase.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-keypaircredentials.html#cfn-quicksight-datasource-keypaircredentials-privatekeypassphrase

# File 'quick_sight/cfn_data_source.rb', line 1445

def private_key_passphrase
  @private_key_passphrase
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_data_source.rb', line 1447

def self.jsii_properties
  {
    :key_pair_username => "keyPairUsername",
    :private_key => "privateKey",
    :private_key_passphrase => "privateKeyPassphrase",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_data_source.rb', line 1455

def to_jsii
  result = {}
  result.merge!({
    "keyPairUsername" => @key_pair_username,
    "privateKey" => @private_key,
    "privateKeyPassphrase" => @private_key_passphrase,
  })
  result.compact
end