aws-cdk-lib.aws_apigateway.IApiKey

interface IApiKey

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.IApiKey
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#IApiKey
Javasoftware.amazon.awscdk.services.apigateway.IApiKey
Pythonaws_cdk.aws_apigateway.IApiKey
TypeScript (source)aws-cdk-lib » aws_apigateway » IApiKey

Implemented by ApiKey, RateLimitedApiKey

Obtainable from ApiKey.fromApiKeyId(), RestApiBase.addApiKey(), StageBase.addApiKey()

API keys are alphanumeric string values that you distribute to app developer customers to grant access to your API.

Properties

NameTypeDescription
envResourceEnvironmentThe environment this resource belongs to.
keyArnstringThe API key ARN.
keyIdstringThe API key ID.
nodeNodeThe tree node.
stackStackThe stack in which this resource is defined.

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.


keyArn

Type: string

The API key ARN.


keyId

Type: string

The API key ID.


node

Type: Node

The tree node.


stack

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
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).