Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data LoadBalancerTlsCertificate = LoadBalancerTlsCertificate' {
- arn :: Maybe Text
- createdAt :: Maybe POSIX
- domainName :: Maybe Text
- domainValidationRecords :: Maybe [LoadBalancerTlsCertificateDomainValidationRecord]
- failureReason :: Maybe LoadBalancerTlsCertificateFailureReason
- isAttached :: Maybe Bool
- issuedAt :: Maybe POSIX
- issuer :: Maybe Text
- keyAlgorithm :: Maybe Text
- loadBalancerName :: Maybe Text
- location :: Maybe ResourceLocation
- name :: Maybe Text
- notAfter :: Maybe POSIX
- notBefore :: Maybe POSIX
- renewalSummary :: Maybe LoadBalancerTlsCertificateRenewalSummary
- resourceType :: Maybe ResourceType
- revocationReason :: Maybe LoadBalancerTlsCertificateRevocationReason
- revokedAt :: Maybe POSIX
- serial :: Maybe Text
- signatureAlgorithm :: Maybe Text
- status :: Maybe LoadBalancerTlsCertificateStatus
- subject :: Maybe Text
- subjectAlternativeNames :: Maybe [Text]
- supportCode :: Maybe Text
- tags :: Maybe [Tag]
- newLoadBalancerTlsCertificate :: LoadBalancerTlsCertificate
- loadBalancerTlsCertificate_arn :: Lens' LoadBalancerTlsCertificate (Maybe Text)
- loadBalancerTlsCertificate_createdAt :: Lens' LoadBalancerTlsCertificate (Maybe UTCTime)
- loadBalancerTlsCertificate_domainName :: Lens' LoadBalancerTlsCertificate (Maybe Text)
- loadBalancerTlsCertificate_domainValidationRecords :: Lens' LoadBalancerTlsCertificate (Maybe [LoadBalancerTlsCertificateDomainValidationRecord])
- loadBalancerTlsCertificate_failureReason :: Lens' LoadBalancerTlsCertificate (Maybe LoadBalancerTlsCertificateFailureReason)
- loadBalancerTlsCertificate_isAttached :: Lens' LoadBalancerTlsCertificate (Maybe Bool)
- loadBalancerTlsCertificate_issuedAt :: Lens' LoadBalancerTlsCertificate (Maybe UTCTime)
- loadBalancerTlsCertificate_issuer :: Lens' LoadBalancerTlsCertificate (Maybe Text)
- loadBalancerTlsCertificate_keyAlgorithm :: Lens' LoadBalancerTlsCertificate (Maybe Text)
- loadBalancerTlsCertificate_loadBalancerName :: Lens' LoadBalancerTlsCertificate (Maybe Text)
- loadBalancerTlsCertificate_location :: Lens' LoadBalancerTlsCertificate (Maybe ResourceLocation)
- loadBalancerTlsCertificate_name :: Lens' LoadBalancerTlsCertificate (Maybe Text)
- loadBalancerTlsCertificate_notAfter :: Lens' LoadBalancerTlsCertificate (Maybe UTCTime)
- loadBalancerTlsCertificate_notBefore :: Lens' LoadBalancerTlsCertificate (Maybe UTCTime)
- loadBalancerTlsCertificate_renewalSummary :: Lens' LoadBalancerTlsCertificate (Maybe LoadBalancerTlsCertificateRenewalSummary)
- loadBalancerTlsCertificate_resourceType :: Lens' LoadBalancerTlsCertificate (Maybe ResourceType)
- loadBalancerTlsCertificate_revocationReason :: Lens' LoadBalancerTlsCertificate (Maybe LoadBalancerTlsCertificateRevocationReason)
- loadBalancerTlsCertificate_revokedAt :: Lens' LoadBalancerTlsCertificate (Maybe UTCTime)
- loadBalancerTlsCertificate_serial :: Lens' LoadBalancerTlsCertificate (Maybe Text)
- loadBalancerTlsCertificate_signatureAlgorithm :: Lens' LoadBalancerTlsCertificate (Maybe Text)
- loadBalancerTlsCertificate_status :: Lens' LoadBalancerTlsCertificate (Maybe LoadBalancerTlsCertificateStatus)
- loadBalancerTlsCertificate_subject :: Lens' LoadBalancerTlsCertificate (Maybe Text)
- loadBalancerTlsCertificate_subjectAlternativeNames :: Lens' LoadBalancerTlsCertificate (Maybe [Text])
- loadBalancerTlsCertificate_supportCode :: Lens' LoadBalancerTlsCertificate (Maybe Text)
- loadBalancerTlsCertificate_tags :: Lens' LoadBalancerTlsCertificate (Maybe [Tag])
Documentation
data LoadBalancerTlsCertificate Source #
Describes a load balancer SSL/TLS certificate.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
See: newLoadBalancerTlsCertificate
smart constructor.
LoadBalancerTlsCertificate' | |
|
Instances
newLoadBalancerTlsCertificate :: LoadBalancerTlsCertificate Source #
Create a value of LoadBalancerTlsCertificate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:LoadBalancerTlsCertificate'
, loadBalancerTlsCertificate_arn
- The Amazon Resource Name (ARN) of the SSL/TLS certificate.
$sel:createdAt:LoadBalancerTlsCertificate'
, loadBalancerTlsCertificate_createdAt
- The time when you created your SSL/TLS certificate.
LoadBalancerTlsCertificate
, loadBalancerTlsCertificate_domainName
- The domain name for your SSL/TLS certificate.
$sel:domainValidationRecords:LoadBalancerTlsCertificate'
, loadBalancerTlsCertificate_domainValidationRecords
- An array of LoadBalancerTlsCertificateDomainValidationRecord objects
describing the records.
$sel:failureReason:LoadBalancerTlsCertificate'
, loadBalancerTlsCertificate_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 forexample.invalidpublicdomain
becauseinvalidpublicdomain
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.
$sel:isAttached:LoadBalancerTlsCertificate'
, loadBalancerTlsCertificate_isAttached
- When true
, the SSL/TLS certificate is attached to the Lightsail load
balancer.
$sel:issuedAt:LoadBalancerTlsCertificate'
, loadBalancerTlsCertificate_issuedAt
- The time when the SSL/TLS certificate was issued.
$sel:issuer:LoadBalancerTlsCertificate'
, loadBalancerTlsCertificate_issuer
- The issuer of the certificate.
$sel:keyAlgorithm:LoadBalancerTlsCertificate'
, loadBalancerTlsCertificate_keyAlgorithm
- The algorithm used to generate the key pair (the public and private
key).
$sel:loadBalancerName:LoadBalancerTlsCertificate'
, loadBalancerTlsCertificate_loadBalancerName
- The load balancer name where your SSL/TLS certificate is attached.
$sel:location:LoadBalancerTlsCertificate'
, loadBalancerTlsCertificate_location
- The Amazon Web Services Region and Availability Zone where you created
your certificate.
LoadBalancerTlsCertificate
, loadBalancerTlsCertificate_name
- The name of the SSL/TLS certificate (e.g., my-certificate
).
$sel:notAfter:LoadBalancerTlsCertificate'
, loadBalancerTlsCertificate_notAfter
- The timestamp when the SSL/TLS certificate expires.
$sel:notBefore:LoadBalancerTlsCertificate'
, loadBalancerTlsCertificate_notBefore
- The timestamp when the SSL/TLS certificate is first valid.
$sel:renewalSummary:LoadBalancerTlsCertificate'
, loadBalancerTlsCertificate_renewalSummary
- An object that describes the status of the certificate renewal managed
by Lightsail.
$sel:resourceType:LoadBalancerTlsCertificate'
, loadBalancerTlsCertificate_resourceType
- The resource type (e.g., LoadBalancerTlsCertificate
).
Instance
- A Lightsail instance (a virtual private server)StaticIp
- A static IP addressKeyPair
- The key pair used to connect to a Lightsail instanceInstanceSnapshot
- A Lightsail instance snapshotDomain
- A DNS zonePeeredVpc
- A peered VPCLoadBalancer
- A Lightsail load balancerLoadBalancerTlsCertificate
- An SSL/TLS certificate associated with a Lightsail load balancerDisk
- A Lightsail block storage diskDiskSnapshot
- A block storage disk snapshot
$sel:revocationReason:LoadBalancerTlsCertificate'
, loadBalancerTlsCertificate_revocationReason
- The reason the certificate was revoked. This value is present only when
the certificate status is REVOKED
.
$sel:revokedAt:LoadBalancerTlsCertificate'
, loadBalancerTlsCertificate_revokedAt
- The timestamp when the certificate was revoked. This value is present
only when the certificate status is REVOKED
.
$sel:serial:LoadBalancerTlsCertificate'
, loadBalancerTlsCertificate_serial
- The serial number of the certificate.
$sel:signatureAlgorithm:LoadBalancerTlsCertificate'
, loadBalancerTlsCertificate_signatureAlgorithm
- The algorithm that was used to sign the certificate.
$sel:status:LoadBalancerTlsCertificate'
, loadBalancerTlsCertificate_status
- The validation status of the SSL/TLS certificate. Valid values are
below.
$sel:subject:LoadBalancerTlsCertificate'
, loadBalancerTlsCertificate_subject
- The name of the entity that is associated with the public key contained
in the certificate.
$sel:subjectAlternativeNames:LoadBalancerTlsCertificate'
, loadBalancerTlsCertificate_subjectAlternativeNames
- An array of strings that specify the alternate domains (e.g.,
example2.com
) and subdomains (e.g., blog.example.com
) for the
certificate.
$sel:supportCode:LoadBalancerTlsCertificate'
, loadBalancerTlsCertificate_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.
$sel:tags:LoadBalancerTlsCertificate'
, loadBalancerTlsCertificate_tags
- The tag keys and optional values for the resource. For more information
about tags in Lightsail, see the
Amazon Lightsail Developer Guide.
loadBalancerTlsCertificate_arn :: Lens' LoadBalancerTlsCertificate (Maybe Text) Source #
The Amazon Resource Name (ARN) of the SSL/TLS certificate.
loadBalancerTlsCertificate_createdAt :: Lens' LoadBalancerTlsCertificate (Maybe UTCTime) Source #
The time when you created your SSL/TLS certificate.
loadBalancerTlsCertificate_domainName :: Lens' LoadBalancerTlsCertificate (Maybe Text) Source #
The domain name for your SSL/TLS certificate.
loadBalancerTlsCertificate_domainValidationRecords :: Lens' LoadBalancerTlsCertificate (Maybe [LoadBalancerTlsCertificateDomainValidationRecord]) Source #
An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records.
loadBalancerTlsCertificate_failureReason :: Lens' LoadBalancerTlsCertificate (Maybe LoadBalancerTlsCertificateFailureReason) Source #
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 forexample.invalidpublicdomain
becauseinvalidpublicdomain
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.
loadBalancerTlsCertificate_isAttached :: Lens' LoadBalancerTlsCertificate (Maybe Bool) Source #
When true
, the SSL/TLS certificate is attached to the Lightsail load
balancer.
loadBalancerTlsCertificate_issuedAt :: Lens' LoadBalancerTlsCertificate (Maybe UTCTime) Source #
The time when the SSL/TLS certificate was issued.
loadBalancerTlsCertificate_issuer :: Lens' LoadBalancerTlsCertificate (Maybe Text) Source #
The issuer of the certificate.
loadBalancerTlsCertificate_keyAlgorithm :: Lens' LoadBalancerTlsCertificate (Maybe Text) Source #
The algorithm used to generate the key pair (the public and private key).
loadBalancerTlsCertificate_loadBalancerName :: Lens' LoadBalancerTlsCertificate (Maybe Text) Source #
The load balancer name where your SSL/TLS certificate is attached.
loadBalancerTlsCertificate_location :: Lens' LoadBalancerTlsCertificate (Maybe ResourceLocation) Source #
The Amazon Web Services Region and Availability Zone where you created your certificate.
loadBalancerTlsCertificate_name :: Lens' LoadBalancerTlsCertificate (Maybe Text) Source #
The name of the SSL/TLS certificate (e.g., my-certificate
).
loadBalancerTlsCertificate_notAfter :: Lens' LoadBalancerTlsCertificate (Maybe UTCTime) Source #
The timestamp when the SSL/TLS certificate expires.
loadBalancerTlsCertificate_notBefore :: Lens' LoadBalancerTlsCertificate (Maybe UTCTime) Source #
The timestamp when the SSL/TLS certificate is first valid.
loadBalancerTlsCertificate_renewalSummary :: Lens' LoadBalancerTlsCertificate (Maybe LoadBalancerTlsCertificateRenewalSummary) Source #
An object that describes the status of the certificate renewal managed by Lightsail.
loadBalancerTlsCertificate_resourceType :: Lens' LoadBalancerTlsCertificate (Maybe ResourceType) Source #
The resource type (e.g., LoadBalancerTlsCertificate
).
Instance
- A Lightsail instance (a virtual private server)StaticIp
- A static IP addressKeyPair
- The key pair used to connect to a Lightsail instanceInstanceSnapshot
- A Lightsail instance snapshotDomain
- A DNS zonePeeredVpc
- A peered VPCLoadBalancer
- A Lightsail load balancerLoadBalancerTlsCertificate
- An SSL/TLS certificate associated with a Lightsail load balancerDisk
- A Lightsail block storage diskDiskSnapshot
- A block storage disk snapshot
loadBalancerTlsCertificate_revocationReason :: Lens' LoadBalancerTlsCertificate (Maybe LoadBalancerTlsCertificateRevocationReason) Source #
The reason the certificate was revoked. This value is present only when
the certificate status is REVOKED
.
loadBalancerTlsCertificate_revokedAt :: Lens' LoadBalancerTlsCertificate (Maybe UTCTime) Source #
The timestamp when the certificate was revoked. This value is present
only when the certificate status is REVOKED
.
loadBalancerTlsCertificate_serial :: Lens' LoadBalancerTlsCertificate (Maybe Text) Source #
The serial number of the certificate.
loadBalancerTlsCertificate_signatureAlgorithm :: Lens' LoadBalancerTlsCertificate (Maybe Text) Source #
The algorithm that was used to sign the certificate.
loadBalancerTlsCertificate_status :: Lens' LoadBalancerTlsCertificate (Maybe LoadBalancerTlsCertificateStatus) Source #
The validation status of the SSL/TLS certificate. Valid values are below.
loadBalancerTlsCertificate_subject :: Lens' LoadBalancerTlsCertificate (Maybe Text) Source #
The name of the entity that is associated with the public key contained in the certificate.
loadBalancerTlsCertificate_subjectAlternativeNames :: Lens' LoadBalancerTlsCertificate (Maybe [Text]) Source #
An array of strings that specify the alternate domains (e.g.,
example2.com
) and subdomains (e.g., blog.example.com
) for the
certificate.
loadBalancerTlsCertificate_supportCode :: Lens' LoadBalancerTlsCertificate (Maybe Text) Source #
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.
loadBalancerTlsCertificate_tags :: Lens' LoadBalancerTlsCertificate (Maybe [Tag]) Source #
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.