software.amazon.awscdk.services.cloudfront

Class Distribution

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.cloudfront.Distribution

All Implemented Interfaces:

IConstruct, IDependable, IResource, IDistribution

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:24.234Z")
public class Distribution
extends Resource
implements 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.
 Bucket s3Bucket;
 IVersion functionVersion = Version.fromVersionArn(this, "Version", "arn:aws:lambda:us-east-1:123456789012:function:functionName:1");
 Distribution.Builder.create(this, "distro")
         .defaultBehavior(BehaviorOptions.builder()
                 .origin(new S3Origin(s3Bucket))
                 .edgeLambdas(List.of(EdgeLambda.builder()
                         .functionVersion(functionVersion)
                         .eventType(LambdaEdgeEventType.VIEWER_REQUEST)
                         .build()))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Distribution.Builder A fluent builder for Distribution.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cloudfront.IDistribution

IDistribution.Jsii$Default, IDistribution.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Distribution(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Distribution(software.amazon.jsii.JsiiObjectRef objRef)
	Distribution(software.constructs.Construct scope, java.lang.String id, DistributionProps props)

Method Summary

Modifier and Type	Method and Description
void	addBehavior(java.lang.String pathPattern, IOrigin origin) Adds a new behavior to this distribution for the given pathPattern.
void	addBehavior(java.lang.String pathPattern, IOrigin origin, AddBehaviorOptions behaviorOptions) Adds a new behavior to this distribution for the given pathPattern.
static IDistribution	fromDistributionAttributes(software.constructs.Construct scope, java.lang.String id, DistributionAttributes attrs) Creates a Distribution construct that represents an external (imported) distribution.
java.lang.String	getDistributionDomainName() The domain name of the Distribution, such as d111111abcdef8.cloudfront.net.
java.lang.String	getDistributionId() The distribution ID for this distribution.
java.lang.String	getDomainName() The domain name of the Distribution, such as d111111abcdef8.cloudfront.net.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

Distribution

protected Distribution(software.amazon.jsii.JsiiObjectRef objRef)

Distribution

protected Distribution(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Distribution

public Distribution(software.constructs.Construct scope,
                    java.lang.String id,
                    DistributionProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromDistributionAttributes

public static IDistribution fromDistributionAttributes(software.constructs.Construct scope,
                                                       java.lang.String id,
                                                       DistributionAttributes attrs)

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

addBehavior

public void addBehavior(java.lang.String pathPattern,
                        IOrigin origin,
                        AddBehaviorOptions behaviorOptions)

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

Parameters:

pathPattern - the path pattern (e.g., 'images/*') that specifies which requests to apply the behavior to. This parameter is required.

origin - the origin to use for this behavior. This parameter is required.

behaviorOptions - the options for the behavior at this path.

addBehavior

public void addBehavior(java.lang.String pathPattern,
                        IOrigin origin)

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

Parameters:

pathPattern - the path pattern (e.g., 'images/*') that specifies which requests to apply the behavior to. This parameter is required.

origin - the origin to use for this behavior. This parameter is required.

getDistributionDomainName

public java.lang.String getDistributionDomainName()

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

Specified by:

getDistributionDomainName in interface IDistribution

getDistributionId

public java.lang.String getDistributionId()

The distribution ID for this distribution.

Specified by:

getDistributionId in interface IDistribution

getDomainName

public java.lang.String getDomainName()

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

Specified by:

getDomainName in interface IDistribution