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(value="software.amazon.awssdk:codegen")
public final class CreateDomainAssociationRequest
extends AmplifyRequest
implements ToCopyableBuilder<CreateDomainAssociationRequest.Builder,CreateDomainAssociationRequest>

The request structure for the create domain association request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateDomainAssociationRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	appId() The unique ID for an Amplify app.
List<String>	autoSubDomainCreationPatterns() Sets the 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 CreateDomainAssociationRequest.Builder	builder()
String	domainName() The domain name for 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	hasSubDomainSettings() For responses, this returns true if the service returned a value for the SubDomainSettings property.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDomainAssociationRequest.Builder>	serializableBuilderClass()
List<SubDomainSetting>	subDomainSettings() The setting for the subdomain.
CreateDomainAssociationRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

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.

toBuilder

public CreateDomainAssociationRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDomainAssociationRequest.Builder,CreateDomainAssociationRequest>

Specified by:

toBuilder in class AmplifyRequest

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)

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo