OriginAccessIdentity

class aws_cdk.aws_cloudfront.OriginAccessIdentity(scope, id, *, comment=None)

Bases: aws_cdk.core.Resource

An origin access identity is a special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or just some of your Amazon S3 content.

Resource

AWS::CloudFront::CloudFrontOriginAccessIdentity

Parameters

  • scope (Construct) –

  • id (str) –

  • comment (Optional[str]) – Any comments you want to include about the origin access identity. Default: “Allows CloudFront to reach the bucket”

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

cloud_front_origin_access_identity_s3_canonical_user_id

The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3.

Attribute

true

Return type

str

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

grant_principal

Derived principal value for bucket access.

Return type

IPrincipal

node

The construct tree node associated with this construct.

Return type

ConstructNode

origin_access_identity_name

The Origin Access Identity Name (physical id).

Attribute

true

Return type

str

stack

The stack in which this resource is defined.

Return type

Stack

Static Methods

classmethod from_origin_access_identity_name(scope, id, origin_access_identity_name)

Creates a OriginAccessIdentity by providing the OriginAccessIdentityName.

Parameters

  • scope (Construct) –

  • id (str) –

  • origin_access_identity_name (str) –

Return type

IOriginAccessIdentity

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