aws-cdk-lib.aws_iam.CfnAccessKeyProps

CfnAccessKeyProps Struct

Properties for defining a CfnAccessKey.

CfnAccessKeyProps

used as props by

• CfnAccessKey

Source

Generated code

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iam as iam } from 'aws-cdk-lib';
const cfnAccessKeyProps: iam.CfnAccessKeyProps = {
  userName: 'userName',

  // the properties below are optional
  serial: 123,
  status: 'status',
};

Properties

serial?optionalnumberserial?optionalint | floatserial?optionalNumberSerial?optionaldoubleSerial?optional*float64#

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?optionalstringstatus?optionalstrstatus?optionalStringStatus?optionalstringStatus?optional*string#

The status of the access key.

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

userNamestringuser_namestruserNameStringUserNamestringUserName*stringrequired#

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

notes

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