software.amazon.awssdk.services.apigatewayv2.model

Class DomainNameConfiguration

java.lang.Object

software.amazon.awssdk.services.apigatewayv2.model.DomainNameConfiguration

All Implemented Interfaces:

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

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

The domain name configuration.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DomainNameConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
String	apiGatewayDomainName() A domain name for the API.
static DomainNameConfiguration.Builder	builder()
String	certificateArn() An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name.
String	certificateName() The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
Instant	certificateUploadDate() The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
DomainNameStatus	domainNameStatus() The status of the domain name migration.
String	domainNameStatusAsString() The status of the domain name migration.
String	domainNameStatusMessage() An optional text message containing detailed information about status of the domain name migration.
EndpointType	endpointType() The endpoint type.
String	endpointTypeAsString() The endpoint type.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	hostedZoneId() The Amazon Route 53 Hosted Zone ID of the endpoint.
List<SdkField<?>>	sdkFields()
SecurityPolicy	securityPolicy() The Transport Layer Security (TLS) version of the security policy for this domain name.
String	securityPolicyAsString() The Transport Layer Security (TLS) version of the security policy for this domain name.
static Class<? extends DomainNameConfiguration.Builder>	serializableBuilderClass()
DomainNameConfiguration.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

apiGatewayDomainName

public final String apiGatewayDomainName()

A domain name for the API.

Returns:

A domain name for the API.

certificateArn

public final String certificateArn()

An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

Returns:

An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

certificateName

public final String certificateName()

The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.

Returns:

The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.

certificateUploadDate

public final Instant certificateUploadDate()

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

Returns:

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

domainNameStatus

public final DomainNameStatus domainNameStatus()

The status of the domain name migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

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

Returns:

The status of the domain name migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

See Also:

DomainNameStatus

domainNameStatusAsString

public final String domainNameStatusAsString()

The status of the domain name migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

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

Returns:

The status of the domain name migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

See Also:

DomainNameStatus

domainNameStatusMessage

public final String domainNameStatusMessage()

An optional text message containing detailed information about status of the domain name migration.

Returns:

An optional text message containing detailed information about status of the domain name migration.

endpointType

public final EndpointType endpointType()

The endpoint type.

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

Returns:

The endpoint type.

See Also:

EndpointType

endpointTypeAsString

public final String endpointTypeAsString()

The endpoint type.

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

Returns:

The endpoint type.

See Also:

EndpointType

hostedZoneId

public final String hostedZoneId()

The Amazon Route 53 Hosted Zone ID of the endpoint.

Returns:

The Amazon Route 53 Hosted Zone ID of the endpoint.

securityPolicy

public final SecurityPolicy securityPolicy()

The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.

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

Returns:

The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.

See Also:

SecurityPolicy

securityPolicyAsString

public final String securityPolicyAsString()

The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.

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

Returns:

The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.

See Also:

SecurityPolicy

toBuilder

public DomainNameConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DomainNameConfiguration.Builder,DomainNameConfiguration>

builder

public static DomainNameConfiguration.Builder builder()

serializableBuilderClass

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