OriginAccessIdentity

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

Bases: 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
ExampleMetadata:: infused

Example:

my_bucket = s3.Bucket(self, "myBucket")
my_oai = cloudfront.OriginAccessIdentity(self, "myOAI",
    comment="My custom OAI"
)
s3_origin = origins.S3BucketOrigin.with_origin_access_identity(my_bucket,
    origin_access_identity=my_oai
)
cloudfront.Distribution(self, "myDist",
    default_behavior=cloudfront.BehaviorOptions(
        origin=s3_origin
    )
)

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

PROPERTY_INJECTION_ID = 'aws-cdk-lib.aws-cloudfront.OriginAccessIdentity'

cloud_front_origin_access_identity_ref: A reference to a CloudFrontOriginAccessIdentity resource.

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

env

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

grant_principal: Derived principal value for bucket access.

node: The tree node.

origin_access_identity_id

The Origin Access Identity Id (physical id) This was called originAccessIdentityName before.

Attribute:: true

origin_access_identity_name

(deprecated) The Origin Access Identity Id (physical id) It is misnamed and superseded by the correctly named originAccessIdentityId.

Deprecated:: use originAccessIdentityId instead
Stability:: deprecated
Attribute:: true

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

Static Methods

classmethod from_origin_access_identity_id(scope, id, origin_access_identity_id)

Creates a OriginAccessIdentity by providing the OriginAccessIdentityId.

Parameters:

scope (Construct)
id (str)
origin_access_identity_id (str)

Return type:

IOriginAccessIdentity

classmethod from_origin_access_identity_name(scope, id, origin_access_identity_name)

(deprecated) Creates a OriginAccessIdentity by providing the OriginAccessIdentityId.

It is misnamed and superseded by the correctly named fromOriginAccessIdentityId.

Parameters:

scope (Construct)
id (str)
origin_access_identity_name (str)

Deprecated:

use fromOriginAccessIdentityId

Stability:

deprecated

Return type:

IOriginAccessIdentity

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:: construct (IConstruct)
Return type:: bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:: construct (IConstruct)
Return type:: bool