Class: AWSCDK::ACMPCA::CfnCertificateAuthority::SubjectProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
acmpca/cfn_certificate_authority.rb

Overview

ASN1 subject for the certificate authority.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(common_name: nil, country: nil, custom_attributes: nil, distinguished_name_qualifier: nil, generation_qualifier: nil, given_name: nil, initials: nil, locality: nil, organization: nil, organizational_unit: nil, pseudonym: nil, serial_number: nil, state: nil, surname: nil, title: nil) ⇒ SubjectProperty

Returns a new instance of SubjectProperty.

Parameters:

  • common_name (String, nil) (defaults to: nil) —

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

  • country (String, nil) (defaults to: nil) —

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

  • custom_attributes (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::ACMPCA::CfnCertificateAuthority::CustomAttributeProperty>, nil) (defaults to: nil) —

    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) .

  • distinguished_name_qualifier (String, nil) (defaults to: nil) —

    Disambiguating information for the certificate subject.

  • generation_qualifier (String, nil) (defaults to: nil) —

    Typically a qualifier appended to the name of an individual.

  • given_name (String, nil) (defaults to: nil) —

    First name.

  • initials (String, nil) (defaults to: nil) —

    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 (String, nil) (defaults to: nil) —

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

  • organization (String, nil) (defaults to: nil) —

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

  • organizational_unit (String, nil) (defaults to: nil) —

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

  • pseudonym (String, nil) (defaults to: nil) —

    Typically a shortened version of a longer GivenName.

  • serial_number (String, nil) (defaults to: nil) —

    The certificate serial number.

  • state (String, nil) (defaults to: nil) —

    State in which the subject of the certificate is located.

  • surname (String, nil) (defaults to: nil) —

    Family name.

  • title (String, nil) (defaults to: nil) —

    A personal title such as Mr.



1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
 
# File 'acmpca/cfn_certificate_authority.rb', line 1446

def initialize(common_name: nil, country: nil, custom_attributes: nil, distinguished_name_qualifier: nil, generation_qualifier: nil, given_name: nil, initials: nil, locality: nil, organization: nil, organizational_unit: nil, pseudonym: nil, serial_number: nil, state: nil, surname: nil, title: nil)
  @common_name = common_name
  Jsii::Type.check_type(@common_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "commonName") unless @common_name.nil?
  @country = country
  Jsii::Type.check_type(@country, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "country") unless @country.nil?
  @custom_attributes = custom_attributes
  Jsii::Type.check_type(@custom_attributes, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYWNtcGNhLkNmbkNlcnRpZmljYXRlQXV0aG9yaXR5LkN1c3RvbUF0dHJpYnV0ZVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "customAttributes") unless @custom_attributes.nil?
  @distinguished_name_qualifier = distinguished_name_qualifier
  Jsii::Type.check_type(@distinguished_name_qualifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "distinguishedNameQualifier") unless @distinguished_name_qualifier.nil?
  @generation_qualifier = generation_qualifier
  Jsii::Type.check_type(@generation_qualifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "generationQualifier") unless @generation_qualifier.nil?
  @given_name = given_name
  Jsii::Type.check_type(@given_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "givenName") unless @given_name.nil?
  @initials = initials
  Jsii::Type.check_type(@initials, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "initials") unless @initials.nil?
  @locality = locality
  Jsii::Type.check_type(@locality, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "locality") unless @locality.nil?
  @organization = organization
  Jsii::Type.check_type(@organization, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "organization") unless @organization.nil?
  @organizational_unit = organizational_unit
  Jsii::Type.check_type(@organizational_unit, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "organizationalUnit") unless @organizational_unit.nil?
  @pseudonym = pseudonym
  Jsii::Type.check_type(@pseudonym, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pseudonym") unless @pseudonym.nil?
  @serial_number = serial_number
  Jsii::Type.check_type(@serial_number, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serialNumber") unless @serial_number.nil?
  @state = state
  Jsii::Type.check_type(@state, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "state") unless @state.nil?
  @surname = surname
  Jsii::Type.check_type(@surname, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "surname") unless @surname.nil?
  @title = title
  Jsii::Type.check_type(@title, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "title") unless @title.nil?
end

Instance Attribute Details

#common_name ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



1483
1484
1485
 
# File 'acmpca/cfn_certificate_authority.rb', line 1483

def common_name
  @common_name
end

#country ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



1488
1489
1490
 
# File 'acmpca/cfn_certificate_authority.rb', line 1488

def country
  @country
end

#custom_attributes ⇒ AWSCDK::IResolvable, ... (readonly)

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.

Returns:

See Also:



1495
1496
1497
 
# File 'acmpca/cfn_certificate_authority.rb', line 1495

def custom_attributes
  @custom_attributes
end

#distinguished_name_qualifier ⇒ String? (readonly)

Disambiguating information for the certificate subject.

Returns:

  • (String, nil)

See Also:



1500
1501
1502
 
# File 'acmpca/cfn_certificate_authority.rb', line 1500

def distinguished_name_qualifier
  @distinguished_name_qualifier
end

#generation_qualifier ⇒ String? (readonly)

Typically a qualifier appended to the name of an individual.

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

Returns:

  • (String, nil)

See Also:



1507
1508
1509
 
# File 'acmpca/cfn_certificate_authority.rb', line 1507

def generation_qualifier
  @generation_qualifier
end

#given_name ⇒ String? (readonly)

First name.

Returns:

  • (String, nil)

See Also:



1512
1513
1514
 
# File 'acmpca/cfn_certificate_authority.rb', line 1512

def given_name
  @given_name
end

#initials ⇒ String? (readonly)

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, nil)

See Also:



1517
1518
1519
 
# File 'acmpca/cfn_certificate_authority.rb', line 1517

def initials
  @initials
end

#locality ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



1522
1523
1524
 
# File 'acmpca/cfn_certificate_authority.rb', line 1522

def locality
  @locality
end

#organization ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



1527
1528
1529
 
# File 'acmpca/cfn_certificate_authority.rb', line 1527

def organization
  @organization
end

#organizational_unit ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



1532
1533
1534
 
# File 'acmpca/cfn_certificate_authority.rb', line 1532

def organizational_unit
  @organizational_unit
end

#pseudonym ⇒ String? (readonly)

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, nil)

See Also:



1539
1540
1541
 
# File 'acmpca/cfn_certificate_authority.rb', line 1539

def pseudonym
  @pseudonym
end

#serial_number ⇒ String? (readonly)

The certificate serial number.

Returns:

  • (String, nil)

See Also:



1544
1545
1546
 
# File 'acmpca/cfn_certificate_authority.rb', line 1544

def serial_number
  @serial_number
end

#state ⇒ String? (readonly)

State in which the subject of the certificate is located.

Returns:

  • (String, nil)

See Also:



1549
1550
1551
 
# File 'acmpca/cfn_certificate_authority.rb', line 1549

def state
  @state
end

#surname ⇒ String? (readonly)

Family name.

Returns:

  • (String, nil)

See Also:



1554
1555
1556
 
# File 'acmpca/cfn_certificate_authority.rb', line 1554

def surname
  @surname
end

#title ⇒ String? (readonly)

A personal title such as Mr.

Returns:

  • (String, nil)

See Also:



1559
1560
1561
 
# File 'acmpca/cfn_certificate_authority.rb', line 1559

def title
  @title
end

Class Method Details

.jsii_properties ⇒ Object 



1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
 
# File 'acmpca/cfn_certificate_authority.rb', line 1561

def self.jsii_properties
  {
    :common_name => "commonName",
    :country => "country",
    :custom_attributes => "customAttributes",
    :distinguished_name_qualifier => "distinguishedNameQualifier",
    :generation_qualifier => "generationQualifier",
    :given_name => "givenName",
    :initials => "initials",
    :locality => "locality",
    :organization => "organization",
    :organizational_unit => "organizationalUnit",
    :pseudonym => "pseudonym",
    :serial_number => "serialNumber",
    :state => "state",
    :surname => "surname",
    :title => "title",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
 
# File 'acmpca/cfn_certificate_authority.rb', line 1581

def to_jsii
  result = {}
  result.merge!({
    "commonName" => @common_name,
    "country" => @country,
    "customAttributes" => @custom_attributes,
    "distinguishedNameQualifier" => @distinguished_name_qualifier,
    "generationQualifier" => @generation_qualifier,
    "givenName" => @given_name,
    "initials" => @initials,
    "locality" => @locality,
    "organization" => @organization,
    "organizationalUnit" => @organizational_unit,
    "pseudonym" => @pseudonym,
    "serialNumber" => @serial_number,
    "state" => @state,
    "surname" => @surname,
    "title" => @title,
  })
  result.compact
end