OriginAccessIdentity

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

Bases: aws_cdk.core.Resource

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

Stability

experimental

Resource

AWS::CloudFront::CloudFrontOriginAccessIdentity

Parameters
  • scope (Construct) –

  • id (str) –

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

Stability

experimental

Methods

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

cloud_front_origin_access_identity_s3_canonical_user_id

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

Stability

experimental

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

(experimental) Derived principal value for bucket access.

Stability

experimental

Return type

IPrincipal

node

The construct tree node associated with this construct.

Return type

ConstructNode

origin_access_identity_name

(experimental) The Origin Access Identity Name (physical id).

Stability

experimental

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)

(experimental) Creates a OriginAccessIdentity by providing the OriginAccessIdentityName.

Parameters
  • scope (Construct) –

  • id (str) –

  • origin_access_identity_name (str) –

Stability

experimental

Return type

IOriginAccessIdentity

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool