interface IAccessKey

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

Implemented by AccessKey

Represents an IAM Access Key.

Properties

Name	Type	Description
accessKeyId	`string`	The Access Key ID.
env	`ResourceEnvironment`	The environment this resource belongs to.
node	`Node`	The tree node.
secretAccessKey	`SecretValue`	The Secret Access Key.
stack	`Stack`	The stack in which this resource is defined.

accessKeyId

Type: string

The Access Key ID.

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

node

Type: Node

The tree node.

secretAccessKey

Type: SecretValue

The Secret Access Key.

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).