class Distribution (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.CloudFront.Distribution`
Java	`software.amazon.awscdk.services.cloudfront.Distribution`
Python	`aws_cdk.aws_cloudfront.Distribution`
TypeScript (source)	`@aws-cdk/aws-cloudfront` » `Distribution`

Implements IConstruct, IConstruct, IDependable, IResource, IDistribution

A CloudFront distribution with associated origin(s) and caching behavior(s).

Example

// Adding an existing Lambda@Edge function created in a different stack
// to a CloudFront distribution.
declare const s3Bucket: s3.Bucket;
const functionVersion = lambda.Version.fromVersionArn(this, 'Version', 'arn:aws:lambda:us-east-1:123456789012:function:functionName:1');

new cloudfront.Distribution(this, 'distro', {
  defaultBehavior: {
    origin: new origins.S3Origin(s3Bucket),
    edgeLambdas: [
      {
        functionVersion,
        eventType: cloudfront.LambdaEdgeEventType.VIEWER_REQUEST,
      },
    ],
  },
});

Initializer

new Distribution(scope: Construct, id: string, props: DistributionProps)

Parameters

scope Construct
id string
props DistributionProps

Construct Props

Name	Type	Description
defaultBehavior	`BehaviorOptions`	The default behavior for the distribution.
additionalBehaviors?	`{ [string]:` `BehaviorOptions` `}`	Additional behaviors for the distribution, mapped by the pathPattern that specifies which requests to apply the behavior to.
certificate?	`ICertificate`	A certificate to associate with the distribution.
comment?	`string`	Any comments you want to include about the distribution.
defaultRootObject?	`string`	The object that you want CloudFront to request from your origin (for example, index.html) when a viewer requests the root URL for your distribution. If no default object is set, the request goes to the origin's root (e.g., example.com/).
domainNames?	`string[]`	Alternative domain names for this distribution.
enableIpv6?	`boolean`	Whether CloudFront will respond to IPv6 DNS requests with an IPv6 address.
enableLogging?	`boolean`	Enable access logging for the distribution.
enabled?	`boolean`	Enable or disable the distribution.
errorResponses?	`ErrorResponse[]`	How CloudFront should handle requests that are not successful (e.g., PageNotFound).
geoRestriction?	`GeoRestriction`	Controls the countries in which your content is distributed.
httpVersion?	`HttpVersion`	Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront.
logBucket?	`IBucket`	The Amazon S3 bucket to store the access logs in.
logFilePrefix?	`string`	An optional string that you want CloudFront to prefix to the access log filenames for this distribution.
logIncludesCookies?	`boolean`	Specifies whether you want CloudFront to include cookies in access logs.
minimumProtocolVersion?	`SecurityPolicyProtocol`	The minimum version of the SSL protocol that you want CloudFront to use for HTTPS connections.
priceClass?	`PriceClass`	The price class that corresponds with the maximum price that you want to pay for CloudFront service.
sslSupportMethod?	`SSLMethod`	The SSL method CloudFront will use for your distribution.
webAclId?	`string`	Unique identifier that specifies the AWS WAF web ACL to associate with this CloudFront distribution.

defaultBehavior

Type: BehaviorOptions

The default behavior for the distribution.

additionalBehaviors?

Type: { [string]: BehaviorOptions } (optional, default: no additional behaviors are added.)

Additional behaviors for the distribution, mapped by the pathPattern that specifies which requests to apply the behavior to.

certificate?

Type: ICertificate (optional, default: the CloudFront wildcard certificate (.cloudfront.net) will be used.)*

A certificate to associate with the distribution.

The certificate must be located in N. Virginia (us-east-1).

comment?

Type: string (optional, default: no comment)

Any comments you want to include about the distribution.

defaultRootObject?

Type: string (optional, default: no default root object)

The object that you want CloudFront to request from your origin (for example, index.html) when a viewer requests the root URL for your distribution. If no default object is set, the request goes to the origin's root (e.g., example.com/).

domainNames?

Type: string[] (optional, default: The distribution will only support the default generated name (e.g., d111111abcdef8.cloudfront.net))

Alternative domain names for this distribution.

If you want to use your own domain name, such as www.example.com, instead of the cloudfront.net domain name, you can add an alternate domain name to your distribution. If you attach a certificate to the distribution, you must add (at least one of) the domain names of the certificate to this list.

enableIpv6?

Type: boolean (optional, default: true)

Whether CloudFront will respond to IPv6 DNS requests with an IPv6 address.

If you specify false, CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.

enableLogging?

Type: boolean (optional, default: false, unless logBucket is specified.)

Enable access logging for the distribution.

enabled?

Type: boolean (optional, default: true)

Enable or disable the distribution.

errorResponses?

Type: ErrorResponse[] (optional, default: No custom error responses.)

How CloudFront should handle requests that are not successful (e.g., PageNotFound).

geoRestriction?

Type: GeoRestriction (optional, default: No geographic restrictions)

Controls the countries in which your content is distributed.

httpVersion?

Type: HttpVersion (optional, default: HttpVersion.HTTP2)

Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront.

For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support server name identification (SNI).

logBucket?

Type: IBucket (optional, default: A bucket is created if enableLogging is true)

The Amazon S3 bucket to store the access logs in.

logFilePrefix?

Type: string (optional, default: no prefix)

An optional string that you want CloudFront to prefix to the access log filenames for this distribution.

logIncludesCookies?

Type: boolean (optional, default: false)

Specifies whether you want CloudFront to include cookies in access logs.

minimumProtocolVersion?

Type: SecurityPolicyProtocol (optional, default: SecurityPolicyProtocol.TLS_V1_2_2021 if the ')

The minimum version of the SSL protocol that you want CloudFront to use for HTTPS connections.

CloudFront serves your objects only to browsers or devices that support at least the SSL version that you specify.

priceClass?

Type: PriceClass (optional, default: PriceClass.PRICE_CLASS_ALL)

The price class that corresponds with the maximum price that you want to pay for CloudFront service.

If you specify PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations. If you specify a price class other than PriceClass_All, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class.

sslSupportMethod?

Type: SSLMethod (optional, default: SSLMethod.SNI)

The SSL method CloudFront will use for your distribution.

Server Name Indication (SNI) - is an extension to the TLS computer networking protocol by which a client indicates which hostname it is attempting to connect to at the start of the handshaking process. This allows a server to present multiple certificates on the same IP address and TCP port number and hence allows multiple secure (HTTPS) websites (or any other service over TLS) to be served by the same IP address without requiring all those sites to use the same certificate.

CloudFront can use SNI to host multiple distributions on the same IP - which a large majority of clients will support.

If your clients cannot support SNI however - CloudFront can use dedicated IPs for your distribution - but there is a prorated monthly charge for using this feature. By default, we use SNI - but you can optionally enable dedicated IPs (VIP).

See the CloudFront SSL for more details about pricing : https://aws.amazon.com/cloudfront/custom-ssl-domains/

webAclId?

Type: string (optional, default: No AWS Web Application Firewall web access control list (web ACL).)

Unique identifier that specifies the AWS WAF web ACL to associate with this CloudFront distribution.

To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a.

Properties

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

distributionDomainName

Type: string

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

distributionId

Type: string

The distribution ID for this distribution.

domainName

Type: string

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

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: ConstructNode

The construct tree node associated with this construct.

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
addBehavior(pathPattern, origin, behaviorOptions?)	Adds a new behavior to this distribution for the given pathPattern.
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.
static fromDistributionAttributes(scope, id, attrs)	Creates a Distribution construct that represents an external (imported) distribution.

addBehavior(pathPattern, origin, behaviorOptions?)

public addBehavior(pathPattern: string, origin: IOrigin, behaviorOptions?: AddBehaviorOptions): void

Parameters

pathPattern string — the path pattern (e.g., 'images/*') that specifies which requests to apply the behavior to.
origin IOrigin — the origin to use for this behavior.
behaviorOptions AddBehaviorOptions — the options for the behavior at this path.

Adds a new behavior to this distribution for the given pathPattern.

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

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

static fromDistributionAttributes(scope, id, attrs)

public static fromDistributionAttributes(scope: Construct, id: string, attrs: DistributionAttributes): IDistribution

Parameters

scope Construct
id string
attrs DistributionAttributes

Returns

IDistribution

Creates a Distribution construct that represents an external (imported) distribution.