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

See Also:

  • Method Details

    • 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:

    • 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:

    • 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()
      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<DomainAssociation.Builder,DomainAssociation>
      Returns:
      a builder for type T

    • 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)
      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.