Package software.amazon.awscdk.services.acmpca

Interface CfnCertificate.ExtensionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCertificate.ExtensionsProperty.Jsii$Proxy

Enclosing class:

CfnCertificate

@Stability(Stable)
public static interface CfnCertificate.ExtensionsProperty
extends software.amazon.jsii.JsiiSerializable

Contains X.509 extension information for a certificate.

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.*;
 ExtensionsProperty extensionsProperty = 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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extensions.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnCertificate.ExtensionsProperty.Builder	builder()
default Object	getCertificatePolicies()	Contains a sequence of one or more policy information terms, each of which consists of an object identifier (OID) and optional qualifiers.
default Object	getCustomExtensions()	Contains a sequence of one or more X.509 extensions, each of which consists of an object identifier (OID), a base64-encoded value, and the critical flag.
default Object	getExtendedKeyUsage()	Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the KeyUsage extension.
default Object	getKeyUsage()	Defines one or more purposes for which the key contained in the certificate can be used.
default Object	getSubjectAlternativeNames()	The subject alternative name extension allows identities to be bound to the subject of the certificate.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCertificatePolicies

@Stability(Stable)
@Nullable
default Object getCertificatePolicies()

Contains a sequence of one or more policy information terms, each of which consists of an object identifier (OID) and optional qualifiers.

For more information, see NIST's definition of Object Identifier (OID) .

In an end-entity certificate, these terms indicate the policy under which the certificate was issued and the purposes for which it may be used. In a CA certificate, these terms limit the set of policies for certification paths that include this certificate.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extensions.html#cfn-acmpca-certificate-extensions-certificatepolicies

getCustomExtensions

@Stability(Stable)
@Nullable
default Object getCustomExtensions()

Contains a sequence of one or more X.509 extensions, each of which consists of an object identifier (OID), a base64-encoded value, and the critical flag. For more information, see the Global OID reference database..

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extensions.html#cfn-acmpca-certificate-extensions-customextensions

getExtendedKeyUsage

@Stability(Stable)
@Nullable
default Object getExtendedKeyUsage()

Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the KeyUsage extension.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extensions.html#cfn-acmpca-certificate-extensions-extendedkeyusage

getKeyUsage

@Stability(Stable)
@Nullable
default Object getKeyUsage()

Defines one or more purposes for which the key contained in the certificate can be used.

Default value for each option is false.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extensions.html#cfn-acmpca-certificate-extensions-keyusage

getSubjectAlternativeNames

@Stability(Stable)
@Nullable
default Object getSubjectAlternativeNames()

The subject alternative name extension allows identities to be bound to the subject of the certificate.

These identities may be included in addition to or in place of the identity in the subject field of the certificate.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extensions.html#cfn-acmpca-certificate-extensions-subjectalternativenames

builder

@Stability(Stable)
static CfnCertificate.ExtensionsProperty.Builder builder()

Returns:

a CfnCertificate.ExtensionsProperty.Builder of CfnCertificate.ExtensionsProperty