Package software.amazon.awssdk.services.cloudfront.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AliasICPRecordal.Builder

Method Summary

Modifier and Type	Method	Description
static AliasICPRecordal.Builder	builder()
String	cname()	A domain name associated with a distribution.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
ICPRecordalStatus	icpRecordalStatus()	The Internet Content Provider (ICP) recordal status for a CNAME.
String	icpRecordalStatusAsString()	The Internet Content Provider (ICP) recordal status for a CNAME.
List<SdkField<?>>	sdkFields()
static Class<? extends AliasICPRecordal.Builder>	serializableBuilderClass()
AliasICPRecordal.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

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:

ICPRecordalStatus

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:

ICPRecordalStatus

toBuilder

public AliasICPRecordal.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AliasICPRecordal.Builder,AliasICPRecordal>

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)

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