interface IOriginAccessIdentity

Language	Type name
.NET	Amazon.CDK.AWS.CloudFront.IOriginAccessIdentity
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscloudfront#IOriginAccessIdentity
Java	software.amazon.awscdk.services.cloudfront.IOriginAccessIdentity
Python	aws_cdk.aws_cloudfront.IOriginAccessIdentity
TypeScript (source)	aws-cdk-lib » aws_cloudfront » IOriginAccessIdentity

Implemented by OriginAccessIdentity

Obtainable from OriginAccessIdentity.fromOriginAccessIdentityId(), OriginAccessIdentity.fromOriginAccessIdentityName()

Interface for CloudFront OriginAccessIdentity.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
grantPrincipal	IPrincipal	The principal to grant permissions to.
node	Node	The tree node.
originAccessIdentityId	string	The Origin Access Identity Id (physical id) This was called originAccessIdentityName before.
originAccessIdentityName⚠️	string	The Origin Access Identity Id (physical id) It is misnamed and superseded by the correctly named originAccessIdentityId.
stack	Stack	The stack in which this resource is defined.

---

env

Type: ResourceEnvironment

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.

---

grantPrincipal

Type: IPrincipal

The principal to grant permissions to.

---

node

Type: Node

The tree node.

---

originAccessIdentityId

Type: string

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

---

originAccessIdentityName⚠️

⚠️ Deprecated: use originAccessIdentityId instead

Type: string

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

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

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