Class: AWSCDK::KMS::AliasAttributes

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
kms/alias_attributes.rb

Overview

Properties of a reference to an existing KMS Alias.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(alias_name:, alias_target_key:) ⇒ AliasAttributes

Returns a new instance of AliasAttributes.

Parameters:

  • alias_name (String) —

    Specifies the alias name.

  • alias_target_key (AWSCDK::KMS::IKey) —

    The customer master key (CMK) to which the Alias refers.



9
10
11
12
13
14
 
# File 'kms/alias_attributes.rb', line 9

def initialize(alias_name:, alias_target_key:)
  @alias_name = alias_name
  Jsii::Type.check_type(@alias_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "aliasName")
  @alias_target_key = alias_target_key
  Jsii::Type.check_type(@alias_target_key, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfa21zLklLZXkifQ==")), "aliasTargetKey")
end

Instance Attribute Details

#alias_name ⇒ String (readonly)

Specifies the alias name.

This value must begin with alias/ followed by a name (i.e. alias/ExampleAlias)

Returns:

  • (String) 


21
22
23
 
# File 'kms/alias_attributes.rb', line 21

def alias_name
  @alias_name
end

#alias_target_key ⇒ AWSCDK::KMS::IKey (readonly)

The customer master key (CMK) to which the Alias refers.

Returns:



25
26
27
 
# File 'kms/alias_attributes.rb', line 25

def alias_target_key
  @alias_target_key
end

Class Method Details

.jsii_properties ⇒ Object 



27
28
29
30
31
32
 
# File 'kms/alias_attributes.rb', line 27

def self.jsii_properties
  {
    :alias_name => "aliasName",
    :alias_target_key => "aliasTargetKey",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



34
35
36
37
38
39
40
41
 
# File 'kms/alias_attributes.rb', line 34

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