CfnAccessKeyProps

class aws_cdk.aws_iam.CfnAccessKeyProps(*, user_name, serial=None, status=None)

Bases: object

Properties for defining a CfnAccessKey.

Parameters
  • user_name (str) – 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: _+=,.@-

  • serial (Union[int, float, None]) – 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.

  • status (Optional[str]) – The status of the access key. Active means that the key is valid for API calls, while Inactive means it is not.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_iam as iam

cfn_access_key_props = iam.CfnAccessKeyProps(
    user_name="userName",

    # the properties below are optional
    serial=123,
    status="status"
)

Attributes

serial

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html#cfn-iam-accesskey-serial

Return type

Union[int, float, None]

status

The status of the access key.

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html#cfn-iam-accesskey-status

Return type

Optional[str]

user_name

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: _+=,.@-

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html#cfn-iam-accesskey-username

Return type

str