software.amazon.awscdk.services.cloudfront

Class CloudFrontWebDistribution

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.cloudfront.CloudFrontWebDistribution

All Implemented Interfaces:

IConstruct, IDependable, IResource, IDistribution

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:46.568Z")
public class CloudFrontWebDistribution
extends Resource
implements IDistribution

Amazon CloudFront is a global content delivery network (CDN) service that securely delivers data, videos, applications, and APIs to your viewers with low latency and high transfer speeds.

CloudFront fronts user provided content and caches it at edge locations across the world.

Here's how you can use this construct:

 Bucket sourceBucket = new Bucket(this, "Bucket");
 CloudFrontWebDistribution distribution = CloudFrontWebDistribution.Builder.create(this, "MyDistribution")
         .originConfigs(List.of(SourceConfiguration.builder()
                 .s3OriginSource(S3OriginConfig.builder()
                         .s3BucketSource(sourceBucket)
                         .build())
                 .behaviors(List.of(Behavior.builder().isDefaultBehavior(true).build()))
                 .build()))
         .build();
 

This will create a CloudFront distribution that uses your S3Bucket as it's origin.

You can customize the distribution using additional properties from the CloudFrontWebDistributionProps interface.

Example:

 Bucket sourceBucket;
 ViewerCertificate viewerCertificate = ViewerCertificate.fromIamCertificate("MYIAMROLEIDENTIFIER", ViewerCertificateOptions.builder()
         .aliases(List.of("MYALIAS"))
         .build());
 CloudFrontWebDistribution.Builder.create(this, "MyCfWebDistribution")
         .originConfigs(List.of(SourceConfiguration.builder()
                 .s3OriginSource(S3OriginConfig.builder()
                         .s3BucketSource(sourceBucket)
                         .build())
                 .behaviors(List.of(Behavior.builder().isDefaultBehavior(true).build()))
                 .build()))
         .viewerCertificate(viewerCertificate)
         .build();
 

Nested Class Summary

Nested Classes

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

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	CloudFrontWebDistribution(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CloudFrontWebDistribution(software.amazon.jsii.JsiiObjectRef objRef)
	CloudFrontWebDistribution(software.constructs.Construct scope, java.lang.String id, CloudFrontWebDistributionProps props)

Method Summary

Modifier and Type	Method and Description
static IDistribution	fromDistributionAttributes(software.constructs.Construct scope, java.lang.String id, CloudFrontWebDistributionAttributes attrs) Creates a construct that represents an external (imported) distribution.
java.lang.String	getDistributionDomainName() The domain name created by CloudFront for this distribution.
java.lang.String	getDistributionId() The distribution ID for this distribution.
java.lang.String	getDomainName() Deprecated. - Use `distributionDomainName` instead.
IBucket	getLoggingBucket() The logging bucket for this CloudFront distribution.

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

CloudFrontWebDistribution

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

CloudFrontWebDistribution

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

CloudFrontWebDistribution

public CloudFrontWebDistribution(software.constructs.Construct scope,
                                 java.lang.String id,
                                 CloudFrontWebDistributionProps 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,
                                                       CloudFrontWebDistributionAttributes attrs)

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

getDistributionDomainName

public java.lang.String getDistributionDomainName()

The domain name created by CloudFront for this distribution.

If you are using aliases for your distribution, this is the domainName your DNS records should point to. (In Route53, you could create an ALIAS record to this value, for example.)

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

@Deprecated
public java.lang.String getDomainName()

Deprecated. - Use `distributionDomainName` instead.

(deprecated) The domain name created by CloudFront for this distribution.

If you are using aliases for your distribution, this is the domainName your DNS records should point to. (In Route53, you could create an ALIAS record to this value, for example.)

Specified by:

getDomainName in interface IDistribution

getLoggingBucket

public IBucket getLoggingBucket()

The logging bucket for this CloudFront distribution.

If logging is not enabled for this distribution - this property will be undefined.