AWS CDK Reference

Appearance

v2.274.0

PublicKeyProps Struct ​

Properties for creating a Public Key.

Source
aws-cloudfront/lib/public-key.ts

Example ​

ts
// Create a key group to use with CloudFront signed URLs and signed cookies.
new cloudfront.KeyGroup(this, 'MyKeyGroup', {
  items: [
    new cloudfront.PublicKey(this, 'MyPublicKey', {
      encodedKey: '...', // contents of public_key.pem file
      // comment: 'Key is expiring on ...',
    }),
  ],
  // comment: 'Key group containing public keys ...',
});

Properties ​

commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string#
A comment to describe the public key.

Default: no comment

encodedKeystringencoded_keystrencodedKeyStringEncodedKeystringEncodedKey*stringrequired#
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.

publicKeyNameoptionalstringpublic_key_nameoptionalstrpublicKeyNameoptionalStringPublicKeyNameoptionalstringPublicKeyNameoptional*string#
A name to identify the public key.

Default: generated from the id