Package software.amazon.awscdk.services.acmpca

Interface CfnCertificate.SubjectProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCertificate.SubjectProperty.Jsii$Proxy

Enclosing class:

CfnCertificate

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

Contains information about the certificate subject.

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.

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.*;
 SubjectProperty subjectProperty = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnCertificate.SubjectProperty.Builder	builder()
default String	getCommonName()	For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit.
default String	getCountry()	Two-digit code that specifies the country in which the certificate subject located.
default Object	getCustomAttributes()	Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of which consists of an object identifier (OID) and a value.
default String	getDistinguishedNameQualifier()	Disambiguating information for the certificate subject.
default String	getGenerationQualifier()	Typically a qualifier appended to the name of an individual.
default String	getGivenName()	First name.
default String	getInitials()	Concatenation that typically contains the first letter of the GivenName , the first letter of the middle name if one exists, and the first letter of the Surname .
default String	getLocality()	The locality (such as a city or town) in which the certificate subject is located.
default String	getOrganization()	Legal name of the organization with which the certificate subject is affiliated.
default String	getOrganizationalUnit()	A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.
default String	getPseudonym()	Typically a shortened version of a longer GivenName .
default String	getSerialNumber()	The certificate serial number.
default String	getState()	State in which the subject of the certificate is located.
default String	getSurname()	Family name.
default String	getTitle()	A title such as Mr.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCommonName

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

For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit.

Note: In publicly trusted certificates, the common name must be a fully qualified domain name (FQDN) associated with the certificate subject.

See Also:

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

getCountry

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

Two-digit code that specifies the country in which the certificate subject located.

See Also:

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

getCustomAttributes

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

Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of which consists of an object identifier (OID) and a value. For more information, see NIST’s definition of Object Identifier (OID) .

Custom attributes cannot be used in combination with standard attributes.

See Also:

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

getDistinguishedNameQualifier

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

Disambiguating information for the certificate subject.

See Also:

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

getGenerationQualifier

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

Typically a qualifier appended to the name of an individual.

Examples include Jr. for junior, Sr. for senior, and III for third.

See Also:

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

getGivenName

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

First name.

See Also:

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

getInitials

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

Concatenation that typically contains the first letter of the GivenName , the first letter of the middle name if one exists, and the first letter of the Surname .

See Also:

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

getLocality

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

The locality (such as a city or town) in which the certificate subject is located.

See Also:

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

getOrganization

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

Legal name of the organization with which the certificate subject is affiliated.

See Also:

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

getOrganizationalUnit

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

A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.

See Also:

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

getPseudonym

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

Typically a shortened version of a longer GivenName .

For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza.

See Also:

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

getSerialNumber

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

The certificate serial number.

See Also:

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

getState

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

State in which the subject of the certificate is located.

See Also:

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

getSurname

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

Family name.

In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first.

See Also:

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

getTitle

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

A title such as Mr.

or Ms., which is pre-pended to the name to refer formally to the certificate subject.

See Also:

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

builder

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

Returns:

a CfnCertificate.SubjectProperty.Builder of CfnCertificate.SubjectProperty