software.amazon.awscdk.services.acmpca

Interface CfnCertificateProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCertificateProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:35.998Z")
 @Stability(value=Stable)
public interface CfnCertificateProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnCertificate`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.acmpca.*;
 CfnCertificateProps cfnCertificateProps = CfnCertificateProps.builder()
         .certificateAuthorityArn("certificateAuthorityArn")
         .certificateSigningRequest("certificateSigningRequest")
         .signingAlgorithm("signingAlgorithm")
         .validity(ValidityProperty.builder()
                 .type("type")
                 .value(123)
                 .build())
         // the properties below are optional
         .apiPassthrough(ApiPassthroughProperty.builder()
                 .extensions(ExtensionsProperty.builder()
                         .certificatePolicies(List.of(PolicyInformationProperty.builder()
                                 .certPolicyId("certPolicyId")
                                 // the properties below are optional
                                 .policyQualifiers(List.of(PolicyQualifierInfoProperty.builder()
                                         .policyQualifierId("policyQualifierId")
                                         .qualifier(QualifierProperty.builder()
                                                 .cpsUri("cpsUri")
                                                 .build())
                                         .build()))
                                 .build()))
                         .customExtensions(List.of(CustomExtensionProperty.builder()
                                 .objectIdentifier("objectIdentifier")
                                 .value("value")
                                 // the properties below are optional
                                 .critical(false)
                                 .build()))
                         .extendedKeyUsage(List.of(ExtendedKeyUsageProperty.builder()
                                 .extendedKeyUsageObjectIdentifier("extendedKeyUsageObjectIdentifier")
                                 .extendedKeyUsageType("extendedKeyUsageType")
                                 .build()))
                         .keyUsage(KeyUsageProperty.builder()
                                 .crlSign(false)
                                 .dataEncipherment(false)
                                 .decipherOnly(false)
                                 .digitalSignature(false)
                                 .encipherOnly(false)
                                 .keyAgreement(false)
                                 .keyCertSign(false)
                                 .keyEncipherment(false)
                                 .nonRepudiation(false)
                                 .build())
                         .subjectAlternativeNames(List.of(GeneralNameProperty.builder()
                                 .directoryName(SubjectProperty.builder()
                                         .commonName("commonName")
                                         .country("country")
                                         .customAttributes(List.of(CustomAttributeProperty.builder()
                                                 .objectIdentifier("objectIdentifier")
                                                 .value("value")
                                                 .build()))
                                         .distinguishedNameQualifier("distinguishedNameQualifier")
                                         .generationQualifier("generationQualifier")
                                         .givenName("givenName")
                                         .initials("initials")
                                         .locality("locality")
                                         .organization("organization")
                                         .organizationalUnit("organizationalUnit")
                                         .pseudonym("pseudonym")
                                         .serialNumber("serialNumber")
                                         .state("state")
                                         .surname("surname")
                                         .title("title")
                                         .build())
                                 .dnsName("dnsName")
                                 .ediPartyName(EdiPartyNameProperty.builder()
                                         .nameAssigner("nameAssigner")
                                         .partyName("partyName")
                                         .build())
                                 .ipAddress("ipAddress")
                                 .otherName(OtherNameProperty.builder()
                                         .typeId("typeId")
                                         .value("value")
                                         .build())
                                 .registeredId("registeredId")
                                 .rfc822Name("rfc822Name")
                                 .uniformResourceIdentifier("uniformResourceIdentifier")
                                 .build()))
                         .build())
                 .subject(SubjectProperty.builder()
                         .commonName("commonName")
                         .country("country")
                         .customAttributes(List.of(CustomAttributeProperty.builder()
                                 .objectIdentifier("objectIdentifier")
                                 .value("value")
                                 .build()))
                         .distinguishedNameQualifier("distinguishedNameQualifier")
                         .generationQualifier("generationQualifier")
                         .givenName("givenName")
                         .initials("initials")
                         .locality("locality")
                         .organization("organization")
                         .organizationalUnit("organizationalUnit")
                         .pseudonym("pseudonym")
                         .serialNumber("serialNumber")
                         .state("state")
                         .surname("surname")
                         .title("title")
                         .build())
                 .build())
         .templateArn("templateArn")
         .validityNotBefore(ValidityProperty.builder()
                 .type("type")
                 .value(123)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnCertificateProps.Builder	builder()
default Object	getApiPassthrough() Specifies X.509 certificate information to be included in the issued certificate.
String	getCertificateAuthorityArn() The Amazon Resource Name (ARN) for the private CA issues the certificate.
String	getCertificateSigningRequest() The certificate signing request (CSR) for the certificate.
String	getSigningAlgorithm() The name of the algorithm that will be used to sign the certificate to be issued.
default String	getTemplateArn() Specifies a custom configuration template to use when issuing a certificate.
Object	getValidity() The period of time during which the certificate will be valid.
default Object	getValidityNotBefore() Information describing the start of the validity period of the certificate.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCertificateAuthorityArn

@Stability(value=Stable)
 @NotNull
String getCertificateAuthorityArn()

The Amazon Resource Name (ARN) for the private CA issues the certificate.

getCertificateSigningRequest

@Stability(value=Stable)
 @NotNull
String getCertificateSigningRequest()

The certificate signing request (CSR) for the certificate.

getSigningAlgorithm

@Stability(value=Stable)
 @NotNull
String getSigningAlgorithm()

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.

getValidity

@Stability(value=Stable)
 @NotNull
Object getValidity()

The period of time during which the certificate will be valid.

getApiPassthrough

@Stability(value=Stable)
 @Nullable
default Object getApiPassthrough()

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.

getTemplateArn

@Stability(value=Stable)
 @Nullable
default String getTemplateArn()

Specifies a custom configuration template to use when issuing a certificate.

If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template. For more information about ACM Private CA templates, see Using Templates .

getValidityNotBefore

@Stability(value=Stable)
 @Nullable
default Object getValidityNotBefore()

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, ACM 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 .

builder

@Stability(value=Stable)
static CfnCertificateProps.Builder builder()

Returns:

a CfnCertificateProps.Builder of CfnCertificateProps