Package software.amazon.awscdk.services.acmpca

Class CfnCertificate.Builder

java.lang.Object

software.amazon.awscdk.services.acmpca.CfnCertificate.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCertificate>

Enclosing class:

CfnCertificate

@Stability(Stable)
public static final class CfnCertificate.Builder
extends Object
implements software.amazon.jsii.Builder<CfnCertificate>

A fluent builder for CfnCertificate.

Method Summary

Modifier and Type	Method	Description
CfnCertificate.Builder	apiPassthrough(IResolvable apiPassthrough)	Specifies X.509 certificate information to be included in the issued certificate.
CfnCertificate.Builder	apiPassthrough(CfnCertificate.ApiPassthroughProperty apiPassthrough)	Specifies X.509 certificate information to be included in the issued certificate.
CfnCertificate	build()
CfnCertificate.Builder	certificateAuthorityArn(String certificateAuthorityArn)	The Amazon Resource Name (ARN) for the private CA issues the certificate.
CfnCertificate.Builder	certificateSigningRequest(String certificateSigningRequest)	The certificate signing request (CSR) for the certificate.
static CfnCertificate.Builder	create(software.constructs.Construct scope, String id)
CfnCertificate.Builder	signingAlgorithm(String signingAlgorithm)	The name of the algorithm that will be used to sign the certificate to be issued.
CfnCertificate.Builder	templateArn(String templateArn)	Specifies a custom configuration template to use when issuing a certificate.
CfnCertificate.Builder	validity(IResolvable validity)	The period of time during which the certificate will be valid.
CfnCertificate.Builder	validity(CfnCertificate.ValidityProperty validity)	The period of time during which the certificate will be valid.
CfnCertificate.Builder	validityNotBefore(IResolvable validityNotBefore)	Information describing the start of the validity period of the certificate.
CfnCertificate.Builder	validityNotBefore(CfnCertificate.ValidityProperty validityNotBefore)	Information describing the start of the validity period of the certificate.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnCertificate.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-certificateauthorityarn

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-certificatesigningrequest

signingAlgorithm

@Stability(Stable)
public CfnCertificate.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.

Parameters:

signingAlgorithm - The name of the algorithm that will be used to sign the certificate to be issued. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-signingalgorithm

validity

@Stability(Stable)
public CfnCertificate.Builder validity(IResolvable 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-validity

validity

@Stability(Stable)
public CfnCertificate.Builder validity(CfnCertificate.ValidityProperty 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-validity

apiPassthrough

@Stability(Stable)
public CfnCertificate.Builder apiPassthrough(IResolvable 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.

Parameters:

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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-apipassthrough

apiPassthrough

@Stability(Stable)
public CfnCertificate.Builder apiPassthrough(CfnCertificate.ApiPassthroughProperty 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.

Parameters:

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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-apipassthrough

templateArn

@Stability(Stable)
public CfnCertificate.Builder templateArn(String 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-templatearn

validityNotBefore

@Stability(Stable)
public CfnCertificate.Builder validityNotBefore(IResolvable 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, the ValidityNotBefore parameter is optional.

The ValidityNotBefore value is expressed as an explicit date and time, using the Validity type value ABSOLUTE .

Parameters:

validityNotBefore - Information describing the start of the validity period of the certificate. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-validitynotbefore

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, the ValidityNotBefore parameter is optional.

The ValidityNotBefore value is expressed as an explicit date and time, using the Validity type value ABSOLUTE .

Parameters:

validityNotBefore - Information describing the start of the validity period of the certificate. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-validitynotbefore

build

@Stability(Stable)
public CfnCertificate build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnCertificate>

Returns:

a newly built instance of CfnCertificate.