KeyGroup

class aws_cdk.aws_cloudfront.KeyGroup(scope, id, *, items, comment=None, key_group_name=None)

Bases: Resource

A Key Group configuration.

Resource:: AWS::CloudFront::KeyGroup
ExampleMetadata:: infused

Example:

# Validating signed URLs or signed cookies with Trusted Key Groups

# public key in PEM format
# public_key: str

pub_key = cloudfront.PublicKey(self, "MyPubKey",
    encoded_key=public_key
)

key_group = cloudfront.KeyGroup(self, "MyKeyGroup",
    items=[pub_key
    ]
)

cloudfront.Distribution(self, "Dist",
    default_behavior=cloudfront.BehaviorOptions(
        origin=origins.HttpOrigin("www.example.com"),
        trusted_key_groups=[key_group
        ]
    )
)

Parameters:

scope (Construct) –
id (str) –
items (Sequence[IPublicKey]) – A list of public keys to add to the key group.
comment (Optional[str]) – A comment to describe the key group. Default: - no comment
key_group_name (Optional[str]) – A name to identify the key group. Default: - generated from the id

Methods

apply_removal_policy(policy)

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

Parameters:

policy (RemovalPolicy) –

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

env

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.

key_group_id: The ID of the key group.

node: The construct tree node associated with this construct.

stack: The stack in which this resource is defined.

Static Methods

classmethod from_key_group_id(scope, id, key_group_id)

Imports a Key Group from its id.

Parameters:

scope (Construct) –
id (str) –
key_group_id (str) –

Return type:

IKeyGroup

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool