software.amazon.awscdk.services.cloudfront

Interface CfnDistribution.DistributionConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDistribution.DistributionConfigProperty.Jsii$Proxy

Enclosing class:

CfnDistribution

@Stability(value=Stable)
public static interface CfnDistribution.DistributionConfigProperty
extends software.amazon.jsii.JsiiSerializable

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.*;
 DistributionConfigProperty distributionConfigProperty = 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDistribution.DistributionConfigProperty.Builder A builder for CfnDistribution.DistributionConfigProperty
static class	CfnDistribution.DistributionConfigProperty.Jsii$Proxy An implementation for CfnDistribution.DistributionConfigProperty

Method Summary

Modifier and Type	Method and Description
static CfnDistribution.DistributionConfigProperty.Builder	builder()
default List<String>	getAliases() `CfnDistribution.DistributionConfigProperty.Aliases`.
default Object	getCacheBehaviors() `CfnDistribution.DistributionConfigProperty.CacheBehaviors`.
default List<String>	getCnamEs() `CfnDistribution.DistributionConfigProperty.CNAMEs`.
default String	getComment() `CfnDistribution.DistributionConfigProperty.Comment`.
default Object	getCustomErrorResponses() `CfnDistribution.DistributionConfigProperty.CustomErrorResponses`.
default Object	getCustomOrigin() `CfnDistribution.DistributionConfigProperty.CustomOrigin`.
default Object	getDefaultCacheBehavior() `CfnDistribution.DistributionConfigProperty.DefaultCacheBehavior`.
default String	getDefaultRootObject() `CfnDistribution.DistributionConfigProperty.DefaultRootObject`.
Object	getEnabled() `CfnDistribution.DistributionConfigProperty.Enabled`.
default String	getHttpVersion() `CfnDistribution.DistributionConfigProperty.HttpVersion`.
default Object	getIpv6Enabled() `CfnDistribution.DistributionConfigProperty.IPV6Enabled`.
default Object	getLogging() `CfnDistribution.DistributionConfigProperty.Logging`.
default Object	getOriginGroups() `CfnDistribution.DistributionConfigProperty.OriginGroups`.
default Object	getOrigins() `CfnDistribution.DistributionConfigProperty.Origins`.
default String	getPriceClass() `CfnDistribution.DistributionConfigProperty.PriceClass`.
default Object	getRestrictions() `CfnDistribution.DistributionConfigProperty.Restrictions`.
default Object	getS3Origin() `CfnDistribution.DistributionConfigProperty.S3Origin`.
default Object	getViewerCertificate() `CfnDistribution.DistributionConfigProperty.ViewerCertificate`.
default String	getWebAclId() `CfnDistribution.DistributionConfigProperty.WebACLId`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAliases

@Stability(value=Stable)
 @Nullable
default List<String> getAliases()

`CfnDistribution.DistributionConfigProperty.Aliases`.

getCacheBehaviors

@Stability(value=Stable)
 @Nullable
default Object getCacheBehaviors()

`CfnDistribution.DistributionConfigProperty.CacheBehaviors`.

getCnamEs

@Stability(value=Stable)
 @Nullable
default List<String> getCnamEs()

`CfnDistribution.DistributionConfigProperty.CNAMEs`.

getComment

@Stability(value=Stable)
 @Nullable
default String getComment()

`CfnDistribution.DistributionConfigProperty.Comment`.

getCustomErrorResponses

@Stability(value=Stable)
 @Nullable
default Object getCustomErrorResponses()

`CfnDistribution.DistributionConfigProperty.CustomErrorResponses`.

getCustomOrigin

@Stability(value=Stable)
 @Nullable
default Object getCustomOrigin()

`CfnDistribution.DistributionConfigProperty.CustomOrigin`.

getDefaultCacheBehavior

@Stability(value=Stable)
 @Nullable
default Object getDefaultCacheBehavior()

`CfnDistribution.DistributionConfigProperty.DefaultCacheBehavior`.

getDefaultRootObject

@Stability(value=Stable)
 @Nullable
default String getDefaultRootObject()

`CfnDistribution.DistributionConfigProperty.DefaultRootObject`.

getEnabled

@Stability(value=Stable)
 @NotNull
Object getEnabled()

`CfnDistribution.DistributionConfigProperty.Enabled`.

getHttpVersion

@Stability(value=Stable)
 @Nullable
default String getHttpVersion()

`CfnDistribution.DistributionConfigProperty.HttpVersion`.

getIpv6Enabled

@Stability(value=Stable)
 @Nullable
default Object getIpv6Enabled()

`CfnDistribution.DistributionConfigProperty.IPV6Enabled`.

getLogging

@Stability(value=Stable)
 @Nullable
default Object getLogging()

`CfnDistribution.DistributionConfigProperty.Logging`.

getOriginGroups

@Stability(value=Stable)
 @Nullable
default Object getOriginGroups()

`CfnDistribution.DistributionConfigProperty.OriginGroups`.

getOrigins

@Stability(value=Stable)
 @Nullable
default Object getOrigins()

`CfnDistribution.DistributionConfigProperty.Origins`.

getPriceClass

@Stability(value=Stable)
 @Nullable
default String getPriceClass()

`CfnDistribution.DistributionConfigProperty.PriceClass`.

getRestrictions

@Stability(value=Stable)
 @Nullable
default Object getRestrictions()

`CfnDistribution.DistributionConfigProperty.Restrictions`.

getS3Origin

@Stability(value=Stable)
 @Nullable
default Object getS3Origin()

`CfnDistribution.DistributionConfigProperty.S3Origin`.

getViewerCertificate

@Stability(value=Stable)
 @Nullable
default Object getViewerCertificate()

`CfnDistribution.DistributionConfigProperty.ViewerCertificate`.

getWebAclId

@Stability(value=Stable)
 @Nullable
default String getWebAclId()

`CfnDistribution.DistributionConfigProperty.WebACLId`.

builder

@Stability(value=Stable)
static CfnDistribution.DistributionConfigProperty.Builder builder()

Returns:

a CfnDistribution.DistributionConfigProperty.Builder of CfnDistribution.DistributionConfigProperty