Class DomainAssociation
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DomainAssociation.Builder,
DomainAssociation>
Describes the association between a custom domain and an Amplify app.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionSets branch patterns for automatic subdomain creation.final String
The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.static DomainAssociation.Builder
builder()
final Certificate
Describes the SSL/TLS certificate for the domain association.final String
The DNS record for certificate verification.final String
The Amazon Resource Name (ARN) for the domain association.final String
The name of the domain.final DomainStatus
The current status of the domain association.final String
The current status of the domain association.final Boolean
Enables the automated creation of subdomains for branches.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AutoSubDomainCreationPatterns property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SubDomains property.static Class
<? extends DomainAssociation.Builder> final String
Additional information that describes why the domain association is in the current state.The subdomains for the domain association.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final UpdateStatus
The status of the domain update operation that is currently in progress.final String
The status of the domain update operation that is currently in progress.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
domainAssociationArn
The Amazon Resource Name (ARN) for the domain association.
- Returns:
- The Amazon Resource Name (ARN) for the domain association.
-
domainName
The name of the domain.
- Returns:
- The name of the domain.
-
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 theisEmpty()
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
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
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
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 returnDomainStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdomainStatusAsString()
.- Returns:
- The current status of the domain association.
- See Also:
-
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 returnDomainStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdomainStatusAsString()
.- Returns:
- The current status of the domain association.
- See Also:
-
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 returnUpdateStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromupdateStatusAsString()
.- 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:
-
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 returnUpdateStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromupdateStatusAsString()
.- 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:
-
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
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 theisEmpty()
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
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
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
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 interfaceToCopyableBuilder<DomainAssociation.Builder,
DomainAssociation> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-