Amazonka.CertificateManagerPCA.Types.ASN1Subject

Documentation

data ASN1Subject

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.

See: newASN1Subject smart constructor.

Constructors

ASN1Subject'

Fields

• commonName :: Maybe Text

  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.

• country :: Maybe Text

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

• customAttributes :: Maybe (NonEmpty CustomAttribute)

  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.

• distinguishedNameQualifier :: Maybe Text

  Disambiguating information for the certificate subject.

• generationQualifier :: Maybe Text

  Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.

• givenName :: Maybe Text

  First name.

• initials :: Maybe Text

  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.

• locality :: Maybe Text

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

• organization :: Maybe Text

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

• organizationalUnit :: Maybe Text

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

• pseudonym :: Maybe Text

  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.

• serialNumber :: Maybe Text

  The certificate serial number.

• state :: Maybe Text

  State in which the subject of the certificate is located.

• surname :: Maybe Text

  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.

• title :: Maybe Text

  A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.

Instances

FromJSON ASN1Subject

Defined in Amazonka.CertificateManagerPCA.Types.ASN1Subject

Methods

parseJSON :: Value -> Parser ASN1Subject

parseJSONList :: Value -> Parser [ASN1Subject]

ToJSON ASN1Subject

Defined in Amazonka.CertificateManagerPCA.Types.ASN1Subject

Methods

toJSON :: ASN1Subject -> Value

toEncoding :: ASN1Subject -> Encoding

toJSONList :: [ASN1Subject] -> Value

toEncodingList :: [ASN1Subject] -> Encoding

Generic ASN1Subject

Defined in Amazonka.CertificateManagerPCA.Types.ASN1Subject

Associated Types

type Rep ASN1Subject :: Type -> Type

Methods

from :: ASN1Subject -> Rep ASN1Subject x

to :: Rep ASN1Subject x -> ASN1Subject

Read ASN1Subject

Defined in Amazonka.CertificateManagerPCA.Types.ASN1Subject

Methods

readsPrec :: Int -> ReadS ASN1Subject

readList :: ReadS [ASN1Subject]

readPrec :: ReadPrec ASN1Subject

readListPrec :: ReadPrec [ASN1Subject]

Show ASN1Subject

Defined in Amazonka.CertificateManagerPCA.Types.ASN1Subject

Methods

showsPrec :: Int -> ASN1Subject -> ShowS

show :: ASN1Subject -> String

showList :: [ASN1Subject] -> ShowS

NFData ASN1Subject

Defined in Amazonka.CertificateManagerPCA.Types.ASN1Subject

Methods

rnf :: ASN1Subject -> ()

Eq ASN1Subject

Defined in Amazonka.CertificateManagerPCA.Types.ASN1Subject

Methods

(==) :: ASN1Subject -> ASN1Subject -> Bool

(/=) :: ASN1Subject -> ASN1Subject -> Bool

Hashable ASN1Subject

Defined in Amazonka.CertificateManagerPCA.Types.ASN1Subject

Methods

hashWithSalt :: Int -> ASN1Subject -> Int

hash :: ASN1Subject -> Int

type Rep ASN1Subject

Defined in Amazonka.CertificateManagerPCA.Types.ASN1Subject

type Rep ASN1Subject = D1 ('MetaData "ASN1Subject" "Amazonka.CertificateManagerPCA.Types.ASN1Subject" "amazonka-certificatemanager-pca-2.0-BrCc8DEClV63rMSVXz2XYH" 'False) (C1 ('MetaCons "ASN1Subject'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "commonName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "country") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "customAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty CustomAttribute))))) :*: ((S1 ('MetaSel ('Just "distinguishedNameQualifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "generationQualifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "givenName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "initials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "locality") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "organization") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "organizationalUnit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "pseudonym") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "serialNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "surname") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newASN1Subject :: ASN1Subject

Create a value of ASN1Subject with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:commonName:ASN1Subject', aSN1Subject_commonName - 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.

$sel:country:ASN1Subject', aSN1Subject_country - Two-digit code that specifies the country in which the certificate subject located.

$sel:customAttributes:ASN1Subject', aSN1Subject_customAttributes - 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.

$sel:distinguishedNameQualifier:ASN1Subject', aSN1Subject_distinguishedNameQualifier - Disambiguating information for the certificate subject.

$sel:generationQualifier:ASN1Subject', aSN1Subject_generationQualifier - Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.

$sel:givenName:ASN1Subject', aSN1Subject_givenName - First name.

$sel:initials:ASN1Subject', aSN1Subject_initials - 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.

$sel:locality:ASN1Subject', aSN1Subject_locality - The locality (such as a city or town) in which the certificate subject is located.

$sel:organization:ASN1Subject', aSN1Subject_organization - Legal name of the organization with which the certificate subject is affiliated.

$sel:organizationalUnit:ASN1Subject', aSN1Subject_organizationalUnit - A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.

$sel:pseudonym:ASN1Subject', aSN1Subject_pseudonym - 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.

$sel:serialNumber:ASN1Subject', aSN1Subject_serialNumber - The certificate serial number.

$sel:state:ASN1Subject', aSN1Subject_state - State in which the subject of the certificate is located.

$sel:surname:ASN1Subject', aSN1Subject_surname - 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.

$sel:title:ASN1Subject', aSN1Subject_title - A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.

aSN1Subject_commonName :: Lens' ASN1Subject (Maybe Text)

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.

aSN1Subject_country :: Lens' ASN1Subject (Maybe Text)

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

aSN1Subject_customAttributes :: Lens' ASN1Subject (Maybe (NonEmpty CustomAttribute))

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.

aSN1Subject_distinguishedNameQualifier :: Lens' ASN1Subject (Maybe Text)

Disambiguating information for the certificate subject.

aSN1Subject_generationQualifier :: Lens' ASN1Subject (Maybe Text)

Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.

aSN1Subject_givenName :: Lens' ASN1Subject (Maybe Text)

First name.

aSN1Subject_initials :: Lens' ASN1Subject (Maybe Text)

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.

aSN1Subject_locality :: Lens' ASN1Subject (Maybe Text)

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

aSN1Subject_organization :: Lens' ASN1Subject (Maybe Text)

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

aSN1Subject_organizationalUnit :: Lens' ASN1Subject (Maybe Text)

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

aSN1Subject_pseudonym :: Lens' ASN1Subject (Maybe Text)

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.

aSN1Subject_serialNumber :: Lens' ASN1Subject (Maybe Text)

The certificate serial number.

aSN1Subject_state :: Lens' ASN1Subject (Maybe Text)

State in which the subject of the certificate is located.

aSN1Subject_surname :: Lens' ASN1Subject (Maybe Text)

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.

aSN1Subject_title :: Lens' ASN1Subject (Maybe Text)

A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.