IApiKey

class aws_cdk.aws_apigateway.IApiKey(*args, **kwargs)

Bases: IResource, Protocol

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

Methods

apply_removal_policy(policy)

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

Parameters:

policy (RemovalPolicy)

Return type:

None

Attributes

env

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.

key_arn

The API key ARN.

key_id

The API key ID.

Attribute:

true

node

The construct tree node for this construct.

stack

The stack in which this resource is defined.