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

Class CreateDomainAssociationRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.amplify.model.AmplifyRequest
software.amazon.awssdk.services.amplify.model.CreateDomainAssociationRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateDomainAssociationRequest.Builder,CreateDomainAssociationRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateDomainAssociationRequest extends AmplifyRequest implements ToCopyableBuilder<CreateDomainAssociationRequest.Builder,CreateDomainAssociationRequest>

The request structure for the create domain association request.

  • Method Details

    • appId

      public final String appId()

      The unique ID for an Amplify app.

      Returns:
      The unique ID for an Amplify app.

    • domainName

      public final String domainName()

      The domain name for the domain association.

      Returns:
      The domain name for the domain association.

    • enableAutoSubDomain

      public final Boolean enableAutoSubDomain()

      Enables the automated creation of subdomains for branches.

      Returns:
      Enables the automated creation of subdomains for branches.

    • hasSubDomainSettings

      public final boolean hasSubDomainSettings()
      For responses, this returns true if the service returned a value for the SubDomainSettings 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.

    • subDomainSettings

      public final List<SubDomainSetting> subDomainSettings()

      The setting for the subdomain.

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

      Returns:
      The setting for the subdomain.

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

    • certificateSettings

      public final CertificateSettings certificateSettings()

      The type of SSL/TLS certificate to use for your custom domain. If you don't specify a certificate type, Amplify uses the default certificate that it provisions and manages for you.

      Returns:
      The type of SSL/TLS certificate to use for your custom domain. If you don't specify a certificate type, Amplify uses the default certificate that it provisions and manages for you.

    • toBuilder

      public CreateDomainAssociationRequest.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<CreateDomainAssociationRequest.Builder,CreateDomainAssociationRequest>
      Specified by:
      toBuilder in class AmplifyRequest
      Returns:
      a builder for type T

    • builder

      public static CreateDomainAssociationRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateDomainAssociationRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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