software.amazon.awssdk.services.lightsail.model

Class RenewalSummary

java.lang.Object

software.amazon.awssdk.services.lightsail.model.RenewalSummary

All Implemented Interfaces:

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

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

Describes the status of a SSL/TLS certificate renewal managed by Amazon Lightsail.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RenewalSummary.Builder

Method Summary

Modifier and Type	Method and Description
static RenewalSummary.Builder	builder()
List<DomainValidationRecord>	domainValidationRecords() An array of objects that describe the domain validation records of the certificate.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDomainValidationRecords() For responses, this returns true if the service returned a value for the DomainValidationRecords property.
int	hashCode()
RenewalStatus	renewalStatus() The renewal status of the certificate.
String	renewalStatusAsString() The renewal status of the certificate.
String	renewalStatusReason() The reason for the renewal status of the certificate.
List<SdkField<?>>	sdkFields()
static Class<? extends RenewalSummary.Builder>	serializableBuilderClass()
RenewalSummary.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Instant	updatedAt() The timestamp when the certificate was last updated.

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

hasDomainValidationRecords

public final boolean hasDomainValidationRecords()

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

domainValidationRecords

public final List<DomainValidationRecord> domainValidationRecords()

An array of objects that describe the domain validation records of the certificate.

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

Returns:

An array of objects that describe the domain validation records of the certificate.

renewalStatus

public final RenewalStatus renewalStatus()

The renewal status of the certificate.

The following renewal status are possible:

• PendingAutoRenewal - Lightsail is attempting to automatically validate the domain names of the certificate. No further action is required.

• PendingValidation - Lightsail couldn't automatically validate one or more domain names of the certificate. You must take action to validate these domain names or the certificate won't be renewed. Check to make sure your certificate's domain validation records exist in your domain's DNS, and that your certificate remains in use.

• Success - All domain names in the certificate are validated, and Lightsail renewed the certificate. No further action is required.

• Failed - One or more domain names were not validated before the certificate expired, and Lightsail did not renew the certificate. You can request a new certificate using the CreateCertificate action.

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

Returns:

The renewal status of the certificate.

The following renewal status are possible:

• PendingAutoRenewal - Lightsail is attempting to automatically validate the domain names of the certificate. No further action is required.

• PendingValidation - Lightsail couldn't automatically validate one or more domain names of the certificate. You must take action to validate these domain names or the certificate won't be renewed. Check to make sure your certificate's domain validation records exist in your domain's DNS, and that your certificate remains in use.

• Success - All domain names in the certificate are validated, and Lightsail renewed the certificate. No further action is required.

• Failed - One or more domain names were not validated before the certificate expired, and Lightsail did not renew the certificate. You can request a new certificate using the CreateCertificate action.

See Also:

RenewalStatus

renewalStatusAsString

public final String renewalStatusAsString()

The renewal status of the certificate.

The following renewal status are possible:

• PendingAutoRenewal - Lightsail is attempting to automatically validate the domain names of the certificate. No further action is required.

• PendingValidation - Lightsail couldn't automatically validate one or more domain names of the certificate. You must take action to validate these domain names or the certificate won't be renewed. Check to make sure your certificate's domain validation records exist in your domain's DNS, and that your certificate remains in use.

• Success - All domain names in the certificate are validated, and Lightsail renewed the certificate. No further action is required.

• Failed - One or more domain names were not validated before the certificate expired, and Lightsail did not renew the certificate. You can request a new certificate using the CreateCertificate action.

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

Returns:

The renewal status of the certificate.

The following renewal status are possible:

• PendingAutoRenewal - Lightsail is attempting to automatically validate the domain names of the certificate. No further action is required.

• PendingValidation - Lightsail couldn't automatically validate one or more domain names of the certificate. You must take action to validate these domain names or the certificate won't be renewed. Check to make sure your certificate's domain validation records exist in your domain's DNS, and that your certificate remains in use.

• Success - All domain names in the certificate are validated, and Lightsail renewed the certificate. No further action is required.

• Failed - One or more domain names were not validated before the certificate expired, and Lightsail did not renew the certificate. You can request a new certificate using the CreateCertificate action.

See Also:

RenewalStatus

renewalStatusReason

public final String renewalStatusReason()

The reason for the renewal status of the certificate.

Returns:

The reason for the renewal status of the certificate.

updatedAt

public final Instant updatedAt()

The timestamp when the certificate was last updated.

Returns:

The timestamp when the certificate was last updated.

toBuilder

public RenewalSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RenewalSummary.Builder,RenewalSummary>

builder

public static RenewalSummary.Builder builder()

serializableBuilderClass

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