Package software.amazon.awscdk.services.certificatemanager

Class PrivateCertificate.Builder

java.lang.Object

software.amazon.awscdk.services.certificatemanager.PrivateCertificate.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<PrivateCertificate>

Enclosing class:

PrivateCertificate

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

A fluent builder for PrivateCertificate.

Method Summary

Modifier and Type	Method	Description
PrivateCertificate	build()
PrivateCertificate.Builder	certificateAuthority(ICertificateAuthority certificateAuthority)	Private certificate authority (CA) that will be used to issue the certificate.
static PrivateCertificate.Builder	create(software.constructs.Construct scope, String id)
PrivateCertificate.Builder	domainName(String domainName)	Fully-qualified domain name to request a private certificate for.
PrivateCertificate.Builder	keyAlgorithm(KeyAlgorithm keyAlgorithm)	Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data.
PrivateCertificate.Builder	subjectAlternativeNames(List<String> subjectAlternativeNames)	Alternative domain names on your private 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 PrivateCertificate.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of PrivateCertificate.Builder.

certificateAuthority

@Stability(Stable)
public PrivateCertificate.Builder certificateAuthority(ICertificateAuthority certificateAuthority)

Private certificate authority (CA) that will be used to issue the certificate.

Parameters:

certificateAuthority - Private certificate authority (CA) that will be used to issue the certificate. This parameter is required.

Returns:

this

domainName

@Stability(Stable)
public PrivateCertificate.Builder domainName(String domainName)

Fully-qualified domain name to request a private certificate for.

May contain wildcards, such as *.domain.com.

Parameters:

domainName - Fully-qualified domain name to request a private certificate for. This parameter is required.

Returns:

this

keyAlgorithm

@Stability(Stable)
public PrivateCertificate.Builder keyAlgorithm(KeyAlgorithm keyAlgorithm)

Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data.

When you request a private PKI certificate signed by a CA from AWS Private CA, the specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.

Default: KeyAlgorithm.RSA_2048

Parameters:

keyAlgorithm - Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/acm/latest/userguide/acm-certificate.html#algorithms.title

subjectAlternativeNames

@Stability(Stable)
public PrivateCertificate.Builder subjectAlternativeNames(List<String> subjectAlternativeNames)

Alternative domain names on your private certificate.

Use this to register alternative domain names that represent the same site.

Default: - No additional FQDNs will be included as alternative domain names.

Parameters:

subjectAlternativeNames - Alternative domain names on your private certificate. This parameter is required.

Returns:

this

build

@Stability(Stable)
public PrivateCertificate build()

Specified by:

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

Returns:

a newly built instance of PrivateCertificate.