Class RenewalSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<RenewalSummary.Builder,
RenewalSummary>
Describes the status of a SSL/TLS certificate renewal managed by Amazon Lightsail.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic RenewalSummary.Builder
builder()
final List
<DomainValidationRecord> An array of objects that describe the domain validation records of the certificate.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the DomainValidationRecords property.final int
hashCode()
final RenewalStatus
The renewal status of the certificate.final String
The renewal status of the certificate.final String
The reason for the renewal status of the certificate.static Class
<? extends RenewalSummary.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Instant
The timestamp when the certificate was last updated.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
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
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 theCreateCertificate
action.
If the service returns an enum value that is not available in the current SDK version,
renewalStatus
will returnRenewalStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrenewalStatusAsString()
.- 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 theCreateCertificate
action.
-
- See Also:
-
-
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 theCreateCertificate
action.
If the service returns an enum value that is not available in the current SDK version,
renewalStatus
will returnRenewalStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrenewalStatusAsString()
.- 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 theCreateCertificate
action.
-
- See Also:
-
-
renewalStatusReason
The reason for the renewal status of the certificate.
- Returns:
- The reason for the renewal status of the certificate.
-
updatedAt
The timestamp when the certificate was last updated.
- Returns:
- The timestamp when the certificate was last updated.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<RenewalSummary.Builder,
RenewalSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-