Class: AWSCDK::PaymentCryptography::CfnAliasProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
payment_cryptography/cfn_alias_props.rb

Overview

Properties for defining a CfnAlias.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(alias_name:, key_arn: nil) ⇒ CfnAliasProps

Returns a new instance of CfnAliasProps.

Parameters:

  • alias_name (String) —

    A friendly name that you can use to refer to a key. The value must begin with alias/ .

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

    The KeyARN of the key associated with the alias.



11
12
13
14
15
16
 
# File 'payment_cryptography/cfn_alias_props.rb', line 11

def initialize(alias_name:, key_arn: nil)
  @alias_name = alias_name
  Jsii::Type.check_type(@alias_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "aliasName")
  @key_arn = key_arn
  Jsii::Type.check_type(@key_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "keyArn") unless @key_arn.nil?
end

Instance Attribute Details

#alias_name ⇒ String (readonly)

A friendly name that you can use to refer to a key. The value must begin with alias/ .

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in AWS CloudTrail logs and other output.

Returns:

  • (String)

See Also:



24
25
26
 
# File 'payment_cryptography/cfn_alias_props.rb', line 24

def alias_name
  @alias_name
end

#key_arn ⇒ String? (readonly)

The KeyARN of the key associated with the alias.

Returns:

  • (String, nil)

See Also:



29
30
31
 
# File 'payment_cryptography/cfn_alias_props.rb', line 29

def key_arn
  @key_arn
end

Class Method Details

.jsii_properties ⇒ Object 



31
32
33
34
35
36
 
# File 'payment_cryptography/cfn_alias_props.rb', line 31

def self.jsii_properties
  {
    :alias_name => "aliasName",
    :key_arn => "keyArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



38
39
40
41
42
43
44
45
 
# File 'payment_cryptography/cfn_alias_props.rb', line 38

def to_jsii
  result = {}
  result.merge!({
    "aliasName" => @alias_name,
    "keyArn" => @key_arn,
  })
  result.compact
end