class KeyGroup (construct)

Language	Type name
.NET	Amazon.CDK.AWS.CloudFront.KeyGroup
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscloudfront#KeyGroup
Java	software.amazon.awscdk.services.cloudfront.KeyGroup
Python	aws_cdk.aws_cloudfront.KeyGroup
TypeScript (source)	aws-cdk-lib » aws_cloudfront » KeyGroup

Implements IConstruct, IDependable, IResource, IEnvironmentAware, IKeyGroup, IKeyGroupRef

A Key Group configuration.

Example

// Validating signed URLs or signed cookies with Trusted Key Groups

// public key in PEM format
declare const publicKey: string;
const pubKey = new cloudfront.PublicKey(this, 'MyPubKey', {
  encodedKey: publicKey,
});

const keyGroup = new cloudfront.KeyGroup(this, 'MyKeyGroup', {
  items: [
    pubKey,
  ],
});

new cloudfront.Distribution(this, 'Dist', {
  defaultBehavior: {
    origin: new origins.HttpOrigin('www.example.com'),
    trustedKeyGroups: [
      keyGroup,
    ],
  },
});

Initializer

new KeyGroup(scope: Construct, id: string, props: KeyGroupProps)

Parameters

• scope Construct
• id string
• props KeyGroupProps

Construct Props

Name	Type	Description
items	IPublicKeyRef[]	A list of public keys to add to the key group.
comment?	string	A comment to describe the key group.
keyGroupName?	string	A name to identify the key group.

---

items

Type: IPublicKeyRef[]

A list of public keys to add to the key group.

---

comment?

Type: string (optional, default: no comment)

A comment to describe the key group.

---

keyGroupName?

Type: string (optional, default: generated from the id)

A name to identify the key group.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
keyGroupId	string	The ID of the key group.
keyGroupRef	KeyGroupReference	A reference to a KeyGroup resource.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.
static PROPERTY_INJECTION_ID	string	Uniquely identifies this class.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

keyGroupId

Type: string

The ID of the key group.

---

keyGroupRef

Type: KeyGroupReference

A reference to a KeyGroup resource.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

---

static PROPERTY_INJECTION_ID

Type: string

Uniquely identifies this class.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.
static fromKeyGroupId(scope, id, keyGroupId)	Imports a Key Group from its id.

---

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

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromKeyGroupId(scope, id, keyGroupId)

public static fromKeyGroupId(scope: Construct, id: string, keyGroupId: string): IKeyGroup

Parameters

• scope Construct
• id string
• keyGroupId string

Returns

• IKeyGroup

Imports a Key Group from its id.