Package software.amazon.awscdk.services.cloudfront

Interface PublicKeyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

PublicKeyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-02T15:58:22.549Z")
@Stability(Stable)
public interface PublicKeyProps
extends software.amazon.jsii.JsiiSerializable

Properties for creating a Public Key.

Example:

 // Validating signed URLs or signed cookies with Trusted Key Groups
 // public key in PEM format
 String publicKey;
 PublicKey pubKey = PublicKey.Builder.create(this, "MyPubKey")
         .encodedKey(publicKey)
         .build();
 KeyGroup keyGroup = KeyGroup.Builder.create(this, "MyKeyGroup")
         .items(List.of(pubKey))
         .build();
 Distribution.Builder.create(this, "Dist")
         .defaultBehavior(BehaviorOptions.builder()
                 .origin(new HttpOrigin("www.example.com"))
                 .trustedKeyGroups(List.of(keyGroup))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	PublicKeyProps.Builder	A builder for PublicKeyProps
static final class	PublicKeyProps.Jsii$Proxy	An implementation for PublicKeyProps

Method Summary

Modifier and Type	Method	Description
static PublicKeyProps.Builder	builder()
default String	getComment()	A comment to describe the public key.
String	getEncodedKey()	The public key that you can use with signed URLs and signed cookies, or with field-level encryption.
default String	getPublicKeyName()	A name to identify the public key.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEncodedKey

@Stability(Stable)
@NotNull
String getEncodedKey()

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

getComment

@Stability(Stable)
@Nullable
default String getComment()

A comment to describe the public key.

Default: - no comment

getPublicKeyName

@Stability(Stable)
@Nullable
default String getPublicKeyName()

A name to identify the public key.

Default: - generated from the `id`

builder

@Stability(Stable)
static PublicKeyProps.Builder builder()

Returns:

a PublicKeyProps.Builder of PublicKeyProps