interface CfnAccessKeyProps

Language	Type name
.NET	`Amazon.CDK.AWS.IAM.CfnAccessKeyProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsiam#CfnAccessKeyProps`
Java	`software.amazon.awscdk.services.iam.CfnAccessKeyProps`
Python	`aws_cdk.aws_iam.CfnAccessKeyProps`
TypeScript	`aws-cdk-lib` » `aws_iam` » `CfnAccessKeyProps`

Properties for defining a CfnAccessKey.

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

Name	Type	Description
userName	`string`	The name of the IAM user that the new key will belong to.
serial?	`number`	This value is specific to CloudFormation and can only be incremented .
status?	`string`	The status of the access key.

userName

Type: string

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?

Type: number (optional)

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?

Type: string (optional)

The status of the access key.

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