Package software.amazon.awscdk.cfnpropertymixins.services.acmpca

Class CfnCertificatePropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.acmpca.CfnCertificatePropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCertificatePropsMixin>

Enclosing class:

CfnCertificatePropsMixin

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

A fluent builder for CfnCertificatePropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnCertificatePropsMixin.Builder	apiPassthrough(CfnCertificatePropsMixin.ApiPassthroughProperty apiPassthrough)	Specifies X.509 certificate information to be included in the issued certificate.
CfnCertificatePropsMixin.Builder	apiPassthrough(IResolvable apiPassthrough)	Specifies X.509 certificate information to be included in the issued certificate.
CfnCertificatePropsMixin	build()
CfnCertificatePropsMixin.Builder	certificateAuthorityArn(String certificateAuthorityArn)	The Amazon Resource Name (ARN) for the private CA issues the certificate.
CfnCertificatePropsMixin.Builder	certificateAuthorityArn(ICertificateAuthorityRef certificateAuthorityArn)	The Amazon Resource Name (ARN) for the private CA issues the certificate.
CfnCertificatePropsMixin.Builder	certificateSigningRequest(String certificateSigningRequest)	The certificate signing request (CSR) for the certificate.
static CfnCertificatePropsMixin.Builder	create()
static CfnCertificatePropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnCertificatePropsMixin.Builder	signingAlgorithm(String signingAlgorithm)	The name of the algorithm that will be used to sign the certificate to be issued.
CfnCertificatePropsMixin.Builder	templateArn(String templateArn)	Specifies a custom configuration template to use when issuing a certificate.
CfnCertificatePropsMixin.Builder	templateArn(ICertificateAuthorityRef templateArn)	Specifies a custom configuration template to use when issuing a certificate.
CfnCertificatePropsMixin.Builder	validity(CfnCertificatePropsMixin.ValidityProperty validity)	The period of time during which the certificate will be valid.
CfnCertificatePropsMixin.Builder	validity(IResolvable validity)	The period of time during which the certificate will be valid.
CfnCertificatePropsMixin.Builder	validityNotBefore(CfnCertificatePropsMixin.ValidityProperty validityNotBefore)	Information describing the start of the validity period of the certificate.
CfnCertificatePropsMixin.Builder	validityNotBefore(IResolvable 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 CfnCertificatePropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnCertificatePropsMixin.Builder.

create

@Stability(Stable)
public static CfnCertificatePropsMixin.Builder create()

Returns:

a new instance of CfnCertificatePropsMixin.Builder.

apiPassthrough

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

certificateAuthorityArn

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

certificateAuthorityArn

@Stability(Stable)
public CfnCertificatePropsMixin.Builder certificateAuthorityArn(ICertificateAuthorityRef 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 CfnCertificatePropsMixin.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 CfnCertificatePropsMixin.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

templateArn

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

templateArn

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

validity

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

validityNotBefore

@Stability(Stable)
public CfnCertificatePropsMixin.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 CfnCertificatePropsMixin.Builder validityNotBefore(CfnCertificatePropsMixin.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 CfnCertificatePropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnCertificatePropsMixin.