Class CfnCertificate.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnCertificate>
- Enclosing class:
- CfnCertificate
CfnCertificate
.-
Method Summary
Modifier and TypeMethodDescriptionapiPassthrough
(IResolvable apiPassthrough) Specifies X.509 certificate information to be included in the issued certificate.apiPassthrough
(CfnCertificate.ApiPassthroughProperty apiPassthrough) Specifies X.509 certificate information to be included in the issued certificate.build()
certificateAuthorityArn
(String certificateAuthorityArn) The Amazon Resource Name (ARN) for the private CA issues the certificate.certificateSigningRequest
(String certificateSigningRequest) The certificate signing request (CSR) for the certificate.static CfnCertificate.Builder
signingAlgorithm
(String signingAlgorithm) The name of the algorithm that will be used to sign the certificate to be issued.templateArn
(String templateArn) Specifies a custom configuration template to use when issuing a certificate.validity
(IResolvable validity) The period of time during which the certificate will be valid.validity
(CfnCertificate.ValidityProperty validity) The period of time during which the certificate will be valid.validityNotBefore
(IResolvable validityNotBefore) Information describing the start of the validity period of the certificate.validityNotBefore
(CfnCertificate.ValidityProperty validityNotBefore) Information describing the start of the validity period of the certificate.
-
Method Details
-
create
- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
- Returns:
- a new instance of
CfnCertificate.Builder
.
-
certificateAuthorityArn
@Stability(Stable) public CfnCertificate.Builder certificateAuthorityArn(String certificateAuthorityArn) The Amazon Resource Name (ARN) for the private CA issues the certificate.- Parameters:
certificateAuthorityArn
- The Amazon Resource Name (ARN) for the private CA issues the certificate. This parameter is required.- Returns:
this
-
certificateSigningRequest
@Stability(Stable) public CfnCertificate.Builder certificateSigningRequest(String certificateSigningRequest) The certificate signing request (CSR) for the certificate.- Parameters:
certificateSigningRequest
- The certificate signing request (CSR) for the certificate. This parameter is required.- Returns:
this
-
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 theCreateCertificateAuthority
action.The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.
- Parameters:
signingAlgorithm
- The name of the algorithm that will be used to sign the certificate to be issued. This parameter is required.- Returns:
this
-
validity
The period of time during which the certificate will be valid.- Parameters:
validity
- The period of time during which the certificate will be valid. This parameter is required.- Returns:
this
-
validity
The period of time during which the certificate will be valid.- Parameters:
validity
- The period of time during which the certificate will be valid. This parameter is required.- Returns:
this
-
apiPassthrough
Specifies X.509 certificate information to be included in the issued certificate. AnAPIPassthrough
orAPICSRPassthrough
template variant must be selected, or else this parameter is ignored.- Parameters:
apiPassthrough
- Specifies X.509 certificate information to be included in the issued certificate. AnAPIPassthrough
orAPICSRPassthrough
template variant must be selected, or else this parameter is ignored. This parameter is required.- Returns:
this
-
apiPassthrough
@Stability(Stable) public CfnCertificate.Builder apiPassthrough(CfnCertificate.ApiPassthroughProperty apiPassthrough) Specifies X.509 certificate information to be included in the issued certificate. AnAPIPassthrough
orAPICSRPassthrough
template variant must be selected, or else this parameter is ignored.- Parameters:
apiPassthrough
- Specifies X.509 certificate information to be included in the issued certificate. AnAPIPassthrough
orAPICSRPassthrough
template variant must be selected, or else this parameter is ignored. This parameter is required.- Returns:
this
-
templateArn
Specifies a custom configuration template to use when issuing a certificate.If this parameter is not provided, AWS Private CA defaults to the
EndEntityCertificate/V1
template. For more information about AWS Private CA templates, see Using Templates .- Parameters:
templateArn
- Specifies a custom configuration template to use when issuing a certificate. This parameter is required.- Returns:
this
-
validityNotBefore
@Stability(Stable) public CfnCertificate.Builder validityNotBefore(CfnCertificate.ValidityProperty 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, AWS 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, theValidityNotBefore
parameter is optional.The
ValidityNotBefore
value is expressed as an explicit date and time, using theValidity
type valueABSOLUTE
.- Parameters:
validityNotBefore
- Information describing the start of the validity period of the certificate. This parameter is required.- Returns:
this
-
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, AWS 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, theValidityNotBefore
parameter is optional.The
ValidityNotBefore
value is expressed as an explicit date and time, using theValidity
type valueABSOLUTE
.- Parameters:
validityNotBefore
- Information describing the start of the validity period of the certificate. This parameter is required.- Returns:
this
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnCertificate>
- Returns:
- a newly built instance of
CfnCertificate
.
-