public static interface IssueCertificateRequest.Builder extends AcmPcaRequest.Builder, SdkPojo, CopyableBuilder<IssueCertificateRequest.Builder,IssueCertificateRequest>
| Modifier and Type | Method and Description |
|---|---|
IssueCertificateRequest.Builder |
apiPassthrough(ApiPassthrough apiPassthrough)
Specifies X.509 certificate information to be included in the issued certificate.
|
default IssueCertificateRequest.Builder |
apiPassthrough(Consumer<ApiPassthrough.Builder> apiPassthrough)
Specifies X.509 certificate information to be included in the issued certificate.
|
IssueCertificateRequest.Builder |
certificateAuthorityArn(String certificateAuthorityArn)
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority.
|
IssueCertificateRequest.Builder |
csr(SdkBytes csr)
The certificate signing request (CSR) for the certificate you want to issue.
|
IssueCertificateRequest.Builder |
idempotencyToken(String idempotencyToken)
Alphanumeric string that can be used to distinguish between calls to the IssueCertificate action.
|
IssueCertificateRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
IssueCertificateRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
IssueCertificateRequest.Builder |
signingAlgorithm(SigningAlgorithm signingAlgorithm)
The name of the algorithm that will be used to sign the certificate to be issued.
|
IssueCertificateRequest.Builder |
signingAlgorithm(String signingAlgorithm)
The name of the algorithm that will be used to sign the certificate to be issued.
|
IssueCertificateRequest.Builder |
templateArn(String templateArn)
Specifies a custom configuration template to use when issuing a certificate.
|
default IssueCertificateRequest.Builder |
validity(Consumer<Validity.Builder> validity)
Information describing the end of the validity period of the certificate.
|
IssueCertificateRequest.Builder |
validity(Validity validity)
Information describing the end of the validity period of the certificate.
|
default IssueCertificateRequest.Builder |
validityNotBefore(Consumer<Validity.Builder> validityNotBefore)
Information describing the start of the validity period of the certificate.
|
IssueCertificateRequest.Builder |
validityNotBefore(Validity validityNotBefore)
Information describing the start of the validity period of the certificate.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildIssueCertificateRequest.Builder apiPassthrough(ApiPassthrough apiPassthrough)
Specifies X.509 certificate information to be included in the issued certificate. An
APIPassthrough or APICSRPassthrough template variant must be selected, or else this
parameter is ignored. For more information about using these templates, see Understanding Certificate
Templates.
If conflicting or duplicate certificate information is supplied during certificate issuance, Amazon Web Services Private CA applies order of operation rules to determine what information is used.
apiPassthrough - Specifies X.509 certificate information to be included in the issued certificate. An
APIPassthrough or APICSRPassthrough template variant must be selected, or
else this parameter is ignored. For more information about using these templates, see Understanding
Certificate Templates.
If conflicting or duplicate certificate information is supplied during certificate issuance, Amazon Web Services Private CA applies order of operation rules to determine what information is used.
default IssueCertificateRequest.Builder apiPassthrough(Consumer<ApiPassthrough.Builder> apiPassthrough)
Specifies X.509 certificate information to be included in the issued certificate. An
APIPassthrough or APICSRPassthrough template variant must be selected, or else this
parameter is ignored. For more information about using these templates, see Understanding Certificate
Templates.
If conflicting or duplicate certificate information is supplied during certificate issuance, Amazon Web Services Private CA applies order of operation rules to determine what information is used.
This is a convenience method that creates an instance of theApiPassthrough.Builder avoiding the need
to create one manually via ApiPassthrough.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to apiPassthrough(ApiPassthrough).
apiPassthrough - a consumer that will call methods on ApiPassthrough.BuilderapiPassthrough(ApiPassthrough)IssueCertificateRequest.Builder certificateAuthorityArn(String certificateAuthorityArn)
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
certificateAuthorityArn - The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
IssueCertificateRequest.Builder csr(SdkBytes csr)
The certificate signing request (CSR) for the certificate you want to issue. As an example, you can use the following OpenSSL command to create the CSR and a 2048 bit RSA private key.
openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr
If you have a configuration file, you can then use the following OpenSSL command. The usr_cert
block in the configuration file contains your X509 version 3 extensions.
openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr
Note: A CSR must provide either a subject name or a subject alternative name or the request will be rejected.
csr - The certificate signing request (CSR) for the certificate you want to issue. As an example, you can
use the following OpenSSL command to create the CSR and a 2048 bit RSA private key.
openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr
If you have a configuration file, you can then use the following OpenSSL command. The
usr_cert block in the configuration file contains your X509 version 3 extensions.
openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr
Note: A CSR must provide either a subject name or a subject alternative name or the request will be rejected.
IssueCertificateRequest.Builder signingAlgorithm(String signingAlgorithm)
The name of the algorithm that will be used to sign the certificate to be issued.
This parameter should not be confused with the SigningAlgorithm parameter used to sign a CSR in
the CreateCertificateAuthority action.
The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.
signingAlgorithm - The name of the algorithm that will be used to sign the certificate to be issued.
This parameter should not be confused with the SigningAlgorithm parameter used to sign a
CSR in the CreateCertificateAuthority action.
The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.
SigningAlgorithm,
SigningAlgorithmIssueCertificateRequest.Builder signingAlgorithm(SigningAlgorithm signingAlgorithm)
The name of the algorithm that will be used to sign the certificate to be issued.
This parameter should not be confused with the SigningAlgorithm parameter used to sign a CSR in
the CreateCertificateAuthority action.
The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.
signingAlgorithm - The name of the algorithm that will be used to sign the certificate to be issued.
This parameter should not be confused with the SigningAlgorithm parameter used to sign a
CSR in the CreateCertificateAuthority action.
The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.
SigningAlgorithm,
SigningAlgorithmIssueCertificateRequest.Builder templateArn(String templateArn)
Specifies a custom configuration template to use when issuing a certificate. If this parameter is not
provided, Amazon Web Services Private CA defaults to the EndEntityCertificate/V1 template. For
CA certificates, you should choose the shortest path length that meets your needs. The path length is
indicated by the PathLenN portion of the ARN, where N is the CA depth.
Note: The CA depth configured on a subordinate CA certificate must not exceed the limit set by its parents in the CA hierarchy.
For a list of TemplateArn values supported by Amazon Web Services Private CA, see Understanding Certificate
Templates.
templateArn - Specifies a custom configuration template to use when issuing a certificate. If this parameter is not
provided, Amazon Web Services Private CA defaults to the EndEntityCertificate/V1
template. For CA certificates, you should choose the shortest path length that meets your needs. The
path length is indicated by the PathLenN portion of the ARN, where N is the CA
depth.
Note: The CA depth configured on a subordinate CA certificate must not exceed the limit set by its parents in the CA hierarchy.
For a list of TemplateArn values supported by Amazon Web Services Private CA, see Understanding
Certificate Templates.
IssueCertificateRequest.Builder validity(Validity validity)
Information describing the end of the validity period of the certificate. This parameter sets the “Not After” date for the certificate.
Certificate validity is the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the certificate expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280.
This value is unaffected when ValidityNotBefore is also specified. For example, if
Validity is set to 20 days in the future, the certificate will expire 20 days from issuance time
regardless of the ValidityNotBefore value.
The end of the validity period configured on a certificate must not exceed the limit set on its parents in the CA hierarchy.
validity - Information describing the end of the validity period of the certificate. This parameter sets the “Not
After” date for the certificate.
Certificate validity is the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the certificate expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280.
This value is unaffected when ValidityNotBefore is also specified. For example, if
Validity is set to 20 days in the future, the certificate will expire 20 days from
issuance time regardless of the ValidityNotBefore value.
The end of the validity period configured on a certificate must not exceed the limit set on its parents in the CA hierarchy.
default IssueCertificateRequest.Builder validity(Consumer<Validity.Builder> validity)
Information describing the end of the validity period of the certificate. This parameter sets the “Not After” date for the certificate.
Certificate validity is the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the certificate expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280.
This value is unaffected when ValidityNotBefore is also specified. For example, if
Validity is set to 20 days in the future, the certificate will expire 20 days from issuance time
regardless of the ValidityNotBefore value.
The end of the validity period configured on a certificate must not exceed the limit set on its parents in the CA hierarchy.
This is a convenience method that creates an instance of theValidity.Builder avoiding the need to
create one manually via Validity.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result is
passed to validity(Validity).
validity - a consumer that will call methods on Validity.Buildervalidity(Validity)IssueCertificateRequest.Builder validityNotBefore(Validity validityNotBefore)
Information describing the start of the validity period of the certificate. This parameter sets the “Not Before" date for the certificate.
By default, when issuing a certificate, Amazon Web Services Private CA sets the "Not Before" date to the
issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The
ValidityNotBefore parameter can be used to customize the “Not Before” value.
Unlike the Validity parameter, the ValidityNotBefore parameter is optional.
The ValidityNotBefore value is expressed as an explicit date and time, using the
Validity type value ABSOLUTE. For more information, see Validity in this API
reference and Validity in RFC
5280.
validityNotBefore - Information describing the start of the validity period of the certificate. This parameter sets the
“Not Before" date for the certificate.
By default, when issuing a certificate, Amazon Web Services Private CA sets the "Not Before" date to
the issuance time minus 60 minutes. This compensates for clock inconsistencies across computer
systems. The ValidityNotBefore parameter can be used to customize the “Not Before” value.
Unlike the Validity parameter, the ValidityNotBefore parameter is optional.
The ValidityNotBefore value is expressed as an explicit date and time, using the
Validity type value ABSOLUTE. For more information, see Validity in
this API reference and Validity in RFC 5280.
default IssueCertificateRequest.Builder validityNotBefore(Consumer<Validity.Builder> validityNotBefore)
Information describing the start of the validity period of the certificate. This parameter sets the “Not Before" date for the certificate.
By default, when issuing a certificate, Amazon Web Services Private CA sets the "Not Before" date to the
issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The
ValidityNotBefore parameter can be used to customize the “Not Before” value.
Unlike the Validity parameter, the ValidityNotBefore parameter is optional.
The ValidityNotBefore value is expressed as an explicit date and time, using the
Validity type value ABSOLUTE. For more information, see Validity in this API
reference and Validity in RFC
5280.
Validity.Builder avoiding the need to
create one manually via Validity.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result is
passed to validityNotBefore(Validity).
validityNotBefore - a consumer that will call methods on Validity.BuildervalidityNotBefore(Validity)IssueCertificateRequest.Builder idempotencyToken(String idempotencyToken)
Alphanumeric string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens for IssueCertificate time out after one minute. Therefore, if you call IssueCertificate multiple times with the same idempotency token within one minute, Amazon Web Services Private CA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, Amazon Web Services Private CA recognizes that you are requesting multiple certificates.
idempotencyToken - Alphanumeric string that can be used to distinguish between calls to the IssueCertificate
action. Idempotency tokens for IssueCertificate time out after one minute. Therefore, if you
call IssueCertificate multiple times with the same idempotency token within one minute, Amazon
Web Services Private CA recognizes that you are requesting only one certificate and will issue only
one. If you change the idempotency token for each call, Amazon Web Services Private CA recognizes that
you are requesting multiple certificates.IssueCertificateRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderIssueCertificateRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.