interface GeneralNameProperty

Language	Type name
.NET	`Amazon.CDK.AWS.ACMPCA.CfnCertificateAuthority.GeneralNameProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsacmpca#CfnCertificateAuthority_GeneralNameProperty`
Java	`software.amazon.awscdk.services.acmpca.CfnCertificateAuthority.GeneralNameProperty`
Python	`aws_cdk.aws_acmpca.CfnCertificateAuthority.GeneralNameProperty`
TypeScript	`aws-cdk-lib` » `aws_acmpca` » `CfnCertificateAuthority` » `GeneralNameProperty`

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 { aws_acmpca as acmpca } from 'aws-cdk-lib';
const generalNameProperty: acmpca.CfnCertificateAuthority.GeneralNameProperty = {
  directoryName: {
    commonName: 'commonName',
    country: 'country',
    customAttributes: [{
      objectIdentifier: 'objectIdentifier',
      value: 'value',
    }],
    distinguishedNameQualifier: 'distinguishedNameQualifier',
    generationQualifier: 'generationQualifier',
    givenName: 'givenName',
    initials: 'initials',
    locality: 'locality',
    organization: 'organization',
    organizationalUnit: 'organizationalUnit',
    pseudonym: 'pseudonym',
    serialNumber: 'serialNumber',
    state: 'state',
    surname: 'surname',
    title: 'title',
  },
  dnsName: 'dnsName',
  ediPartyName: {
    partyName: 'partyName',

    // the properties below are optional
    nameAssigner: 'nameAssigner',
  },
  ipAddress: 'ipAddress',
  otherName: {
    typeId: 'typeId',
    value: 'value',
  },
  registeredId: 'registeredId',
  rfc822Name: 'rfc822Name',
  uniformResourceIdentifier: 'uniformResourceIdentifier',
};

Properties

Name	Type	Description
directoryName?	`IResolvable` `\|` `SubjectProperty`	Contains information about the certificate subject.
dnsName?	`string`	Represents `GeneralName` as a DNS name.
ediPartyName?	`IResolvable` `\|` `EdiPartyNameProperty`	Represents `GeneralName` as an `EdiPartyName` object.
ipAddress?	`string`	Represents `GeneralName` as an IPv4 or IPv6 address.
otherName?	`IResolvable` `\|` `OtherNameProperty`	Represents `GeneralName` using an `OtherName` object.
registeredId?	`string`	Represents `GeneralName` as an object identifier (OID).
rfc822Name?	`string`	Represents `GeneralName` as an RFC 822 email address.
uniformResourceIdentifier?	`string`	Represents `GeneralName` as a URI.

directoryName?

Type: IResolvable | SubjectProperty (optional)

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.

dnsName?

Type: string (optional)

Represents GeneralName as a DNS name.

ediPartyName?

Type: IResolvable | EdiPartyNameProperty (optional)

Represents GeneralName as an EdiPartyName object.

ipAddress?

Type: string (optional)

Represents GeneralName as an IPv4 or IPv6 address.

otherName?

Type: IResolvable | OtherNameProperty (optional)

Represents GeneralName using an OtherName object.

registeredId?

Type: string (optional)

Represents GeneralName as an object identifier (OID).

rfc822Name?

Type: string (optional)

Represents GeneralName as an RFC 822 email address.

uniformResourceIdentifier?

Type: string (optional)

Represents GeneralName as a URI.