All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnDistribution.DistributionConfigProperty.Jsii$Proxy

Enclosing class:: CfnDistribution

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

A distribution configuration.

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()
         .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())
         .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")
         .continuousDeploymentPolicyId("continuousDeploymentPolicyId")
         .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())
         .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())
                 .originAccessControlId("originAccessControlId")
                 .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())
         .staging(false)
         .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

Description

static final class

CfnDistribution.DistributionConfigProperty.Builder

A builder for CfnDistribution.DistributionConfigProperty

static final class

CfnDistribution.DistributionConfigProperty.Jsii$Proxy

An implementation for CfnDistribution.DistributionConfigProperty
Method Summary

Modifier and Type

Method

Description

static CfnDistribution.DistributionConfigProperty.Builder

builder()

default List<String>

getAliases()

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

default Object

getCacheBehaviors()

A complex type that contains zero or more CacheBehavior elements.

default List<String>

getCnamEs()

CfnDistribution.DistributionConfigProperty.CNAMEs.

default String

getComment()

A comment to describe the distribution.

default String

getContinuousDeploymentPolicyId()

The identifier of a continuous deployment policy.

default Object

getCustomErrorResponses()

A complex type that controls the following:.

default Object

getCustomOrigin()

CfnDistribution.DistributionConfigProperty.CustomOrigin.

Object

getDefaultCacheBehavior()

A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.

default String

getDefaultRootObject()

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 ( https://www.example.com ) instead of an object in your distribution ( https://www.example.com/product-description.html ).

Object

getEnabled()

From this field, you can enable or disable the selected distribution.

default String

getHttpVersion()

(Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CloudFront .

default Object

getIpv6Enabled()

If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true .

default Object

getLogging()

A complex type that controls whether access logs are written for the distribution.

default Object

getOriginGroups()

A complex type that contains information about origin groups for this distribution.

default Object

getOrigins()

A complex type that contains information about origins for this distribution.

default String

getPriceClass()

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

default Object

getRestrictions()

A complex type that identifies ways in which you want to restrict distribution of your content.

default Object

getS3Origin()

CfnDistribution.DistributionConfigProperty.S3Origin.

default Object

getStaging()

A Boolean that indicates whether this is a staging distribution.

default Object

getViewerCertificate()

A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.

default String

getWebAclId()

A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getDefaultCacheBehavior
  
  @Stability(Stable) @NotNull Object getDefaultCacheBehavior()
  
  A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.
  You must create exactly one default cache behavior.
- getEnabled
  
  @Stability(Stable) @NotNull Object getEnabled()
  
  From this field, you can enable or disable the selected distribution.
- getAliases
  
  @Stability(Stable) @Nullable default List<String> getAliases()
  
  A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
- getCacheBehaviors
  
  @Stability(Stable) @Nullable default Object getCacheBehaviors()
  
  A complex type that contains zero or more CacheBehavior elements.
- getCnamEs
  
  @Stability(Stable) @Nullable default List<String> getCnamEs()
  
  CfnDistribution.DistributionConfigProperty.CNAMEs.
- getComment
  
  @Stability(Stable) @Nullable default String getComment()
  
  A comment to describe the distribution.
  The comment cannot be longer than 128 characters.
- getContinuousDeploymentPolicyId
  
  @Stability(Stable) @Nullable default String getContinuousDeploymentPolicyId()
  
  The identifier of a continuous deployment policy.
  For more information, see CreateContinuousDeploymentPolicy .
- getCustomErrorResponses
  
  @Stability(Stable) @Nullable default Object getCustomErrorResponses()
  A complex type that controls the following:.
  
  Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.
  
  How long CloudFront caches HTTP status codes in the 4xx and 5xx range.
  
  For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide .
- getCustomOrigin
  
  @Stability(Stable) @Nullable default Object getCustomOrigin()
  
  CfnDistribution.DistributionConfigProperty.CustomOrigin.
- getDefaultRootObject
  
  @Stability(Stable) @Nullable default String getDefaultRootObject()
  
  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 ( https://www.example.com ) instead of an object in your distribution ( https://www.example.com/product-description.html ). Specifying a default root object avoids exposing the contents of your distribution.
  Specify only the object name, for example, index.html . Don't add a / before the object name.
  If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element.
  To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element.
  To replace the default root object, update the distribution configuration and specify the new object.
  For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide .
- getHttpVersion
  
  @Stability(Stable) @Nullable default String getHttpVersion()
  
  (Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CloudFront .
  The default value for new distributions is http1.1 .
  For viewers and CloudFront to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI).
  For viewers and CloudFront to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CloudFront supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see Connection Migration at RFC 9000. For more information about supported TLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront .
- getIpv6Enabled
  
  @Stability(Stable) @Nullable default Object getIpv6Enabled()
  If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true .
  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.
  In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide .
  If you're using an Amazon Route 53 AWS Integration alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:
  
  You enable IPv6 for the distribution
  
  You're using alternate domain names in the URLs for your objects
  
  For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Amazon Route 53 AWS Integration Developer Guide .
  If you created a CNAME resource record set, either with Amazon Route 53 AWS Integration or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.
- getLogging
  
  @Stability(Stable) @Nullable default Object getLogging()
  
  A complex type that controls whether access logs are written for the distribution.
  For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide .
- getOriginGroups
  
  @Stability(Stable) @Nullable default Object getOriginGroups()
  
  A complex type that contains information about origin groups for this distribution.
- getOrigins
  
  @Stability(Stable) @Nullable default Object getOrigins()
  
  A complex type that contains information about origins for this distribution.
- getPriceClass
  
  @Stability(Stable) @Nullable default String getPriceClass()
  
  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. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.
  For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide . For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing .
- getRestrictions
  
  @Stability(Stable) @Nullable default Object getRestrictions()
  
  A complex type that identifies ways in which you want to restrict distribution of your content.
- getS3Origin
  
  @Stability(Stable) @Nullable default Object getS3Origin()
  
  CfnDistribution.DistributionConfigProperty.S3Origin.
- getStaging
  
  @Stability(Stable) @Nullable default Object getStaging()
  
  A Boolean that indicates whether this is a staging distribution.
  When this value is true , this is a staging distribution. When this value is false , this is not a staging distribution.
- getViewerCertificate
  
  @Stability(Stable) @Nullable default Object getViewerCertificate()
  
  A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.
- getWebAclId
  
  @Stability(Stable) @Nullable default String getWebAclId()
  
  A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this 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 .
  AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about AWS WAF , see the AWS WAF Developer Guide .
- builder
  
  @Stability(Stable) static CfnDistribution.DistributionConfigProperty.Builder builder()
  
  Returns:
  
  a CfnDistribution.DistributionConfigProperty.Builder of CfnDistribution.DistributionConfigProperty

Interface CfnDistribution.DistributionConfigProperty

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getDefaultCacheBehavior

getEnabled

getAliases

getCacheBehaviors

getCnamEs

getComment

getContinuousDeploymentPolicyId

getCustomErrorResponses

getCustomOrigin

getDefaultRootObject

getHttpVersion

getIpv6Enabled

getLogging

getOriginGroups

getOrigins

getPriceClass

getRestrictions

getS3Origin

getStaging

getViewerCertificate

getWebAclId

builder