Class AliasICPRecordal

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

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. The status is returned in the CloudFront response; you can't configure it yourself.

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

See Also:

  • Method Details

    • cname

      public final String cname()

      A domain name associated with a distribution.

      Returns:
      A domain name associated with a distribution.

    • icpRecordalStatus

      public final ICPRecordalStatus icpRecordalStatus()

      The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to APPROVED for all CNAMEs (aliases) in regions outside of China.

      The status values returned are the following:

      • APPROVED indicates that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can be associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as APPROVED, that is, valid to use with China region, a CNAME must have one ICP recordal number associated with it.

      • SUSPENDED indicates that the associated CNAME does not have a valid ICP recordal number.

      • PENDING indicates that CloudFront can't determine the ICP recordal status of the CNAME associated with the distribution because there was an error in trying to determine the status. You can try again to see if the error is resolved in which case CloudFront returns an APPROVED or SUSPENDED status.

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

      Returns:
      The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to APPROVED for all CNAMEs (aliases) in regions outside of China.

      The status values returned are the following:

      • APPROVED indicates that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can be associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as APPROVED, that is, valid to use with China region, a CNAME must have one ICP recordal number associated with it.

      • SUSPENDED indicates that the associated CNAME does not have a valid ICP recordal number.

      • PENDING indicates that CloudFront can't determine the ICP recordal status of the CNAME associated with the distribution because there was an error in trying to determine the status. You can try again to see if the error is resolved in which case CloudFront returns an APPROVED or SUSPENDED status.

      See Also:

    • icpRecordalStatusAsString

      public final String icpRecordalStatusAsString()

      The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to APPROVED for all CNAMEs (aliases) in regions outside of China.

      The status values returned are the following:

      • APPROVED indicates that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can be associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as APPROVED, that is, valid to use with China region, a CNAME must have one ICP recordal number associated with it.

      • SUSPENDED indicates that the associated CNAME does not have a valid ICP recordal number.

      • PENDING indicates that CloudFront can't determine the ICP recordal status of the CNAME associated with the distribution because there was an error in trying to determine the status. You can try again to see if the error is resolved in which case CloudFront returns an APPROVED or SUSPENDED status.

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

      Returns:
      The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to APPROVED for all CNAMEs (aliases) in regions outside of China.

      The status values returned are the following:

      • APPROVED indicates that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can be associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as APPROVED, that is, valid to use with China region, a CNAME must have one ICP recordal number associated with it.

      • SUSPENDED indicates that the associated CNAME does not have a valid ICP recordal number.

      • PENDING indicates that CloudFront can't determine the ICP recordal status of the CNAME associated with the distribution because there was an error in trying to determine the status. You can try again to see if the error is resolved in which case CloudFront returns an APPROVED or SUSPENDED status.

      See Also:

    • toBuilder

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

    • builder

      public static AliasICPRecordal.Builder builder()

    • serializableBuilderClass

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