DistributionConfig (AWS Java SDK :: Services :: Amazon CloudFront 2.20.149 API)

java.lang.Object
- software.amazon.awssdk.services.cloudfront.model.DistributionConfig

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<DistributionConfig.Builder,DistributionConfig>

@Generated(value="software.amazon.awssdk:codegen")
public final class DistributionConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DistributionConfig.Builder,DistributionConfig>

A distribution configuration.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DistributionConfig.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DistributionConfig.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Aliases`	`aliases()` A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
`static DistributionConfig.Builder`	`builder()`
`CacheBehaviors`	`cacheBehaviors()` A complex type that contains zero or more `CacheBehavior` elements.
`String`	`callerReference()` A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
`String`	`comment()` A comment to describe the distribution.
`String`	`continuousDeploymentPolicyId()` The identifier of a continuous deployment policy.
`CustomErrorResponses`	`customErrorResponses()` A complex type that controls the following:
`DefaultCacheBehavior`	`defaultCacheBehavior()` 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.
`String`	`defaultRootObject()` 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`).
`Boolean`	`enabled()` From this field, you can enable or disable the selected distribution.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`HttpVersion`	`httpVersion()` (Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CloudFront.
`String`	`httpVersionAsString()` (Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CloudFront.
`Boolean`	`isIPV6Enabled()` If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify `true`.
`LoggingConfig`	`logging()` A complex type that controls whether access logs are written for the distribution.
`OriginGroups`	`originGroups()` A complex type that contains information about origin groups for this distribution.
`Origins`	`origins()` A complex type that contains information about origins for this distribution.
`PriceClass`	`priceClass()` The price class that corresponds with the maximum price that you want to pay for CloudFront service.
`String`	`priceClassAsString()` The price class that corresponds with the maximum price that you want to pay for CloudFront service.
`Restrictions`	`restrictions()` A complex type that identifies ways in which you want to restrict distribution of your content.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DistributionConfig.Builder>`	`serializableBuilderClass()`
`Boolean`	`staging()` A Boolean that indicates whether this is a staging distribution.
`DistributionConfig.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`ViewerCertificate`	`viewerCertificate()` A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.
`String`	`webACLId()` A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - callerReference
```
public final String callerReference()
```
    A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
    
    If the value of CallerReference is new (regardless of the content of the DistributionConfig object), CloudFront creates a new distribution.
    
    If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.
    
    Returns:
    
    A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
    
    If the value of CallerReference is new (regardless of the content of the DistributionConfig object), CloudFront creates a new distribution.
    
    If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.
  - aliases
```
public final Aliases aliases()
```
    A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
    
    Returns:
    
    A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
  - defaultRootObject
```
public final String defaultRootObject()
```
    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.
    
    Returns:
    
    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.
  - origins
```
public final Origins origins()
```
    A complex type that contains information about origins for this distribution.
    
    Returns:
    
    A complex type that contains information about origins for this distribution.
  - originGroups
```
public final OriginGroups originGroups()
```
    A complex type that contains information about origin groups for this distribution.
    
    Returns:
    
    A complex type that contains information about origin groups for this distribution.
  - defaultCacheBehavior
```
public final DefaultCacheBehavior defaultCacheBehavior()
```
    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.
    
    Returns:
    
    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.
  - cacheBehaviors
```
public final CacheBehaviors cacheBehaviors()
```
    A complex type that contains zero or more CacheBehavior elements.
    
    Returns:
    
    A complex type that contains zero or more CacheBehavior elements.
  - customErrorResponses
```
public final CustomErrorResponses customErrorResponses()
```
    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.
    Returns:
    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.
  - comment
```
public final String comment()
```
    A comment to describe the distribution. The comment cannot be longer than 128 characters.
    
    Returns:
    
    A comment to describe the distribution. The comment cannot be longer than 128 characters.
  - logging
```
public final LoggingConfig logging()
```
    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.
    
    Returns:
    
    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.
  - priceClass
```
public final PriceClass priceClass()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, priceClass will return PriceClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from priceClassAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    PriceClass
  - priceClassAsString
```
public final String priceClassAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, priceClass will return PriceClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from priceClassAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    PriceClass
  - enabled
```
public final Boolean enabled()
```
    From this field, you can enable or disable the selected distribution.
    
    Returns:
    
    From this field, you can enable or disable the selected distribution.
  - viewerCertificate
```
public final ViewerCertificate viewerCertificate()
```
    A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.
    
    Returns:
    
    A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.
  - restrictions
```
public final Restrictions restrictions()
```
    A complex type that identifies ways in which you want to restrict distribution of your content.
    
    Returns:
    
    A complex type that identifies ways in which you want to restrict distribution of your content.
  - webACLId
```
public final String webACLId()
```
    A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of 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 WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a.
    
    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 WAF, see the WAF Developer Guide.
    
    Returns:
    
    A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of 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 WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a.
    
    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 WAF, see the WAF Developer Guide.
  - httpVersion
```
public final HttpVersion httpVersion()
```
    (Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.
    
    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.
    
    If the service returns an enum value that is not available in the current SDK version, httpVersion will return HttpVersion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from httpVersionAsString().
    
    Returns:
    
    (Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.
    
    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.
    
    See Also:
    
    HttpVersion
  - httpVersionAsString
```
public final String httpVersionAsString()
```
    (Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.
    
    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.
    
    If the service returns an enum value that is not available in the current SDK version, httpVersion will return HttpVersion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from httpVersionAsString().
    
    Returns:
    
    (Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.
    
    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.
    
    See Also:
    
    HttpVersion
  - isIPV6Enabled
```
public final Boolean isIPV6Enabled()
```
    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 Route 53 Amazon Web Services 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 Route 53 Amazon Web Services Integration Developer Guide.
    
    If you created a CNAME resource record set, either with Route 53 Amazon Web Services 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.
    Returns:
    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 Route 53 Amazon Web Services 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 Route 53 Amazon Web Services Integration Developer Guide.
    
    If you created a CNAME resource record set, either with Route 53 Amazon Web Services 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.
  - continuousDeploymentPolicyId
```
public final String continuousDeploymentPolicyId()
```
    The identifier of a continuous deployment policy. For more information, see CreateContinuousDeploymentPolicy.
    
    Returns:
    
    The identifier of a continuous deployment policy. For more information, see CreateContinuousDeploymentPolicy.
  - staging
```
public final Boolean staging()
```
    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.
    
    Returns:
    
    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.
  - toBuilder
```
public DistributionConfig.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DistributionConfig.Builder,DistributionConfig>
  - builder
```
public static DistributionConfig.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DistributionConfig.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DistributionConfig

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

callerReference

aliases

defaultRootObject

origins

originGroups

defaultCacheBehavior

cacheBehaviors

customErrorResponses

comment

logging

priceClass

priceClassAsString

enabled

viewerCertificate

restrictions

webACLId

httpVersion

httpVersionAsString

isIPV6Enabled

continuousDeploymentPolicyId

staging

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields