Package software.amazon.awssdk.services.apprunner.model

Class CustomDomain

java.lang.Object

software.amazon.awssdk.services.apprunner.model.CustomDomain

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CustomDomain.Builder,CustomDomain>

@Generated("software.amazon.awssdk:codegen")
public final class CustomDomain
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CustomDomain.Builder,CustomDomain>

Describes a custom domain that's associated with an App Runner service.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CustomDomain.Builder

Method Summary

Modifier and Type	Method	Description
static CustomDomain.Builder	builder()
List<CertificateValidationRecord>	certificateValidationRecords()	A list of certificate CNAME records that's used for this domain name.
String	domainName()	An associated custom domain endpoint.
Boolean	enableWWWSubdomain()	When true, the subdomain www.DomainName is associated with the App Runner service in addition to the base domain.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCertificateValidationRecords()	For responses, this returns true if the service returned a value for the CertificateValidationRecords property.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CustomDomain.Builder>	serializableBuilderClass()
CustomDomainAssociationStatus	status()	The current state of the domain name association.
String	statusAsString()	The current state of the domain name association.
CustomDomain.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

domainName

public final String domainName()

An associated custom domain endpoint. It can be a root domain (for example, example.com), a subdomain (for example, login.example.com or admin.login.example.com), or a wildcard (for example, *.example.com).

Returns:

An associated custom domain endpoint. It can be a root domain (for example, example.com), a subdomain (for example, login.example.com or admin.login.example.com), or a wildcard (for example, *.example.com).

enableWWWSubdomain

public final Boolean enableWWWSubdomain()

When true, the subdomain www.DomainName is associated with the App Runner service in addition to the base domain.

Returns:

When true, the subdomain www.DomainName is associated with the App Runner service in addition to the base domain.

hasCertificateValidationRecords

public final boolean hasCertificateValidationRecords()

For responses, this returns true if the service returned a value for the CertificateValidationRecords 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.

certificateValidationRecords

public final List<CertificateValidationRecord> certificateValidationRecords()

A list of certificate CNAME records that's used for this domain name.

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

Returns:

A list of certificate CNAME records that's used for this domain name.

status

public final CustomDomainAssociationStatus status()

The current state of the domain name association.

If the service returns an enum value that is not available in the current SDK version, status will return CustomDomainAssociationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The current state of the domain name association.

See Also:

CustomDomainAssociationStatus

statusAsString

public final String statusAsString()

The current state of the domain name association.

If the service returns an enum value that is not available in the current SDK version, status will return CustomDomainAssociationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The current state of the domain name association.

See Also:

CustomDomainAssociationStatus

toBuilder

public CustomDomain.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CustomDomain.Builder,CustomDomain>

builder

public static CustomDomain.Builder builder()

serializableBuilderClass

public static Class<? extends CustomDomain.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo