Package software.amazon.awssdk.services.acm.model

Class DomainValidation

java.lang.Object

software.amazon.awssdk.services.acm.model.DomainValidation

All Implemented Interfaces:

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

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

Contains information about the validation of each domain name in the certificate.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DomainValidation.Builder

Method Summary

Modifier and Type	Method	Description
static DomainValidation.Builder	builder()
String	domainName()	A fully qualified domain name (FQDN) in the certificate.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValidationEmails()	For responses, this returns true if the service returned a value for the ValidationEmails property.
ResourceRecord	resourceRecord()	Contains the CNAME record that you add to your DNS database for domain validation.
List<SdkField<?>>	sdkFields()
static Class<? extends DomainValidation.Builder>	serializableBuilderClass()
DomainValidation.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	validationDomain()	The domain name that ACM used to send domain validation emails.
List<String>	validationEmails()	A list of email addresses that ACM used to send domain validation emails.
ValidationMethod	validationMethod()	Specifies the domain validation method.
String	validationMethodAsString()	Specifies the domain validation method.
DomainStatus	validationStatus()	The validation status of the domain name.
String	validationStatusAsString()	The validation status of the domain name.

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()

A fully qualified domain name (FQDN) in the certificate. For example, www.example.com or example.com.

Returns:

A fully qualified domain name (FQDN) in the certificate. For example, www.example.com or example.com.

hasValidationEmails

public final boolean hasValidationEmails()

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

validationEmails

public final List<String> validationEmails()

A list of email addresses that ACM used to send domain validation emails.

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

Returns:

A list of email addresses that ACM used to send domain validation emails.

validationDomain

public final String validationDomain()

The domain name that ACM used to send domain validation emails.

Returns:

The domain name that ACM used to send domain validation emails.

validationStatus

public final DomainStatus validationStatus()

The validation status of the domain name. This can be one of the following values:

• PENDING_VALIDATION

• SUCCESS

• FAILED

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

Returns:

The validation status of the domain name. This can be one of the following values:

• PENDING_VALIDATION

• SUCCESS

• FAILED

See Also:

DomainStatus

validationStatusAsString

public final String validationStatusAsString()

The validation status of the domain name. This can be one of the following values:

• PENDING_VALIDATION

• SUCCESS

• FAILED

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

Returns:

The validation status of the domain name. This can be one of the following values:

• PENDING_VALIDATION

• SUCCESS

• FAILED

See Also:

DomainStatus

resourceRecord

public final ResourceRecord resourceRecord()

Contains the CNAME record that you add to your DNS database for domain validation. For more information, see Use DNS to Validate Domain Ownership.

Note: The CNAME information that you need does not include the name of your domain. If you include
 your domain name in the DNS database CNAME record, validation fails.
 For example, if the name is "_a79865eb4cd1a6ab990a45779b4e0b96.yourdomain.com", only "_a79865eb4cd1a6ab990a45779b4e0b96" must be used.

Returns:

Contains the CNAME record that you add to your DNS database for domain validation. For more information, see Use DNS to Validate Domain Ownership.

Note: The CNAME information that you need does not include the name of your domain. If you include
 your domain name in the DNS database CNAME record, validation fails.
 For example, if the name is "_a79865eb4cd1a6ab990a45779b4e0b96.yourdomain.com", only "_a79865eb4cd1a6ab990a45779b4e0b96" must be used.

validationMethod

public final ValidationMethod validationMethod()

Specifies the domain validation method.

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

Returns:

Specifies the domain validation method.

See Also:

ValidationMethod

validationMethodAsString

public final String validationMethodAsString()

Specifies the domain validation method.

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

Returns:

Specifies the domain validation method.

See Also:

ValidationMethod

toBuilder

public DomainValidation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DomainValidation.Builder,DomainValidation>

builder

public static DomainValidation.Builder builder()

serializableBuilderClass

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