You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ACMPCA::Types::ASN1Subject

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb

Overview

Note:

When making an API call, you may pass ASN1Subject data as a hash:

{
  country: "CountryCodeString",
  organization: "String64",
  organizational_unit: "String64",
  distinguished_name_qualifier: "DistinguishedNameQualifierString",
  state: "String128",
  common_name: "String64",
  serial_number: "String64",
  locality: "String128",
  title: "String64",
  surname: "String40",
  given_name: "String16",
  initials: "String5",
  pseudonym: "String128",
  generation_qualifier: "String3",
}

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.

Instance Attribute Summary collapse

Instance Attribute Details

#common_nameString

Fully qualified domain name (FQDN) associated with the certificate subject.

Returns:

  • (String)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 113

class ASN1Subject < Struct.new(
  :country,
  :organization,
  :organizational_unit,
  :distinguished_name_qualifier,
  :state,
  :common_name,
  :serial_number,
  :locality,
  :title,
  :surname,
  :given_name,
  :initials,
  :pseudonym,
  :generation_qualifier)
  include Aws::Structure
end

#countryString

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

Returns:

  • (String)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 113

class ASN1Subject < Struct.new(
  :country,
  :organization,
  :organizational_unit,
  :distinguished_name_qualifier,
  :state,
  :common_name,
  :serial_number,
  :locality,
  :title,
  :surname,
  :given_name,
  :initials,
  :pseudonym,
  :generation_qualifier)
  include Aws::Structure
end

#distinguished_name_qualifierString

Disambiguating information for the certificate subject.

Returns:

  • (String)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 113

class ASN1Subject < Struct.new(
  :country,
  :organization,
  :organizational_unit,
  :distinguished_name_qualifier,
  :state,
  :common_name,
  :serial_number,
  :locality,
  :title,
  :surname,
  :given_name,
  :initials,
  :pseudonym,
  :generation_qualifier)
  include Aws::Structure
end

#generation_qualifierString

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

Returns:

  • (String)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 113

class ASN1Subject < Struct.new(
  :country,
  :organization,
  :organizational_unit,
  :distinguished_name_qualifier,
  :state,
  :common_name,
  :serial_number,
  :locality,
  :title,
  :surname,
  :given_name,
  :initials,
  :pseudonym,
  :generation_qualifier)
  include Aws::Structure
end

#given_nameString

First name.

Returns:

  • (String)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 113

class ASN1Subject < Struct.new(
  :country,
  :organization,
  :organizational_unit,
  :distinguished_name_qualifier,
  :state,
  :common_name,
  :serial_number,
  :locality,
  :title,
  :surname,
  :given_name,
  :initials,
  :pseudonym,
  :generation_qualifier)
  include Aws::Structure
end

#initialsString

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.

Returns:

  • (String)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 113

class ASN1Subject < Struct.new(
  :country,
  :organization,
  :organizational_unit,
  :distinguished_name_qualifier,
  :state,
  :common_name,
  :serial_number,
  :locality,
  :title,
  :surname,
  :given_name,
  :initials,
  :pseudonym,
  :generation_qualifier)
  include Aws::Structure
end

#localityString

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

Returns:

  • (String)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 113

class ASN1Subject < Struct.new(
  :country,
  :organization,
  :organizational_unit,
  :distinguished_name_qualifier,
  :state,
  :common_name,
  :serial_number,
  :locality,
  :title,
  :surname,
  :given_name,
  :initials,
  :pseudonym,
  :generation_qualifier)
  include Aws::Structure
end

#organizationString

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

Returns:

  • (String)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 113

class ASN1Subject < Struct.new(
  :country,
  :organization,
  :organizational_unit,
  :distinguished_name_qualifier,
  :state,
  :common_name,
  :serial_number,
  :locality,
  :title,
  :surname,
  :given_name,
  :initials,
  :pseudonym,
  :generation_qualifier)
  include Aws::Structure
end

#organizational_unitString

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

Returns:

  • (String)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 113

class ASN1Subject < Struct.new(
  :country,
  :organization,
  :organizational_unit,
  :distinguished_name_qualifier,
  :state,
  :common_name,
  :serial_number,
  :locality,
  :title,
  :surname,
  :given_name,
  :initials,
  :pseudonym,
  :generation_qualifier)
  include Aws::Structure
end

#pseudonymString

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.

Returns:

  • (String)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 113

class ASN1Subject < Struct.new(
  :country,
  :organization,
  :organizational_unit,
  :distinguished_name_qualifier,
  :state,
  :common_name,
  :serial_number,
  :locality,
  :title,
  :surname,
  :given_name,
  :initials,
  :pseudonym,
  :generation_qualifier)
  include Aws::Structure
end

#serial_numberString

The certificate serial number.

Returns:

  • (String)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 113

class ASN1Subject < Struct.new(
  :country,
  :organization,
  :organizational_unit,
  :distinguished_name_qualifier,
  :state,
  :common_name,
  :serial_number,
  :locality,
  :title,
  :surname,
  :given_name,
  :initials,
  :pseudonym,
  :generation_qualifier)
  include Aws::Structure
end

#stateString

State in which the subject of the certificate is located.

Returns:

  • (String)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 113

class ASN1Subject < Struct.new(
  :country,
  :organization,
  :organizational_unit,
  :distinguished_name_qualifier,
  :state,
  :common_name,
  :serial_number,
  :locality,
  :title,
  :surname,
  :given_name,
  :initials,
  :pseudonym,
  :generation_qualifier)
  include Aws::Structure
end

#surnameString

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.

Returns:

  • (String)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 113

class ASN1Subject < Struct.new(
  :country,
  :organization,
  :organizational_unit,
  :distinguished_name_qualifier,
  :state,
  :common_name,
  :serial_number,
  :locality,
  :title,
  :surname,
  :given_name,
  :initials,
  :pseudonym,
  :generation_qualifier)
  include Aws::Structure
end

#titleString

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

Returns:

  • (String)


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 113

class ASN1Subject < Struct.new(
  :country,
  :organization,
  :organizational_unit,
  :distinguished_name_qualifier,
  :state,
  :common_name,
  :serial_number,
  :locality,
  :title,
  :surname,
  :given_name,
  :initials,
  :pseudonym,
  :generation_qualifier)
  include Aws::Structure
end