aws-cdk-lib.aws_cloudfront.IKeyGroup

interface IKeyGroup

LanguageType name
.NETAmazon.CDK.AWS.CloudFront.IKeyGroup
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscloudfront#IKeyGroup
Javasoftware.amazon.awscdk.services.cloudfront.IKeyGroup
Pythonaws_cdk.aws_cloudfront.IKeyGroup
TypeScript (source)aws-cdk-lib » aws_cloudfront » IKeyGroup

Implemented by KeyGroup

Obtainable from KeyGroup.fromKeyGroupId()

Represents a Key Group.

Properties

NameTypeDescription
envResourceEnvironmentThe environment this resource belongs to.
keyGroupIdstringThe ID of the key group.
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.


keyGroupId

Type: string

The ID of the key group.


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