Class: AWSCDK::IAM::CfnAccessKeyProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
iam/cfn_access_key_props.rb

Overview

Properties for defining a CfnAccessKey.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(user_name:, serial: nil, status: nil) ⇒ CfnAccessKeyProps

Returns a new instance of CfnAccessKeyProps.

Parameters:

  • user_name (String) —

    The name of the IAM user that the new key will belong to.

  • serial (Numeric, nil) (defaults to: nil) —

    This value is specific to CloudFormation and can only be incremented .

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

    The status of the access key.



12
13
14
15
16
17
18
19
 
# File 'iam/cfn_access_key_props.rb', line 12

def initialize(user_name:, serial: nil, status: nil)
  @user_name = user_name
  Jsii::Type.check_type(@user_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "userName")
  @serial = serial
  Jsii::Type.check_type(@serial, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "serial") unless @serial.nil?
  @status = status
  Jsii::Type.check_type(@status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "status") unless @status.nil?
end

Instance Attribute Details

#serial ⇒ Numeric? (readonly)

This value is specific to CloudFormation and can only be incremented .

Incrementing this value notifies CloudFormation that you want to rotate your access key. When you update your stack, CloudFormation will replace the existing access key with a new key.

Returns:

  • (Numeric, nil)

See Also:



34
35
36
 
# File 'iam/cfn_access_key_props.rb', line 34

def serial
  @serial
end

#status ⇒ String? (readonly)

The status of the access key.

Active means that the key is valid for API calls, while Inactive means it is not.

Returns:

  • (String, nil)

See Also:



41
42
43
 
# File 'iam/cfn_access_key_props.rb', line 41

def status
  @status
end

#user_name ⇒ String (readonly)

The name of the IAM user that the new key will belong to.

This parameter allows (through its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Returns:

  • (String)

See Also:



27
28
29
 
# File 'iam/cfn_access_key_props.rb', line 27

def user_name
  @user_name
end

Class Method Details

.jsii_properties ⇒ Object 



43
44
45
46
47
48
49
 
# File 'iam/cfn_access_key_props.rb', line 43

def self.jsii_properties
  {
    :user_name => "userName",
    :serial => "serial",
    :status => "status",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



51
52
53
54
55
56
57
58
59
 
# File 'iam/cfn_access_key_props.rb', line 51

def to_jsii
  result = {}
  result.merge!({
    "userName" => @user_name,
    "serial" => @serial,
    "status" => @status,
  })
  result.compact
end