class PublicKey (construct)

Language	Type name
.NET	Amazon.CDK.AWS.CloudFront.PublicKey
Java	software.amazon.awscdk.services.cloudfront.PublicKey
Python	aws_cdk.aws_cloudfront.PublicKey
TypeScript (source)	@aws-cdk/aws-cloudfront » PublicKey

Implements IConstruct, IConstruct, IDependable, IResource, IPublicKey

A Public Key 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 PublicKey(scope: Construct, id: string, props: PublicKeyProps)

Parameters

• scope Construct
• id string
• props PublicKeyProps

Construct Props

Name	Type	Description
encodedKey	string	The public key that you can use with signed URLs and signed cookies, or with field-level encryption.
comment?	string	A comment to describe the public key.
publicKeyName?	string	A name to identify the public key.

---

encodedKey

Type: string

The public key that you can use with signed URLs and signed cookies, or with field-level encryption.

The encodedKey parameter must include -----BEGIN PUBLIC KEY----- and -----END PUBLIC KEY----- lines.

See also: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html

---

comment?

Type: string (optional, default: no comment)

A comment to describe the public key.

---

publicKeyName?

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

A name to identify the public key.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
node	ConstructNode	The construct tree node associated with this construct.
publicKeyId	string	The ID of the key group.
stack	Stack	The 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.

---

node

Type: ConstructNode

The construct tree node associated with this construct.

---

publicKeyId

Type: string

The ID of the key group.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.
static fromPublicKeyId(scope, id, publicKeyId)	Imports a Public Key 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 fromPublicKeyId(scope, id, publicKeyId)

public static fromPublicKeyId(scope: Construct, id: string, publicKeyId: string): IPublicKey

Parameters

• scope Construct
• id string
• publicKeyId string

Returns

• IPublicKey

Imports a Public Key from its id.