Package software.amazon.awscdk.services.certificatemanager

Interface PrivateCertificateProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

PrivateCertificateProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-24T21:00:26.446Z")
@Stability(Stable)
public interface PrivateCertificateProps
extends software.amazon.jsii.JsiiSerializable

Properties for your private certificate.

Example:

 import software.amazon.awscdk.services.acmpca.*;
 PrivateCertificate.Builder.create(this, "PrivateCertificate")
         .domainName("test.example.com")
         .subjectAlternativeNames(List.of("cool.example.com", "test.example.net")) // optional
         .certificateAuthority(CertificateAuthority.fromCertificateAuthorityArn(this, "CA", "arn:aws:acm-pca:us-east-1:123456789012:certificate-authority/023077d8-2bfa-4eb0-8f22-05c96deade77"))
         .keyAlgorithm(KeyAlgorithm.RSA_2048)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	PrivateCertificateProps.Builder	A builder for PrivateCertificateProps
static final class	PrivateCertificateProps.Jsii$Proxy	An implementation for PrivateCertificateProps

Method Summary

Modifier and Type	Method	Description
static PrivateCertificateProps.Builder	builder()
ICertificateAuthority	getCertificateAuthority()	Private certificate authority (CA) that will be used to issue the certificate.
String	getDomainName()	Fully-qualified domain name to request a private certificate for.
default KeyAlgorithm	getKeyAlgorithm()	Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data.
default List<String>	getSubjectAlternativeNames()	Alternative domain names on your private certificate.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCertificateAuthority

@Stability(Stable)
@NotNull
ICertificateAuthority getCertificateAuthority()

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

getDomainName

@Stability(Stable)
@NotNull
String getDomainName()

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

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

getKeyAlgorithm

@Stability(Stable)
@Nullable
default KeyAlgorithm getKeyAlgorithm()

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

See Also:

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

getSubjectAlternativeNames

@Stability(Stable)
@Nullable
default List<String> getSubjectAlternativeNames()

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.

builder

@Stability(Stable)
static PrivateCertificateProps.Builder builder()

Returns:

a PrivateCertificateProps.Builder of PrivateCertificateProps