Package software.amazon.awscdk.services.acmpca

Interface CfnCertificateAuthority.GeneralNameProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCertificateAuthority.GeneralNameProperty.Jsii$Proxy

Enclosing class:

CfnCertificateAuthority

@Stability(Stable)
public static interface CfnCertificateAuthority.GeneralNameProperty
extends software.amazon.jsii.JsiiSerializable

Describes an ASN.1 X.400 GeneralName as defined in RFC 5280 . Only one of the following naming options should be provided. Providing more than one option results in an InvalidArgsException error.

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.*;
 GeneralNameProperty generalNameProperty = 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()
                 .partyName("partyName")
                 // the properties below are optional
                 .nameAssigner("nameAssigner")
                 .build())
         .ipAddress("ipAddress")
         .otherName(OtherNameProperty.builder()
                 .typeId("typeId")
                 .value("value")
                 .build())
         .registeredId("registeredId")
         .rfc822Name("rfc822Name")
         .uniformResourceIdentifier("uniformResourceIdentifier")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnCertificateAuthority.GeneralNameProperty.Builder	builder()
default Object	getDirectoryName()	Contains information about the certificate subject.
default String	getDnsName()	Represents GeneralName as a DNS name.
default Object	getEdiPartyName()	Represents GeneralName as an EdiPartyName object.
default String	getIpAddress()	Represents GeneralName as an IPv4 or IPv6 address.
default Object	getOtherName()	Represents GeneralName using an OtherName object.
default String	getRegisteredId()	Represents GeneralName as an object identifier (OID).
default String	getRfc822Name()	Represents GeneralName as an RFC 822 email address.
default String	getUniformResourceIdentifier()	Represents GeneralName as a URI.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDirectoryName

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

Contains information about the certificate subject.

The certificate can be one issued by your private certificate authority (CA) or it can be your private CA certificate. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate. The DN must be unique for each entity, but your private CA can issue more than one certificate with the same DN to the same entity.

Returns union: either IResolvable or CfnCertificateAuthority.SubjectProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-directoryname

getDnsName

@Stability(Stable)
@Nullable
default String getDnsName()

Represents GeneralName as a DNS name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-dnsname

getEdiPartyName

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

Represents GeneralName as an EdiPartyName object.

Returns union: either IResolvable or CfnCertificateAuthority.EdiPartyNameProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-edipartyname

getIpAddress

@Stability(Stable)
@Nullable
default String getIpAddress()

Represents GeneralName as an IPv4 or IPv6 address.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-ipaddress

getOtherName

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

Represents GeneralName using an OtherName object.

Returns union: either IResolvable or CfnCertificateAuthority.OtherNameProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-othername

getRegisteredId

@Stability(Stable)
@Nullable
default String getRegisteredId()

Represents GeneralName as an object identifier (OID).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-registeredid

getRfc822Name

@Stability(Stable)
@Nullable
default String getRfc822Name()

Represents GeneralName as an RFC 822 email address.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-rfc822name

getUniformResourceIdentifier

@Stability(Stable)
@Nullable
default String getUniformResourceIdentifier()

Represents GeneralName as a URI.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-uniformresourceidentifier

builder

@Stability(Stable)
static CfnCertificateAuthority.GeneralNameProperty.Builder builder()

Returns:

a CfnCertificateAuthority.GeneralNameProperty.Builder of CfnCertificateAuthority.GeneralNameProperty