Class Distribution

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

A distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery.

See Also:

  • Method Details

    • id

      public final String id()

      The distribution's identifier. For example: E1U5RQF7T870K0.

      Returns:
      The distribution's identifier. For example: E1U5RQF7T870K0.

    • arn

      public final String arn()

      The distribution's Amazon Resource Name (ARN).

      Returns:
      The distribution's Amazon Resource Name (ARN).

    • status

      public final String status()

      The distribution's status. When the status is Deployed, the distribution's information is fully propagated to all CloudFront edge locations.

      Returns:
      The distribution's status. When the status is Deployed, the distribution's information is fully propagated to all CloudFront edge locations.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The date and time when the distribution was last modified.

      Returns:
      The date and time when the distribution was last modified.

    • inProgressInvalidationBatches

      public final Integer inProgressInvalidationBatches()

      The number of invalidation batches currently in progress.

      Returns:
      The number of invalidation batches currently in progress.

    • domainName

      public final String domainName()

      The distribution's CloudFront domain name. For example: d111111abcdef8.cloudfront.net.

      Returns:
      The distribution's CloudFront domain name. For example: d111111abcdef8.cloudfront.net.

    • activeTrustedSigners

      public final ActiveTrustedSigners activeTrustedSigners()

      We recommend using TrustedKeyGroups instead of TrustedSigners.

      This field contains a list of Amazon Web Services account IDs and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs or signed cookies.

      Returns:

      We recommend using TrustedKeyGroups instead of TrustedSigners.

      This field contains a list of Amazon Web Services account IDs and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs or signed cookies.

    • activeTrustedKeyGroups

      public final ActiveTrustedKeyGroups activeTrustedKeyGroups()

      This field contains a list of key groups and the public keys in each key group that CloudFront can use to verify the signatures of signed URLs or signed cookies.

      Returns:
      This field contains a list of key groups and the public keys in each key group that CloudFront can use to verify the signatures of signed URLs or signed cookies.

    • distributionConfig

      public final DistributionConfig distributionConfig()

      The distribution's configuration.

      Returns:
      The distribution's configuration.

    • hasAliasICPRecordals

      public final boolean hasAliasICPRecordals()
      For responses, this returns true if the service returned a value for the AliasICPRecordals property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • aliasICPRecordals

      public final List<AliasICPRecordal> aliasICPRecordals()

      Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions.

      For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAliasICPRecordals() method.

      Returns:
      Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions.

      For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China.

    • toBuilder

      public Distribution.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<Distribution.Builder,Distribution>
      Returns:
      a builder for type T

    • builder

      public static Distribution.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Distribution.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.