interface IDistribution

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

Implemented by CloudFrontWebDistribution, Distribution

Obtainable from CloudFrontWebDistribution.fromDistributionAttributes(), Distribution.fromDistributionAttributes()

Interface for CloudFront distributions.

Properties

Name	Type	Description
distributionArn	string	The distribution ARN for this distribution.
distributionDomainName	string	The domain name of the Distribution, such as d111111abcdef8.cloudfront.net.
distributionId	string	The distribution ID for this distribution.
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.

---

distributionArn

Type: string

The distribution ARN for this distribution.

---

distributionDomainName

Type: string

The domain name of the Distribution, such as d111111abcdef8.cloudfront.net.

---

distributionId

Type: string

The distribution ID for this distribution.

---

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.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
grant(identity, ...actions)	Adds an IAM policy statement associated with this distribution to an IAM principal's policy.
grantCreateInvalidation(identity)	Grant to create invalidations for this bucket to an IAM principal (Role/Group/User).

---

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

---

grant(identity, ...actions)

public grant(identity: IGrantable, ...actions: string[]): Grant

Parameters

• identity IGrantable — The principal.
• actions string — The set of actions to allow (i.e. "cloudfront:ListInvalidations").

Returns

• Grant

Adds an IAM policy statement associated with this distribution to an IAM principal's policy.

---

grantCreateInvalidation(identity)

public grantCreateInvalidation(identity: IGrantable): Grant

Parameters

• identity IGrantable — The principal.

Returns

• Grant

Grant to create invalidations for this bucket to an IAM principal (Role/Group/User).