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 a domain association that associates a custom domain with an Amplify app.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DomainAssociation.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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()`
`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.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DomainAssociation.Builder>`	`serializableBuilderClass()`
`String`	`statusReason()`	The reason for the current status of the domain association.
`List<SubDomain>`	`subDomains()`	The subdomains for the domain association.
`DomainAssociation.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
  - 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
  - statusReason
```
public final String statusReason()
```
    The reason for the current status of the domain association.
    
    Returns:
    
    The reason for the current status of the domain association.
  - 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.
  - 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

Class DomainAssociation

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

domainAssociationArn

domainName

enableAutoSubDomain

hasAutoSubDomainCreationPatterns

autoSubDomainCreationPatterns

autoSubDomainIAMRole

domainStatus

domainStatusAsString

statusReason

certificateVerificationDNSRecord

hasSubDomains

subDomains

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields