Package software.amazon.awssdk.services.amplify.model

Class DomainAssociation

java.lang.Object

software.amazon.awssdk.services.amplify.model.DomainAssociation

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DomainAssociation.Builder,DomainAssociation>

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

Describes the association between a custom domain and an Amplify app.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DomainAssociation.Builder

Method Summary

Modifier and Type	Method	Description
List<String>	autoSubDomainCreationPatterns()	Sets branch patterns for automatic subdomain creation.
String	autoSubDomainIAMRole()	The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
static DomainAssociation.Builder	builder()
Certificate	certificate()	Describes the SSL/TLS certificate for the domain association.
String	certificateVerificationDNSRecord()	The DNS record for certificate verification.
String	domainAssociationArn()	The Amazon Resource Name (ARN) for the domain association.
String	domainName()	The name of the domain.
DomainStatus	domainStatus()	The current status of the domain association.
String	domainStatusAsString()	The current status of the domain association.
Boolean	enableAutoSubDomain()	Enables the automated creation of subdomains for branches.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAutoSubDomainCreationPatterns()	For responses, this returns true if the service returned a value for the AutoSubDomainCreationPatterns property.
int	hashCode()
boolean	hasSubDomains()	For responses, this returns true if the service returned a value for the SubDomains property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DomainAssociation.Builder>	serializableBuilderClass()
String	statusReason()	Additional information that describes why the domain association is in the current state.
List<SubDomain>	subDomains()	The subdomains for the domain association.
DomainAssociation.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
UpdateStatus	updateStatus()	The status of the domain update operation that is currently in progress.
String	updateStatusAsString()	The status of the domain update operation that is currently in progress.

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

domainAssociationArn

public final String domainAssociationArn()

The Amazon Resource Name (ARN) for the domain association.

Returns:

The Amazon Resource Name (ARN) for the domain association.

domainName

public final String domainName()

The name of the domain.

Returns:

The name of the domain.

enableAutoSubDomain

public final Boolean enableAutoSubDomain()

Enables the automated creation of subdomains for branches.

Returns:

Enables the automated creation of subdomains for branches.

hasAutoSubDomainCreationPatterns

public final boolean hasAutoSubDomainCreationPatterns()

For responses, this returns true if the service returned a value for the AutoSubDomainCreationPatterns 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.

autoSubDomainCreationPatterns

public final List<String> autoSubDomainCreationPatterns()

Sets branch patterns for automatic subdomain creation.

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 hasAutoSubDomainCreationPatterns() method.

Returns:

Sets branch patterns for automatic subdomain creation.

autoSubDomainIAMRole

public final String autoSubDomainIAMRole()

The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

Returns:

The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

domainStatus

public final DomainStatus domainStatus()

The current status of the domain association.

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

Returns:

The current status of the domain association.

See Also:

DomainStatus

domainStatusAsString

public final String domainStatusAsString()

The current status of the domain association.

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

Returns:

The current status of the domain association.

See Also:

DomainStatus

updateStatus

public final UpdateStatus updateStatus()

The status of the domain update operation that is currently in progress. The following list describes the valid update states.

REQUESTING_CERTIFICATE

The certificate is in the process of being updated.

PENDING_VERIFICATION

Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.

IMPORTING_CUSTOM_CERTIFICATE

Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.

PENDING_DEPLOYMENT

Indicates that the subdomain or certificate changes are being propagated.

AWAITING_APP_CNAME

Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see Setting up custom domains in the Amplify Hosting User Guide.

UPDATE_COMPLETE

The certificate has been associated with a domain.

UPDATE_FAILED

The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.

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

Returns:

The status of the domain update operation that is currently in progress. The following list describes the valid update states.

REQUESTING_CERTIFICATE

The certificate is in the process of being updated.

PENDING_VERIFICATION

Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.

IMPORTING_CUSTOM_CERTIFICATE

Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.

PENDING_DEPLOYMENT

Indicates that the subdomain or certificate changes are being propagated.

AWAITING_APP_CNAME

Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see Setting up custom domains in the Amplify Hosting User Guide.

UPDATE_COMPLETE

The certificate has been associated with a domain.

UPDATE_FAILED

The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.

See Also:

UpdateStatus

updateStatusAsString

public final String updateStatusAsString()

The status of the domain update operation that is currently in progress. The following list describes the valid update states.

REQUESTING_CERTIFICATE

The certificate is in the process of being updated.

PENDING_VERIFICATION

Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.

IMPORTING_CUSTOM_CERTIFICATE

Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.

PENDING_DEPLOYMENT

Indicates that the subdomain or certificate changes are being propagated.

AWAITING_APP_CNAME

Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see Setting up custom domains in the Amplify Hosting User Guide.

UPDATE_COMPLETE

The certificate has been associated with a domain.

UPDATE_FAILED

The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.

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

Returns:

The status of the domain update operation that is currently in progress. The following list describes the valid update states.

REQUESTING_CERTIFICATE

The certificate is in the process of being updated.

PENDING_VERIFICATION

Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.

IMPORTING_CUSTOM_CERTIFICATE

Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.

PENDING_DEPLOYMENT

Indicates that the subdomain or certificate changes are being propagated.

AWAITING_APP_CNAME

Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see Setting up custom domains in the Amplify Hosting User Guide.

UPDATE_COMPLETE

The certificate has been associated with a domain.

UPDATE_FAILED

The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.

See Also:

UpdateStatus

statusReason

public final String statusReason()

Additional information that describes why the domain association is in the current state.

Returns:

Additional information that describes why the domain association is in the current state.

certificateVerificationDNSRecord

public final String certificateVerificationDNSRecord()

The DNS record for certificate verification.

Returns:

The DNS record for certificate verification.

hasSubDomains

public final boolean hasSubDomains()

For responses, this returns true if the service returned a value for the SubDomains 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.

subDomains

public final List<SubDomain> subDomains()

The subdomains for the domain association.

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 hasSubDomains() method.

Returns:

The subdomains for the domain association.

certificate

public final Certificate certificate()

Describes the SSL/TLS certificate for the domain association. This can be your own custom certificate or the default certificate that Amplify provisions for you.

If you are updating your domain to use a different certificate, certificate points to the new certificate that is being created instead of the current active certificate. Otherwise, certificate points to the current active certificate.

Returns:

Describes the SSL/TLS certificate for the domain association. This can be your own custom certificate or the default certificate that Amplify provisions for you.

If you are updating your domain to use a different certificate, certificate points to the new certificate that is being created instead of the current active certificate. Otherwise, certificate points to the current active certificate.

toBuilder

public DomainAssociation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DomainAssociation.Builder,DomainAssociation>

builder

public static DomainAssociation.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo