# CfnAccessKeyProps

Properties for defining a `CfnAccessKey`.

Extends: CfnAccessKeyProps
Used as props by: CfnAccessKey

- Source: Generated code

## Example

```ts
// 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`: number — 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`: string — The status of the access key.

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

- `userName`: string (required) — The name of the IAM user that the new key will belong to.

  This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-