Package software.amazon.awscdk.services.cloudfront

Interface KeyGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

KeyGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:43.719Z")
@Stability(Stable)
public interface KeyGroupProps
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	KeyGroupProps.Builder	A builder for KeyGroupProps
static final class	KeyGroupProps.Jsii$Proxy	An implementation for KeyGroupProps

Method Summary

Modifier and Type	Method	Description
static KeyGroupProps.Builder	builder()
default String	getComment()	A comment to describe the key group.
List<IPublicKey>	getItems()	A list of public keys to add to the key group.
default String	getKeyGroupName()	A name to identify the key group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getItems

@Stability(Stable)
@NotNull
List<IPublicKey> getItems()

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

getComment

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

A comment to describe the key group.

Default: - no comment

getKeyGroupName

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

A name to identify the key group.

Default: - generated from the `id`

builder

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

Returns:

a KeyGroupProps.Builder of KeyGroupProps