Class DistributionConfig

java.lang.Object
software.amazon.awssdk.services.cloudfront.model.DistributionConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DistributionConfig.Builder,DistributionConfig>
@Generated("software.amazon.awssdk:codegen") public final class DistributionConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DistributionConfig.Builder,DistributionConfig>

A distribution configuration.

See Also:

  • Method Details

    • 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()

      This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

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

      Returns:

      This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

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

    • defaultRootObject

      public final String defaultRootObject()

      When a viewer requests the root URL for your distribution, the default root object is the object that you want CloudFront to request from your origin. For example, if your root URL is https://www.example.com, you can specify CloudFront to return the index.html file as the default root object. You can specify a default root object so that viewers see a specific file or object, instead of another object in your distribution (for example, https://www.example.com/product-description.html). A default root object avoids exposing the contents of your distribution.

      You can specify the object name or a path to the object name (for example, index.html or exampleFolderName/index.html). Your string can't begin with a forward slash (/). Only specify the object name or the path to the object.

      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 Specify a default root object in the Amazon CloudFront Developer Guide.

      Returns:
      When a viewer requests the root URL for your distribution, the default root object is the object that you want CloudFront to request from your origin. For example, if your root URL is https://www.example.com, you can specify CloudFront to return the index.html file as the default root object. You can specify a default root object so that viewers see a specific file or object, instead of another object in your distribution (for example, https://www.example.com/product-description.html). A default root object avoids exposing the contents of your distribution.

      You can specify the object name or a path to the object name (for example, index.html or exampleFolderName/index.html). Your string can't begin with a forward slash (/ ). Only specify the object name or the path to the object.

      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 Specify 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()

      This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

      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:

      This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

      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:

    • priceClassAsString

      public final String priceClassAsString()

      This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

      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:

      This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

      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:

    • 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()

      Multi-tenant distributions only support WAF V2 web ACLs.

      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/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 . To specify a web ACL created using WAF Classic, use the ACL ID, for example a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

      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:

      Multi-tenant distributions only support WAF V2 web ACLs.

      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/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 . To specify a web ACL created using WAF Classic, use the ACL ID, for example a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

      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 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 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:

    • httpVersionAsString

      public final String httpVersionAsString()

      (Optional) Specify the 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 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:

    • isIPV6Enabled

      public final Boolean isIPV6Enabled()

      To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup.

      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:

      To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup.

      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()

      This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

      The identifier of a continuous deployment policy. For more information, see CreateContinuousDeploymentPolicy.

      Returns:

      This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

      The identifier of a continuous deployment policy. For more information, see CreateContinuousDeploymentPolicy.

    • staging

      public final Boolean staging()

      This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

      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:

      This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

      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.

    • anycastIpListId

      public final String anycastIpListId()

      To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup.

      ID of the Anycast static IP list that is associated with the distribution.

      Returns:

      To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup.

      ID of the Anycast static IP list that is associated with the distribution.

    • tenantConfig

      public final TenantConfig tenantConfig()

      This field only supports multi-tenant distributions. You can't specify this field for standard distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

      A distribution tenant configuration.

      Returns:

      This field only supports multi-tenant distributions. You can't specify this field for standard distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

      A distribution tenant configuration.

    • connectionMode

      public final ConnectionMode connectionMode()

      This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants (tenant-only).

      If the service returns an enum value that is not available in the current SDK version, connectionMode will return ConnectionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectionModeAsString().

      Returns:
      This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants (tenant-only).
      See Also:

    • connectionModeAsString

      public final String connectionModeAsString()

      This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants (tenant-only).

      If the service returns an enum value that is not available in the current SDK version, connectionMode will return ConnectionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectionModeAsString().

      Returns:
      This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants (tenant-only).
      See Also:

    • toBuilder

      public DistributionConfig.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DistributionConfig.Builder,DistributionConfig>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.