@Generated(value="software.amazon.awssdk:codegen") public final class LoadBalancerTlsCertificate extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LoadBalancerTlsCertificate.Builder,LoadBalancerTlsCertificate>
Describes a load balancer SSL/TLS certificate.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
| Modifier and Type | Class and Description |
|---|---|
static interface |
LoadBalancerTlsCertificate.Builder |
| Modifier and Type | Method and Description |
|---|---|
String |
arn()
The Amazon Resource Name (ARN) of the SSL/TLS certificate.
|
static LoadBalancerTlsCertificate.Builder |
builder() |
Instant |
createdAt()
The time when you created your SSL/TLS certificate.
|
String |
domainName()
The domain name for your SSL/TLS certificate.
|
List<LoadBalancerTlsCertificateDomainValidationRecord> |
domainValidationRecords()
An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
LoadBalancerTlsCertificateFailureReason |
failureReason()
The validation failure reason, if any, of the certificate.
|
String |
failureReasonAsString()
The validation failure reason, if any, of the certificate.
|
<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() |
boolean |
hasSubjectAlternativeNames()
For responses, this returns true if the service returned a value for the SubjectAlternativeNames property.
|
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
Boolean |
isAttached()
When
true, the SSL/TLS certificate is attached to the Lightsail load balancer. |
Instant |
issuedAt()
The time when the SSL/TLS certificate was issued.
|
String |
issuer()
The issuer of the certificate.
|
String |
keyAlgorithm()
The algorithm used to generate the key pair (the public and private key).
|
String |
loadBalancerName()
The load balancer name where your SSL/TLS certificate is attached.
|
ResourceLocation |
location()
The Amazon Web Services Region and Availability Zone where you created your certificate.
|
String |
name()
The name of the SSL/TLS certificate (e.g.,
my-certificate). |
Instant |
notAfter()
The timestamp when the SSL/TLS certificate expires.
|
Instant |
notBefore()
The timestamp when the SSL/TLS certificate is first valid.
|
LoadBalancerTlsCertificateRenewalSummary |
renewalSummary()
An object that describes the status of the certificate renewal managed by Lightsail.
|
ResourceType |
resourceType()
The resource type (e.g.,
LoadBalancerTlsCertificate). |
String |
resourceTypeAsString()
The resource type (e.g.,
LoadBalancerTlsCertificate). |
LoadBalancerTlsCertificateRevocationReason |
revocationReason()
The reason the certificate was revoked.
|
String |
revocationReasonAsString()
The reason the certificate was revoked.
|
Instant |
revokedAt()
The timestamp when the certificate was revoked.
|
List<SdkField<?>> |
sdkFields() |
String |
serial()
The serial number of the certificate.
|
static Class<? extends LoadBalancerTlsCertificate.Builder> |
serializableBuilderClass() |
String |
signatureAlgorithm()
The algorithm that was used to sign the certificate.
|
LoadBalancerTlsCertificateStatus |
status()
The validation status of the SSL/TLS certificate.
|
String |
statusAsString()
The validation status of the SSL/TLS certificate.
|
String |
subject()
The name of the entity that is associated with the public key contained in the certificate.
|
List<String> |
subjectAlternativeNames()
An array of strings that specify the alternate domains (e.g.,
example2.com) and subdomains (e.g.,
blog.example.com) for the certificate. |
String |
supportCode()
The support code.
|
List<Tag> |
tags()
The tag keys and optional values for the resource.
|
LoadBalancerTlsCertificate.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String name()
The name of the SSL/TLS certificate (e.g., my-certificate).
my-certificate).public final String arn()
The Amazon Resource Name (ARN) of the SSL/TLS certificate.
public final String supportCode()
The support code. Include this code in your email to support when you have questions about your Lightsail load balancer or SSL/TLS certificate. This code enables our support team to look up your Lightsail information more easily.
public final Instant createdAt()
The time when you created your SSL/TLS certificate.
public final ResourceLocation location()
The Amazon Web Services Region and Availability Zone where you created your certificate.
public final ResourceType resourceType()
The resource type (e.g., LoadBalancerTlsCertificate).
Instance - A Lightsail instance (a virtual private server)
StaticIp - A static IP address
KeyPair - The key pair used to connect to a Lightsail instance
InstanceSnapshot - A Lightsail instance snapshot
Domain - A DNS zone
PeeredVpc - A peered VPC
LoadBalancer - A Lightsail load balancer
LoadBalancerTlsCertificate - An SSL/TLS certificate associated with a Lightsail load
balancer
Disk - A Lightsail block storage disk
DiskSnapshot - A block storage disk snapshot
If the service returns an enum value that is not available in the current SDK version, resourceType will
return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
resourceTypeAsString().
LoadBalancerTlsCertificate).
Instance - A Lightsail instance (a virtual private server)
StaticIp - A static IP address
KeyPair - The key pair used to connect to a Lightsail instance
InstanceSnapshot - A Lightsail instance snapshot
Domain - A DNS zone
PeeredVpc - A peered VPC
LoadBalancer - A Lightsail load balancer
LoadBalancerTlsCertificate - An SSL/TLS certificate associated with a Lightsail
load balancer
Disk - A Lightsail block storage disk
DiskSnapshot - A block storage disk snapshot
ResourceTypepublic final String resourceTypeAsString()
The resource type (e.g., LoadBalancerTlsCertificate).
Instance - A Lightsail instance (a virtual private server)
StaticIp - A static IP address
KeyPair - The key pair used to connect to a Lightsail instance
InstanceSnapshot - A Lightsail instance snapshot
Domain - A DNS zone
PeeredVpc - A peered VPC
LoadBalancer - A Lightsail load balancer
LoadBalancerTlsCertificate - An SSL/TLS certificate associated with a Lightsail load
balancer
Disk - A Lightsail block storage disk
DiskSnapshot - A block storage disk snapshot
If the service returns an enum value that is not available in the current SDK version, resourceType will
return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
resourceTypeAsString().
LoadBalancerTlsCertificate).
Instance - A Lightsail instance (a virtual private server)
StaticIp - A static IP address
KeyPair - The key pair used to connect to a Lightsail instance
InstanceSnapshot - A Lightsail instance snapshot
Domain - A DNS zone
PeeredVpc - A peered VPC
LoadBalancer - A Lightsail load balancer
LoadBalancerTlsCertificate - An SSL/TLS certificate associated with a Lightsail
load balancer
Disk - A Lightsail block storage disk
DiskSnapshot - A block storage disk snapshot
ResourceTypepublic final boolean hasTags()
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.public final List<Tag> tags()
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
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 hasTags() method.
public final String loadBalancerName()
The load balancer name where your SSL/TLS certificate is attached.
public final Boolean isAttached()
When true, the SSL/TLS certificate is attached to the Lightsail load balancer.
true, the SSL/TLS certificate is attached to the Lightsail load balancer.public final LoadBalancerTlsCertificateStatus status()
The validation status of the SSL/TLS certificate. Valid values are below.
If the service returns an enum value that is not available in the current SDK version, status will
return LoadBalancerTlsCertificateStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is
available from statusAsString().
LoadBalancerTlsCertificateStatuspublic final String statusAsString()
The validation status of the SSL/TLS certificate. Valid values are below.
If the service returns an enum value that is not available in the current SDK version, status will
return LoadBalancerTlsCertificateStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is
available from statusAsString().
LoadBalancerTlsCertificateStatuspublic final String domainName()
The domain name for your SSL/TLS certificate.
public final boolean hasDomainValidationRecords()
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.public final List<LoadBalancerTlsCertificateDomainValidationRecord> domainValidationRecords()
An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records.
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.
public final LoadBalancerTlsCertificateFailureReason failureReason()
The validation failure reason, if any, of the certificate.
The following failure reasons are possible:
NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is not available
for Lightsail certificates.
ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to process
this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the
Alexa top 1000 websites. To provide the required information, use the AWS Support Center to contact AWS Support.
You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.
DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request was
reported as an unsafe domain by VirusTotal. To correct the
problem, search for your domain name on the VirusTotal
website. If your domain is reported as suspicious, see Google Help for Hacked Websites to
learn what you can do.
If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.
If you see this error and your domain is not included in the VirusTotal list, visit the AWS Support Center and create a case.
INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate request is not
valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a
certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all
domain names in the request are for valid top-level domains. For example, you cannot request a certificate for
example.invalidpublicdomain because invalidpublicdomain is not a valid top-level
domain.
OTHER - Typically, this failure occurs when there is a typographical error in one or more
of the domain names in the certificate request. Try to request a certificate again, correcting any spelling
errors or typos that were in the failed request.
If the service returns an enum value that is not available in the current SDK version, failureReason
will return LoadBalancerTlsCertificateFailureReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the
service is available from failureReasonAsString().
The following failure reasons are possible:
NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is not
available for Lightsail certificates.
ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to
process this certificate request. This can happen as a fraud-protection measure, such as when the domain
ranks within the Alexa top 1000 websites. To provide the required information, use the AWS Support Center to contact AWS Support.
You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.
DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request was
reported as an unsafe domain by VirusTotal. To
correct the problem, search for your domain name on the VirusTotal website. If your domain is reported as
suspicious, see Google Help for
Hacked Websites to learn what you can do.
If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.
If you see this error and your domain is not included in the VirusTotal list, visit the AWS Support Center and create a case.
INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate request
is not valid. Typically, this is because a domain name in the request is not a valid top-level domain.
Try to request a certificate again, correcting any spelling errors or typos that were in the failed
request, and ensure that all domain names in the request are for valid top-level domains. For example,
you cannot request a certificate for example.invalidpublicdomain because
invalidpublicdomain is not a valid top-level domain.
OTHER - Typically, this failure occurs when there is a typographical error in one
or more of the domain names in the certificate request. Try to request a certificate again, correcting
any spelling errors or typos that were in the failed request.
LoadBalancerTlsCertificateFailureReasonpublic final String failureReasonAsString()
The validation failure reason, if any, of the certificate.
The following failure reasons are possible:
NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is not available
for Lightsail certificates.
ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to process
this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the
Alexa top 1000 websites. To provide the required information, use the AWS Support Center to contact AWS Support.
You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.
DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request was
reported as an unsafe domain by VirusTotal. To correct the
problem, search for your domain name on the VirusTotal
website. If your domain is reported as suspicious, see Google Help for Hacked Websites to
learn what you can do.
If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.
If you see this error and your domain is not included in the VirusTotal list, visit the AWS Support Center and create a case.
INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate request is not
valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a
certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all
domain names in the request are for valid top-level domains. For example, you cannot request a certificate for
example.invalidpublicdomain because invalidpublicdomain is not a valid top-level
domain.
OTHER - Typically, this failure occurs when there is a typographical error in one or more
of the domain names in the certificate request. Try to request a certificate again, correcting any spelling
errors or typos that were in the failed request.
If the service returns an enum value that is not available in the current SDK version, failureReason
will return LoadBalancerTlsCertificateFailureReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the
service is available from failureReasonAsString().
The following failure reasons are possible:
NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is not
available for Lightsail certificates.
ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to
process this certificate request. This can happen as a fraud-protection measure, such as when the domain
ranks within the Alexa top 1000 websites. To provide the required information, use the AWS Support Center to contact AWS Support.
You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.
DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request was
reported as an unsafe domain by VirusTotal. To
correct the problem, search for your domain name on the VirusTotal website. If your domain is reported as
suspicious, see Google Help for
Hacked Websites to learn what you can do.
If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.
If you see this error and your domain is not included in the VirusTotal list, visit the AWS Support Center and create a case.
INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate request
is not valid. Typically, this is because a domain name in the request is not a valid top-level domain.
Try to request a certificate again, correcting any spelling errors or typos that were in the failed
request, and ensure that all domain names in the request are for valid top-level domains. For example,
you cannot request a certificate for example.invalidpublicdomain because
invalidpublicdomain is not a valid top-level domain.
OTHER - Typically, this failure occurs when there is a typographical error in one
or more of the domain names in the certificate request. Try to request a certificate again, correcting
any spelling errors or typos that were in the failed request.
LoadBalancerTlsCertificateFailureReasonpublic final Instant issuedAt()
The time when the SSL/TLS certificate was issued.
public final String issuer()
The issuer of the certificate.
public final String keyAlgorithm()
The algorithm used to generate the key pair (the public and private key).
public final Instant notAfter()
The timestamp when the SSL/TLS certificate expires.
public final Instant notBefore()
The timestamp when the SSL/TLS certificate is first valid.
public final LoadBalancerTlsCertificateRenewalSummary renewalSummary()
An object that describes the status of the certificate renewal managed by Lightsail.
public final LoadBalancerTlsCertificateRevocationReason revocationReason()
The reason the certificate was revoked. This value is present only when the certificate status is
REVOKED.
If the service returns an enum value that is not available in the current SDK version, revocationReason
will return LoadBalancerTlsCertificateRevocationReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by
the service is available from revocationReasonAsString().
REVOKED.LoadBalancerTlsCertificateRevocationReasonpublic final String revocationReasonAsString()
The reason the certificate was revoked. This value is present only when the certificate status is
REVOKED.
If the service returns an enum value that is not available in the current SDK version, revocationReason
will return LoadBalancerTlsCertificateRevocationReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by
the service is available from revocationReasonAsString().
REVOKED.LoadBalancerTlsCertificateRevocationReasonpublic final Instant revokedAt()
The timestamp when the certificate was revoked. This value is present only when the certificate status is
REVOKED.
REVOKED.public final String serial()
The serial number of the certificate.
public final String signatureAlgorithm()
The algorithm that was used to sign the certificate.
public final String subject()
The name of the entity that is associated with the public key contained in the certificate.
public final boolean hasSubjectAlternativeNames()
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.public final List<String> subjectAlternativeNames()
An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g.,
blog.example.com) for 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 hasSubjectAlternativeNames() method.
example2.com) and subdomains
(e.g., blog.example.com) for the certificate.public LoadBalancerTlsCertificate.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<LoadBalancerTlsCertificate.Builder,LoadBalancerTlsCertificate>public static LoadBalancerTlsCertificate.Builder builder()
public static Class<? extends LoadBalancerTlsCertificate.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
Copyright © 2023. All rights reserved.