PublicKey

class aws_cdk.aws_cloudfront.PublicKey(scope, id, *, encoded_key, comment=None, public_key_name=None)

Bases: aws_cdk.core.Resource

A Public Key Configuration.

Resource

AWS::CloudFront::PublicKey

Parameters
  • scope (Construct) –

  • id (str) –

  • encoded_key (str) – 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.

  • comment (Optional[str]) – A comment to describe the public key. Default: - no comment

  • public_key_name (Optional[str]) – A name to identify the public key. 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.DELETE), 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.

Return type

ResourceEnvironment

node

The construct tree node associated with this construct.

Return type

ConstructNode

public_key_id

The ID of the key group.

Return type

str

stack

The stack in which this resource is defined.

Return type

Stack

Static Methods

classmethod from_public_key_id(scope, id, public_key_id)

Imports a Public Key from its id.

Parameters
  • scope (Construct) –

  • id (str) –

  • public_key_id (str) –

Return type

IPublicKey

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