software.amazon.awscdk.services.cloudfront

Class CfnDistribution

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.cloudfront.CfnDistribution

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:05.309Z")
 @Stability(value=Stable)
public class CfnDistribution
extends CfnResource
implements IInspectable

A CloudFormation `AWS::CloudFront::Distribution`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudfront.*;
 CfnDistribution cfnDistribution = CfnDistribution.Builder.create(this, "MyCfnDistribution")
         .distributionConfig(DistributionConfigProperty.builder()
                 .enabled(false)
                 // the properties below are optional
                 .aliases(List.of("aliases"))
                 .cacheBehaviors(List.of(CacheBehaviorProperty.builder()
                         .pathPattern("pathPattern")
                         .targetOriginId("targetOriginId")
                         .viewerProtocolPolicy("viewerProtocolPolicy")
                         // the properties below are optional
                         .allowedMethods(List.of("allowedMethods"))
                         .cachedMethods(List.of("cachedMethods"))
                         .cachePolicyId("cachePolicyId")
                         .compress(false)
                         .defaultTtl(123)
                         .fieldLevelEncryptionId("fieldLevelEncryptionId")
                         .forwardedValues(ForwardedValuesProperty.builder()
                                 .queryString(false)
                                 // the properties below are optional
                                 .cookies(CookiesProperty.builder()
                                         .forward("forward")
                                         // the properties below are optional
                                         .whitelistedNames(List.of("whitelistedNames"))
                                         .build())
                                 .headers(List.of("headers"))
                                 .queryStringCacheKeys(List.of("queryStringCacheKeys"))
                                 .build())
                         .functionAssociations(List.of(FunctionAssociationProperty.builder()
                                 .eventType("eventType")
                                 .functionArn("functionArn")
                                 .build()))
                         .lambdaFunctionAssociations(List.of(LambdaFunctionAssociationProperty.builder()
                                 .eventType("eventType")
                                 .includeBody(false)
                                 .lambdaFunctionArn("lambdaFunctionArn")
                                 .build()))
                         .maxTtl(123)
                         .minTtl(123)
                         .originRequestPolicyId("originRequestPolicyId")
                         .realtimeLogConfigArn("realtimeLogConfigArn")
                         .responseHeadersPolicyId("responseHeadersPolicyId")
                         .smoothStreaming(false)
                         .trustedKeyGroups(List.of("trustedKeyGroups"))
                         .trustedSigners(List.of("trustedSigners"))
                         .build()))
                 .cnamEs(List.of("cnamEs"))
                 .comment("comment")
                 .customErrorResponses(List.of(CustomErrorResponseProperty.builder()
                         .errorCode(123)
                         // the properties below are optional
                         .errorCachingMinTtl(123)
                         .responseCode(123)
                         .responsePagePath("responsePagePath")
                         .build()))
                 .customOrigin(LegacyCustomOriginProperty.builder()
                         .dnsName("dnsName")
                         .originProtocolPolicy("originProtocolPolicy")
                         .originSslProtocols(List.of("originSslProtocols"))
                         // the properties below are optional
                         .httpPort(123)
                         .httpsPort(123)
                         .build())
                 .defaultCacheBehavior(DefaultCacheBehaviorProperty.builder()
                         .targetOriginId("targetOriginId")
                         .viewerProtocolPolicy("viewerProtocolPolicy")
                         // the properties below are optional
                         .allowedMethods(List.of("allowedMethods"))
                         .cachedMethods(List.of("cachedMethods"))
                         .cachePolicyId("cachePolicyId")
                         .compress(false)
                         .defaultTtl(123)
                         .fieldLevelEncryptionId("fieldLevelEncryptionId")
                         .forwardedValues(ForwardedValuesProperty.builder()
                                 .queryString(false)
                                 // the properties below are optional
                                 .cookies(CookiesProperty.builder()
                                         .forward("forward")
                                         // the properties below are optional
                                         .whitelistedNames(List.of("whitelistedNames"))
                                         .build())
                                 .headers(List.of("headers"))
                                 .queryStringCacheKeys(List.of("queryStringCacheKeys"))
                                 .build())
                         .functionAssociations(List.of(FunctionAssociationProperty.builder()
                                 .eventType("eventType")
                                 .functionArn("functionArn")
                                 .build()))
                         .lambdaFunctionAssociations(List.of(LambdaFunctionAssociationProperty.builder()
                                 .eventType("eventType")
                                 .includeBody(false)
                                 .lambdaFunctionArn("lambdaFunctionArn")
                                 .build()))
                         .maxTtl(123)
                         .minTtl(123)
                         .originRequestPolicyId("originRequestPolicyId")
                         .realtimeLogConfigArn("realtimeLogConfigArn")
                         .responseHeadersPolicyId("responseHeadersPolicyId")
                         .smoothStreaming(false)
                         .trustedKeyGroups(List.of("trustedKeyGroups"))
                         .trustedSigners(List.of("trustedSigners"))
                         .build())
                 .defaultRootObject("defaultRootObject")
                 .httpVersion("httpVersion")
                 .ipv6Enabled(false)
                 .logging(LoggingProperty.builder()
                         .bucket("bucket")
                         // the properties below are optional
                         .includeCookies(false)
                         .prefix("prefix")
                         .build())
                 .originGroups(OriginGroupsProperty.builder()
                         .quantity(123)
                         // the properties below are optional
                         .items(List.of(OriginGroupProperty.builder()
                                 .failoverCriteria(OriginGroupFailoverCriteriaProperty.builder()
                                         .statusCodes(StatusCodesProperty.builder()
                                                 .items(List.of(123))
                                                 .quantity(123)
                                                 .build())
                                         .build())
                                 .id("id")
                                 .members(OriginGroupMembersProperty.builder()
                                         .items(List.of(OriginGroupMemberProperty.builder()
                                                 .originId("originId")
                                                 .build()))
                                         .quantity(123)
                                         .build())
                                 .build()))
                         .build())
                 .origins(List.of(OriginProperty.builder()
                         .domainName("domainName")
                         .id("id")
                         // the properties below are optional
                         .connectionAttempts(123)
                         .connectionTimeout(123)
                         .customOriginConfig(CustomOriginConfigProperty.builder()
                                 .originProtocolPolicy("originProtocolPolicy")
                                 // the properties below are optional
                                 .httpPort(123)
                                 .httpsPort(123)
                                 .originKeepaliveTimeout(123)
                                 .originReadTimeout(123)
                                 .originSslProtocols(List.of("originSslProtocols"))
                                 .build())
                         .originCustomHeaders(List.of(OriginCustomHeaderProperty.builder()
                                 .headerName("headerName")
                                 .headerValue("headerValue")
                                 .build()))
                         .originPath("originPath")
                         .originShield(OriginShieldProperty.builder()
                                 .enabled(false)
                                 .originShieldRegion("originShieldRegion")
                                 .build())
                         .s3OriginConfig(S3OriginConfigProperty.builder()
                                 .originAccessIdentity("originAccessIdentity")
                                 .build())
                         .build()))
                 .priceClass("priceClass")
                 .restrictions(RestrictionsProperty.builder()
                         .geoRestriction(GeoRestrictionProperty.builder()
                                 .restrictionType("restrictionType")
                                 // the properties below are optional
                                 .locations(List.of("locations"))
                                 .build())
                         .build())
                 .s3Origin(LegacyS3OriginProperty.builder()
                         .dnsName("dnsName")
                         // the properties below are optional
                         .originAccessIdentity("originAccessIdentity")
                         .build())
                 .viewerCertificate(ViewerCertificateProperty.builder()
                         .acmCertificateArn("acmCertificateArn")
                         .cloudFrontDefaultCertificate(false)
                         .iamCertificateId("iamCertificateId")
                         .minimumProtocolVersion("minimumProtocolVersion")
                         .sslSupportMethod("sslSupportMethod")
                         .build())
                 .webAclId("webAclId")
                 .build())
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDistribution.Builder A fluent builder for CfnDistribution.
static interface	CfnDistribution.CacheBehaviorProperty Example:
static interface	CfnDistribution.CookiesProperty Example:
static interface	CfnDistribution.CustomErrorResponseProperty Example:
static interface	CfnDistribution.CustomOriginConfigProperty Example:
static interface	CfnDistribution.DefaultCacheBehaviorProperty Example:
static interface	CfnDistribution.DistributionConfigProperty Example:
static interface	CfnDistribution.ForwardedValuesProperty Example:
static interface	CfnDistribution.FunctionAssociationProperty Example:
static interface	CfnDistribution.GeoRestrictionProperty Example:
static interface	CfnDistribution.LambdaFunctionAssociationProperty Example:
static interface	CfnDistribution.LegacyCustomOriginProperty Example:
static interface	CfnDistribution.LegacyS3OriginProperty Example:
static interface	CfnDistribution.LoggingProperty Example:
static interface	CfnDistribution.OriginCustomHeaderProperty Example:
static interface	CfnDistribution.OriginGroupFailoverCriteriaProperty Example:
static interface	CfnDistribution.OriginGroupMemberProperty Example:
static interface	CfnDistribution.OriginGroupMembersProperty Example:
static interface	CfnDistribution.OriginGroupProperty Example:
static interface	CfnDistribution.OriginGroupsProperty Example:
static interface	CfnDistribution.OriginProperty Example:
static interface	CfnDistribution.OriginShieldProperty Example:
static interface	CfnDistribution.RestrictionsProperty Example:
static interface	CfnDistribution.S3OriginConfigProperty Example:
static interface	CfnDistribution.StatusCodesProperty Example:
static interface	CfnDistribution.ViewerCertificateProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDistribution(software.constructs.Construct scope, String id, CfnDistributionProps props) Create a new `AWS::CloudFront::Distribution`.
protected	CfnDistribution(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDistribution(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrDomainName()
String	getAttrId()
protected Map<String,Object>	getCfnProperties()
Object	getDistributionConfig() `AWS::CloudFront::Distribution.DistributionConfig`.
TagManager	getTags() `AWS::CloudFront::Distribution.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDistributionConfig(CfnDistribution.DistributionConfigProperty value) `AWS::CloudFront::Distribution.DistributionConfig`.
void	setDistributionConfig(IResolvable value) `AWS::CloudFront::Distribution.DistributionConfig`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDistribution

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

CfnDistribution

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

CfnDistribution

@Stability(value=Stable)
public CfnDistribution(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                CfnDistributionProps props)

Create a new `AWS::CloudFront::Distribution`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrDomainName

@Stability(value=Stable)
 @NotNull
public String getAttrDomainName()

getAttrId

@Stability(value=Stable)
 @NotNull
public String getAttrId()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDistributionConfig

@Stability(value=Stable)
 @NotNull
public Object getDistributionConfig()

`AWS::CloudFront::Distribution.DistributionConfig`.

setDistributionConfig

@Stability(value=Stable)
public void setDistributionConfig(@NotNull
                                                           CfnDistribution.DistributionConfigProperty value)

`AWS::CloudFront::Distribution.DistributionConfig`.

setDistributionConfig

@Stability(value=Stable)
public void setDistributionConfig(@NotNull
                                                           IResolvable value)

`AWS::CloudFront::Distribution.DistributionConfig`.

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::CloudFront::Distribution.Tags`.