Interface CertificateDetail.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<CertificateDetail.Builder,
,CertificateDetail> SdkBuilder<CertificateDetail.Builder,
,CertificateDetail> SdkPojo
- Enclosing class:
CertificateDetail
-
Method Summary
Modifier and TypeMethodDescriptioncertificateArn
(String certificateArn) The Amazon Resource Name (ARN) of the certificate.certificateAuthorityArn
(String certificateAuthorityArn) The Amazon Resource Name (ARN) of the private certificate authority (CA) that issued the certificate.The time at which the certificate was requested.domainName
(String domainName) The fully qualified domain name for the certificate, such as www.example.com or example.com.domainValidationOptions
(Collection<DomainValidation> domainValidationOptions) Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request.domainValidationOptions
(Consumer<DomainValidation.Builder>... domainValidationOptions) Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request.domainValidationOptions
(DomainValidation... domainValidationOptions) Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request.extendedKeyUsages
(Collection<ExtendedKeyUsage> extendedKeyUsages) Contains a list of Extended Key Usage X.509 v3 extension objects.extendedKeyUsages
(Consumer<ExtendedKeyUsage.Builder>... extendedKeyUsages) Contains a list of Extended Key Usage X.509 v3 extension objects.extendedKeyUsages
(ExtendedKeyUsage... extendedKeyUsages) Contains a list of Extended Key Usage X.509 v3 extension objects.failureReason
(String failureReason) The reason the certificate request failed.failureReason
(FailureReason failureReason) The reason the certificate request failed.importedAt
(Instant importedAt) The date and time when the certificate was imported.A list of ARNs for the Amazon Web Services resources that are using the certificate.inUseBy
(Collection<String> inUseBy) A list of ARNs for the Amazon Web Services resources that are using the certificate.The time at which the certificate was issued.The name of the certificate authority that issued and signed the certificate.keyAlgorithm
(String keyAlgorithm) The algorithm that was used to generate the public-private key pair.keyAlgorithm
(KeyAlgorithm keyAlgorithm) The algorithm that was used to generate the public-private key pair.keyUsages
(Collection<KeyUsage> keyUsages) A list of Key Usage X.509 v3 extension objects.keyUsages
(Consumer<KeyUsage.Builder>... keyUsages) A list of Key Usage X.509 v3 extension objects.A list of Key Usage X.509 v3 extension objects.The time after which the certificate is not valid.The time before which the certificate is not valid.default CertificateDetail.Builder
options
(Consumer<CertificateOptions.Builder> options) Value that specifies whether to add the certificate to a transparency log.options
(CertificateOptions options) Value that specifies whether to add the certificate to a transparency log.renewalEligibility
(String renewalEligibility) Specifies whether the certificate is eligible for renewal.renewalEligibility
(RenewalEligibility renewalEligibility) Specifies whether the certificate is eligible for renewal.default CertificateDetail.Builder
renewalSummary
(Consumer<RenewalSummary.Builder> renewalSummary) Contains information about the status of ACM's managed renewal for the certificate.renewalSummary
(RenewalSummary renewalSummary) Contains information about the status of ACM's managed renewal for the certificate.revocationReason
(String revocationReason) The reason the certificate was revoked.revocationReason
(RevocationReason revocationReason) The reason the certificate was revoked.The time at which the certificate was revoked.The serial number of the certificate.signatureAlgorithm
(String signatureAlgorithm) The algorithm that was used to sign the certificate.The status of the certificate.status
(CertificateStatus status) The status of the certificate.The name of the entity that is associated with the public key contained in the certificate.subjectAlternativeNames
(String... subjectAlternativeNames) One or more domain names (subject alternative names) included in the certificate.subjectAlternativeNames
(Collection<String> subjectAlternativeNames) One or more domain names (subject alternative names) included in the certificate.The source of the certificate.type
(CertificateType type) The source of the certificate.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
certificateArn
The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
- Parameters:
certificateArn
- The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
domainName
The fully qualified domain name for the certificate, such as www.example.com or example.com.
- Parameters:
domainName
- The fully qualified domain name for the certificate, such as www.example.com or example.com.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subjectAlternativeNames
One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.
- Parameters:
subjectAlternativeNames
- One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subjectAlternativeNames
One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.
- Parameters:
subjectAlternativeNames
- One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
domainValidationOptions
CertificateDetail.Builder domainValidationOptions(Collection<DomainValidation> domainValidationOptions) Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is
AMAZON_ISSUED
.- Parameters:
domainValidationOptions
- Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request. This field exists only when the certificate type isAMAZON_ISSUED
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
domainValidationOptions
Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is
AMAZON_ISSUED
.- Parameters:
domainValidationOptions
- Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request. This field exists only when the certificate type isAMAZON_ISSUED
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
domainValidationOptions
CertificateDetail.Builder domainValidationOptions(Consumer<DomainValidation.Builder>... domainValidationOptions) Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is
This is a convenience method that creates an instance of theAMAZON_ISSUED
.DomainValidation.Builder
avoiding the need to create one manually viaDomainValidation.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todomainValidationOptions(List<DomainValidation>)
.- Parameters:
domainValidationOptions
- a consumer that will call methods onDomainValidation.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
serial
The serial number of the certificate.
- Parameters:
serial
- The serial number of the certificate.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subject
The name of the entity that is associated with the public key contained in the certificate.
- Parameters:
subject
- The name of the entity that is associated with the public key contained in the certificate.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
issuer
The name of the certificate authority that issued and signed the certificate.
- Parameters:
issuer
- The name of the certificate authority that issued and signed the certificate.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createdAt
The time at which the certificate was requested.
- Parameters:
createdAt
- The time at which the certificate was requested.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
issuedAt
The time at which the certificate was issued. This value exists only when the certificate type is
AMAZON_ISSUED
.- Parameters:
issuedAt
- The time at which the certificate was issued. This value exists only when the certificate type isAMAZON_ISSUED
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
importedAt
The date and time when the certificate was imported. This value exists only when the certificate type is
IMPORTED
.- Parameters:
importedAt
- The date and time when the certificate was imported. This value exists only when the certificate type isIMPORTED
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
The status of the certificate.
A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic Certificate request fails. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation, and try again. If validation succeeds, the certificate enters status ISSUED.
- Parameters:
status
- The status of the certificate.A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic Certificate request fails. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation, and try again. If validation succeeds, the certificate enters status ISSUED.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
The status of the certificate.
A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic Certificate request fails. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation, and try again. If validation succeeds, the certificate enters status ISSUED.
- Parameters:
status
- The status of the certificate.A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic Certificate request fails. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation, and try again. If validation succeeds, the certificate enters status ISSUED.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
revokedAt
The time at which the certificate was revoked. This value exists only when the certificate status is
REVOKED
.- Parameters:
revokedAt
- The time at which the certificate was revoked. This value exists only when the certificate status isREVOKED
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
revocationReason
The reason the certificate was revoked. This value exists only when the certificate status is
REVOKED
.- Parameters:
revocationReason
- The reason the certificate was revoked. This value exists only when the certificate status isREVOKED
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
revocationReason
The reason the certificate was revoked. This value exists only when the certificate status is
REVOKED
.- Parameters:
revocationReason
- The reason the certificate was revoked. This value exists only when the certificate status isREVOKED
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
notBefore
The time before which the certificate is not valid.
- Parameters:
notBefore
- The time before which the certificate is not valid.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
notAfter
The time after which the certificate is not valid.
- Parameters:
notAfter
- The time after which the certificate is not valid.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keyAlgorithm
The algorithm that was used to generate the public-private key pair.
- Parameters:
keyAlgorithm
- The algorithm that was used to generate the public-private key pair.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
keyAlgorithm
The algorithm that was used to generate the public-private key pair.
- Parameters:
keyAlgorithm
- The algorithm that was used to generate the public-private key pair.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
signatureAlgorithm
The algorithm that was used to sign the certificate.
- Parameters:
signatureAlgorithm
- The algorithm that was used to sign the certificate.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inUseBy
A list of ARNs for the Amazon Web Services resources that are using the certificate. A certificate can be used by multiple Amazon Web Services resources.
- Parameters:
inUseBy
- A list of ARNs for the Amazon Web Services resources that are using the certificate. A certificate can be used by multiple Amazon Web Services resources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inUseBy
A list of ARNs for the Amazon Web Services resources that are using the certificate. A certificate can be used by multiple Amazon Web Services resources.
- Parameters:
inUseBy
- A list of ARNs for the Amazon Web Services resources that are using the certificate. A certificate can be used by multiple Amazon Web Services resources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
failureReason
The reason the certificate request failed. This value exists only when the certificate status is
FAILED
. For more information, see Certificate Request Failed in the Certificate Manager User Guide.- Parameters:
failureReason
- The reason the certificate request failed. This value exists only when the certificate status isFAILED
. For more information, see Certificate Request Failed in the Certificate Manager User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
failureReason
The reason the certificate request failed. This value exists only when the certificate status is
FAILED
. For more information, see Certificate Request Failed in the Certificate Manager User Guide.- Parameters:
failureReason
- The reason the certificate request failed. This value exists only when the certificate status isFAILED
. For more information, see Certificate Request Failed in the Certificate Manager User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
type
The source of the certificate. For certificates provided by ACM, this value is
AMAZON_ISSUED
. For certificates that you imported with ImportCertificate, this value isIMPORTED
. ACM does not provide managed renewal for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see Importing Certificates in the Certificate Manager User Guide.- Parameters:
type
- The source of the certificate. For certificates provided by ACM, this value isAMAZON_ISSUED
. For certificates that you imported with ImportCertificate, this value isIMPORTED
. ACM does not provide managed renewal for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see Importing Certificates in the Certificate Manager User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
type
The source of the certificate. For certificates provided by ACM, this value is
AMAZON_ISSUED
. For certificates that you imported with ImportCertificate, this value isIMPORTED
. ACM does not provide managed renewal for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see Importing Certificates in the Certificate Manager User Guide.- Parameters:
type
- The source of the certificate. For certificates provided by ACM, this value isAMAZON_ISSUED
. For certificates that you imported with ImportCertificate, this value isIMPORTED
. ACM does not provide managed renewal for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see Importing Certificates in the Certificate Manager User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
renewalSummary
Contains information about the status of ACM's managed renewal for the certificate. This field exists only when the certificate type is
AMAZON_ISSUED
.- Parameters:
renewalSummary
- Contains information about the status of ACM's managed renewal for the certificate. This field exists only when the certificate type isAMAZON_ISSUED
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
renewalSummary
Contains information about the status of ACM's managed renewal for the certificate. This field exists only when the certificate type is
This is a convenience method that creates an instance of theAMAZON_ISSUED
.RenewalSummary.Builder
avoiding the need to create one manually viaRenewalSummary.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torenewalSummary(RenewalSummary)
.- Parameters:
renewalSummary
- a consumer that will call methods onRenewalSummary.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
keyUsages
A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.
- Parameters:
keyUsages
- A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keyUsages
A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.
- Parameters:
keyUsages
- A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keyUsages
A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.
This is a convenience method that creates an instance of theKeyUsage.Builder
avoiding the need to create one manually viaKeyUsage.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tokeyUsages(List<KeyUsage>)
.- Parameters:
keyUsages
- a consumer that will call methods onKeyUsage.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
extendedKeyUsages
Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).
- Parameters:
extendedKeyUsages
- Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
extendedKeyUsages
Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).
- Parameters:
extendedKeyUsages
- Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
extendedKeyUsages
CertificateDetail.Builder extendedKeyUsages(Consumer<ExtendedKeyUsage.Builder>... extendedKeyUsages) Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).
This is a convenience method that creates an instance of theExtendedKeyUsage.Builder
avoiding the need to create one manually viaExtendedKeyUsage.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toextendedKeyUsages(List<ExtendedKeyUsage>)
.- Parameters:
extendedKeyUsages
- a consumer that will call methods onExtendedKeyUsage.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
certificateAuthorityArn
The Amazon Resource Name (ARN) of the private certificate authority (CA) that issued the certificate. This has the following format:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
- Parameters:
certificateAuthorityArn
- The Amazon Resource Name (ARN) of the private certificate authority (CA) that issued the certificate. This has the following format:arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
renewalEligibility
Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.
- Parameters:
renewalEligibility
- Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
renewalEligibility
Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.
- Parameters:
renewalEligibility
- Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
options
Value that specifies whether to add the certificate to a transparency log. Certificate transparency makes it possible to detect SSL certificates that have been mistakenly or maliciously issued. A browser might respond to certificate that has not been logged by showing an error message. The logs are cryptographically secure.
- Parameters:
options
- Value that specifies whether to add the certificate to a transparency log. Certificate transparency makes it possible to detect SSL certificates that have been mistakenly or maliciously issued. A browser might respond to certificate that has not been logged by showing an error message. The logs are cryptographically secure.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
options
Value that specifies whether to add the certificate to a transparency log. Certificate transparency makes it possible to detect SSL certificates that have been mistakenly or maliciously issued. A browser might respond to certificate that has not been logged by showing an error message. The logs are cryptographically secure.
This is a convenience method that creates an instance of theCertificateOptions.Builder
avoiding the need to create one manually viaCertificateOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooptions(CertificateOptions)
.- Parameters:
options
- a consumer that will call methods onCertificateOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-