CfnCertificateAuthority

class aws_cdk.aws_acmpca.CfnCertificateAuthority(scope, id, *, key_algorithm, signing_algorithm, subject, type, csr_extensions=None, key_storage_security_standard=None, revocation_configuration=None, tags=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::ACMPCA::CertificateAuthority.

Use the AWS::ACMPCA::CertificateAuthority resource to create a private CA. Once the CA exists, you can use the AWS::ACMPCA::Certificate resource to issue a new CA certificate. Alternatively, you can issue a CA certificate using an on-premises CA, and then use the AWS::ACMPCA::CertificateAuthorityActivation resource to import the new CA certificate and activate the CA. .. epigraph:

Before removing a ``AWS::ACMPCA::CertificateAuthority`` resource from the CloudFormation stack, disable the affected CA. Otherwise, the action will fail. You can disable the CA by removing its associated ``AWS::ACMPCA::CertificateAuthorityActivation`` resource from CloudFormation.
CloudformationResource

AWS::ACMPCA::CertificateAuthority

ExampleMetadata

infused

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html

Example:

cfn_certificate_authority = acmpca.CfnCertificateAuthority(self, "CA",
    type="ROOT",
    key_algorithm="RSA_2048",
    signing_algorithm="SHA256WITHRSA",
    subject=acmpca.CfnCertificateAuthority.SubjectProperty(
        country="US",
        organization="string",
        organizational_unit="string",
        distinguished_name_qualifier="string",
        state="string",
        common_name="123",
        serial_number="string",
        locality="string",
        title="string",
        surname="string",
        given_name="string",
        initials="DG",
        pseudonym="string",
        generation_qualifier="DBG"
    )
)

Create a new AWS::ACMPCA::CertificateAuthority.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • key_algorithm (str) – Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. When you create a subordinate CA, you must use a key algorithm supported by the parent CA.

  • signing_algorithm (str) – Name of the algorithm your private CA uses to sign certificate requests. This parameter should not be confused with the SigningAlgorithm parameter used to sign certificates when they are issued.

  • subject (Union[IResolvable, SubjectProperty]) – Structure that contains X.500 distinguished name information for your private CA.

  • type (str) – Type of your private CA.

  • csr_extensions (Union[IResolvable, CsrExtensionsProperty, None]) – Specifies information to be added to the extension section of the certificate signing request (CSR).

  • key_storage_security_standard (Optional[str]) – Specifies a cryptographic key management compliance standard used for handling CA keys. Default: FIPS_140_2_LEVEL_3_OR_HIGHER Note: FIPS_140_2_LEVEL_3_OR_HIGHER is not supported in Region ap-northeast-3. When creating a CA in the ap-northeast-3, you must provide FIPS_140_2_LEVEL_2_OR_HIGHER as the argument for KeyStorageSecurityStandard . Failure to do this results in an InvalidArgsException with the message, “A certificate authority cannot be created in this region with the specified security standard.”

  • revocation_configuration (Union[IResolvable, RevocationConfigurationProperty, None]) – Information about the certificate revocation list (CRL) created and maintained by your private CA. Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions. Your certificate authority can create and maintain a certificate revocation list (CRL). A CRL contains information about certificates that have been revoked.

  • tags (Optional[Sequence[CfnTag]]) – Key-value pairs that will be attached to the new private CA. You can associate up to 50 tags with a private CA. For information using tags with IAM to manage permissions, see Controlling Access Using IAM Tags .

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::ACMPCA::CertificateAuthority'
attr_arn

The Amazon Resource Name (ARN) for the private CA that issued the certificate.

CloudformationAttribute

Arn

Return type

str

attr_certificate_signing_request

The Base64 PEM-encoded certificate signing request (CSR) for your certificate authority certificate.

CloudformationAttribute

CertificateSigningRequest

Return type

str

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

csr_extensions

Specifies information to be added to the extension section of the certificate signing request (CSR).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-csrextensions

Return type

Union[IResolvable, CsrExtensionsProperty, None]

key_algorithm

Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate.

When you create a subordinate CA, you must use a key algorithm supported by the parent CA.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-keyalgorithm

Return type

str

key_storage_security_standard

Specifies a cryptographic key management compliance standard used for handling CA keys.

Default: FIPS_140_2_LEVEL_3_OR_HIGHER

Note: FIPS_140_2_LEVEL_3_OR_HIGHER is not supported in Region ap-northeast-3. When creating a CA in the ap-northeast-3, you must provide FIPS_140_2_LEVEL_2_OR_HIGHER as the argument for KeyStorageSecurityStandard . Failure to do this results in an InvalidArgsException with the message, “A certificate authority cannot be created in this region with the specified security standard.”

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-keystoragesecuritystandard

Return type

Optional[str]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

revocation_configuration

Information about the certificate revocation list (CRL) created and maintained by your private CA.

Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions. Your certificate authority can create and maintain a certificate revocation list (CRL). A CRL contains information about certificates that have been revoked.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-revocationconfiguration

Return type

Union[IResolvable, RevocationConfigurationProperty, None]

signing_algorithm

Name of the algorithm your private CA uses to sign certificate requests.

This parameter should not be confused with the SigningAlgorithm parameter used to sign certificates when they are issued.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-signingalgorithm

Return type

str

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

subject

Structure that contains X.500 distinguished name information for your private CA.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-subject

Return type

Union[IResolvable, SubjectProperty]

tags

Key-value pairs that will be attached to the new private CA.

You can associate up to 50 tags with a private CA. For information using tags with IAM to manage permissions, see Controlling Access Using IAM Tags .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-tags

Return type

TagManager

type

Type of your private CA.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html#cfn-acmpca-certificateauthority-type

Return type

str

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

AccessDescriptionProperty

class CfnCertificateAuthority.AccessDescriptionProperty(*, access_location, access_method)

Bases: object

Provides access information used by the authorityInfoAccess and subjectInfoAccess extensions described in RFC 5280 .

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-accessdescription.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_acmpca as acmpca

access_description_property = acmpca.CfnCertificateAuthority.AccessDescriptionProperty(
    access_location=acmpca.CfnCertificateAuthority.GeneralNameProperty(
        directory_name=acmpca.CfnCertificateAuthority.SubjectProperty(
            common_name="commonName",
            country="country",
            custom_attributes=[acmpca.CfnCertificateAuthority.CustomAttributeProperty(
                object_identifier="objectIdentifier",
                value="value"
            )],
            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"
        ),
        dns_name="dnsName",
        edi_party_name=acmpca.CfnCertificateAuthority.EdiPartyNameProperty(
            name_assigner="nameAssigner",
            party_name="partyName"
        ),
        ip_address="ipAddress",
        other_name=acmpca.CfnCertificateAuthority.OtherNameProperty(
            type_id="typeId",
            value="value"
        ),
        registered_id="registeredId",
        rfc822_name="rfc822Name",
        uniform_resource_identifier="uniformResourceIdentifier"
    ),
    access_method=acmpca.CfnCertificateAuthority.AccessMethodProperty(
        access_method_type="accessMethodType",
        custom_object_identifier="customObjectIdentifier"
    )
)

Attributes

access_location

The location of AccessDescription information.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-accessdescription.html#cfn-acmpca-certificateauthority-accessdescription-accesslocation

Return type

Union[IResolvable, GeneralNameProperty]

access_method

The type and format of AccessDescription information.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-accessdescription.html#cfn-acmpca-certificateauthority-accessdescription-accessmethod

Return type

Union[IResolvable, AccessMethodProperty]

AccessMethodProperty

class CfnCertificateAuthority.AccessMethodProperty(*, access_method_type=None, custom_object_identifier=None)

Bases: object

Describes the type and format of extension access.

Only one of CustomObjectIdentifier or AccessMethodType may be provided. Providing both results in InvalidArgsException .

Parameters
  • access_method_type (Optional[str]) – Specifies the AccessMethod .

  • custom_object_identifier (Optional[str]) – An object identifier (OID) specifying the AccessMethod . The OID must satisfy the regular expression shown below. For more information, see NIST’s definition of Object Identifier (OID) .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-accessmethod.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_acmpca as acmpca

access_method_property = acmpca.CfnCertificateAuthority.AccessMethodProperty(
    access_method_type="accessMethodType",
    custom_object_identifier="customObjectIdentifier"
)

Attributes

access_method_type

Specifies the AccessMethod .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-accessmethod.html#cfn-acmpca-certificateauthority-accessmethod-accessmethodtype

Return type

Optional[str]

custom_object_identifier

An object identifier (OID) specifying the AccessMethod .

The OID must satisfy the regular expression shown below. For more information, see NIST’s definition of Object Identifier (OID) .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-accessmethod.html#cfn-acmpca-certificateauthority-accessmethod-customobjectidentifier

Return type

Optional[str]

CrlConfigurationProperty

class CfnCertificateAuthority.CrlConfigurationProperty(*, custom_cname=None, enabled=None, expiration_in_days=None, s3_bucket_name=None, s3_object_acl=None)

Bases: object

Contains configuration information for a certificate revocation list (CRL).

Your private certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You can enable CRLs for your new or an existing private CA by setting the Enabled parameter to true . Your private CA writes CRLs to an S3 bucket that you specify in the S3BucketName parameter. You can hide the name of your bucket by specifying a value for the CustomCname parameter. Your private CA copies the CNAME or the S3 bucket name to the CRL Distribution Points extension of each certificate it issues. Your S3 bucket policy must give write permission to ACM Private CA.

ACM Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs .

Your private CA uses the value in the ExpirationInDays parameter to calculate the nextUpdate field in the CRL. The CRL is refreshed prior to a certificate’s expiration date or when a certificate is revoked. When a certificate is revoked, it appears in the CRL until the certificate expires, and then in one additional CRL after expiration, and it always appears in the audit report.

A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason a CRL update fails, ACM Private CA makes further attempts every 15 minutes.

CRLs contain the following fields:

  • Version : The current version number defined in RFC 5280 is V2. The integer value is 0x1.

  • Signature Algorithm : The name of the algorithm used to sign the CRL.

  • Issuer : The X.500 distinguished name of your private CA that issued the CRL.

  • Last Update : The issue date and time of this CRL.

  • Next Update : The day and time by which the next CRL will be issued.

  • Revoked Certificates : List of revoked certificates. Each list item contains the following information.

  • Serial Number : The serial number, in hexadecimal format, of the revoked certificate.

  • Revocation Date : Date and time the certificate was revoked.

  • CRL Entry Extensions : Optional extensions for the CRL entry.

  • X509v3 CRL Reason Code : Reason the certificate was revoked.

  • CRL Extensions : Optional extensions for the CRL.

  • X509v3 Authority Key Identifier : Identifies the public key associated with the private key used to sign the certificate.

  • X509v3 CRL Number: : Decimal sequence number for the CRL.

  • Signature Algorithm : Algorithm used by your private CA to sign the CRL.

  • Signature Value : Signature computed over the CRL.

Certificate revocation lists created by ACM Private CA are DER-encoded. You can use the following OpenSSL command to list a CRL.

openssl crl -inform DER -text -in *crl_path* -noout

For more information, see Planning a certificate revocation list (CRL) in the AWS Certificate Manager Private Certificate Authority (PCA) User Guide

Parameters
  • custom_cname (Optional[str]) – Name inserted into the certificate CRL Distribution Points extension that enables the use of an alias for the CRL distribution point. Use this value if you don’t want the name of your S3 bucket to be public.

  • enabled (Union[bool, IResolvable, None]) – Boolean value that specifies whether certificate revocation lists (CRLs) are enabled. You can use this value to enable certificate revocation for a new CA when you call the CreateCertificateAuthority operation or for an existing CA when you call the UpdateCertificateAuthority operation.

  • expiration_in_days (Union[int, float, None]) – Validity period of the CRL in days.

  • s3_bucket_name (Optional[str]) – Name of the S3 bucket that contains the CRL. If you do not provide a value for the CustomCname argument, the name of your S3 bucket is placed into the CRL Distribution Points extension of the issued certificate. You can change the name of your bucket by calling the UpdateCertificateAuthority operation. You must specify a bucket policy that allows ACM Private CA to write the CRL to your bucket.

  • s3_object_acl (Optional[str]) – Determines whether the CRL will be publicly readable or privately held in the CRL Amazon S3 bucket. If you choose PUBLIC_READ, the CRL will be accessible over the public internet. If you choose BUCKET_OWNER_FULL_CONTROL, only the owner of the CRL S3 bucket can access the CRL, and your PKI clients may need an alternative method of access. If no value is specified, the default is PUBLIC_READ. .. epigraph:: This default can cause CA creation to fail in some circumstances. If you have enabled the Block Public Access (BPA) feature in your S3 account, then you must specify the value of this parameter as BUCKET_OWNER_FULL_CONTROL , and not doing so results in an error. If you have disabled BPA in S3, then you can specify either BUCKET_OWNER_FULL_CONTROL or PUBLIC_READ as the value. For more information, see Blocking public access to the S3 bucket .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-crlconfiguration.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_acmpca as acmpca

crl_configuration_property = acmpca.CfnCertificateAuthority.CrlConfigurationProperty(
    custom_cname="customCname",
    enabled=False,
    expiration_in_days=123,
    s3_bucket_name="s3BucketName",
    s3_object_acl="s3ObjectAcl"
)

Attributes

custom_cname

Name inserted into the certificate CRL Distribution Points extension that enables the use of an alias for the CRL distribution point.

Use this value if you don’t want the name of your S3 bucket to be public.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-crlconfiguration.html#cfn-acmpca-certificateauthority-crlconfiguration-customcname

Return type

Optional[str]

enabled

Boolean value that specifies whether certificate revocation lists (CRLs) are enabled.

You can use this value to enable certificate revocation for a new CA when you call the CreateCertificateAuthority operation or for an existing CA when you call the UpdateCertificateAuthority operation.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-crlconfiguration.html#cfn-acmpca-certificateauthority-crlconfiguration-enabled

Return type

Union[bool, IResolvable, None]

expiration_in_days

Validity period of the CRL in days.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-crlconfiguration.html#cfn-acmpca-certificateauthority-crlconfiguration-expirationindays

Return type

Union[int, float, None]

s3_bucket_name

Name of the S3 bucket that contains the CRL.

If you do not provide a value for the CustomCname argument, the name of your S3 bucket is placed into the CRL Distribution Points extension of the issued certificate. You can change the name of your bucket by calling the UpdateCertificateAuthority operation. You must specify a bucket policy that allows ACM Private CA to write the CRL to your bucket.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-crlconfiguration.html#cfn-acmpca-certificateauthority-crlconfiguration-s3bucketname

Return type

Optional[str]

s3_object_acl

Determines whether the CRL will be publicly readable or privately held in the CRL Amazon S3 bucket.

If you choose PUBLIC_READ, the CRL will be accessible over the public internet. If you choose BUCKET_OWNER_FULL_CONTROL, only the owner of the CRL S3 bucket can access the CRL, and your PKI clients may need an alternative method of access.

If no value is specified, the default is PUBLIC_READ. .. epigraph:

This default can cause CA creation to fail in some circumstances. If you have enabled the Block Public Access (BPA) feature in your S3 account, then you must specify the value of this parameter as ``BUCKET_OWNER_FULL_CONTROL`` , and not doing so results in an error. If you have disabled BPA in S3, then you can specify either ``BUCKET_OWNER_FULL_CONTROL`` or ``PUBLIC_READ`` as the value.

For more information, see Blocking public access to the S3 bucket .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-crlconfiguration.html#cfn-acmpca-certificateauthority-crlconfiguration-s3objectacl

Return type

Optional[str]

CsrExtensionsProperty

class CfnCertificateAuthority.CsrExtensionsProperty(*, key_usage=None, subject_information_access=None)

Bases: object

Describes the certificate extensions to be added to the certificate signing request (CSR).

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-csrextensions.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_acmpca as acmpca

csr_extensions_property = acmpca.CfnCertificateAuthority.CsrExtensionsProperty(
    key_usage=acmpca.CfnCertificateAuthority.KeyUsageProperty(
        crl_sign=False,
        data_encipherment=False,
        decipher_only=False,
        digital_signature=False,
        encipher_only=False,
        key_agreement=False,
        key_cert_sign=False,
        key_encipherment=False,
        non_repudiation=False
    ),
    subject_information_access=[acmpca.CfnCertificateAuthority.AccessDescriptionProperty(
        access_location=acmpca.CfnCertificateAuthority.GeneralNameProperty(
            directory_name=acmpca.CfnCertificateAuthority.SubjectProperty(
                common_name="commonName",
                country="country",
                custom_attributes=[acmpca.CfnCertificateAuthority.CustomAttributeProperty(
                    object_identifier="objectIdentifier",
                    value="value"
                )],
                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"
            ),
            dns_name="dnsName",
            edi_party_name=acmpca.CfnCertificateAuthority.EdiPartyNameProperty(
                name_assigner="nameAssigner",
                party_name="partyName"
            ),
            ip_address="ipAddress",
            other_name=acmpca.CfnCertificateAuthority.OtherNameProperty(
                type_id="typeId",
                value="value"
            ),
            registered_id="registeredId",
            rfc822_name="rfc822Name",
            uniform_resource_identifier="uniformResourceIdentifier"
        ),
        access_method=acmpca.CfnCertificateAuthority.AccessMethodProperty(
            access_method_type="accessMethodType",
            custom_object_identifier="customObjectIdentifier"
        )
    )]
)

Attributes

key_usage

Indicates the purpose of the certificate and of the key contained in the certificate.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-csrextensions.html#cfn-acmpca-certificateauthority-csrextensions-keyusage

Return type

Union[IResolvable, KeyUsageProperty, None]

subject_information_access

For CA certificates, provides a path to additional information pertaining to the CA, such as revocation and policy.

For more information, see Subject Information Access in RFC 5280.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-csrextensions.html#cfn-acmpca-certificateauthority-csrextensions-subjectinformationaccess

Return type

Union[IResolvable, List[Union[IResolvable, AccessDescriptionProperty]], None]

CustomAttributeProperty

class CfnCertificateAuthority.CustomAttributeProperty(*, object_identifier, value)

Bases: object

Defines the X.500 relative distinguished name (RDN).

Parameters
  • object_identifier (str) – Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).

  • value (str) – Specifies the attribute value of relative distinguished name (RDN).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-customattribute.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_acmpca as acmpca

custom_attribute_property = acmpca.CfnCertificateAuthority.CustomAttributeProperty(
    object_identifier="objectIdentifier",
    value="value"
)

Attributes

object_identifier

Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-customattribute.html#cfn-acmpca-certificateauthority-customattribute-objectidentifier

Return type

str

value

Specifies the attribute value of relative distinguished name (RDN).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-customattribute.html#cfn-acmpca-certificateauthority-customattribute-value

Return type

str

EdiPartyNameProperty

class CfnCertificateAuthority.EdiPartyNameProperty(*, name_assigner, party_name)

Bases: object

Describes an Electronic Data Interchange (EDI) entity as described in as defined in Subject Alternative Name in RFC 5280.

Parameters
  • name_assigner (str) – Specifies the name assigner.

  • party_name (str) – Specifies the party name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-edipartyname.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_acmpca as acmpca

edi_party_name_property = acmpca.CfnCertificateAuthority.EdiPartyNameProperty(
    name_assigner="nameAssigner",
    party_name="partyName"
)

Attributes

name_assigner

Specifies the name assigner.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-edipartyname.html#cfn-acmpca-certificateauthority-edipartyname-nameassigner

Return type

str

party_name

Specifies the party name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-edipartyname.html#cfn-acmpca-certificateauthority-edipartyname-partyname

Return type

str

GeneralNameProperty

class CfnCertificateAuthority.GeneralNameProperty(*, directory_name=None, dns_name=None, edi_party_name=None, ip_address=None, other_name=None, registered_id=None, rfc822_name=None, uniform_resource_identifier=None)

Bases: object

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.

Parameters
  • directory_name (Union[IResolvable, SubjectProperty, None]) – 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.

  • dns_name (Optional[str]) – Represents GeneralName as a DNS name.

  • edi_party_name (Union[IResolvable, EdiPartyNameProperty, None]) – Represents GeneralName as an EdiPartyName object.

  • ip_address (Optional[str]) – Represents GeneralName as an IPv4 or IPv6 address.

  • other_name (Union[IResolvable, OtherNameProperty, None]) – Represents GeneralName using an OtherName object.

  • registered_id (Optional[str]) – Represents GeneralName as an object identifier (OID).

  • rfc822_name (Optional[str]) – Represents GeneralName as an RFC 822 email address.

  • uniform_resource_identifier (Optional[str]) – Represents GeneralName as a URI.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_acmpca as acmpca

general_name_property = acmpca.CfnCertificateAuthority.GeneralNameProperty(
    directory_name=acmpca.CfnCertificateAuthority.SubjectProperty(
        common_name="commonName",
        country="country",
        custom_attributes=[acmpca.CfnCertificateAuthority.CustomAttributeProperty(
            object_identifier="objectIdentifier",
            value="value"
        )],
        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"
    ),
    dns_name="dnsName",
    edi_party_name=acmpca.CfnCertificateAuthority.EdiPartyNameProperty(
        name_assigner="nameAssigner",
        party_name="partyName"
    ),
    ip_address="ipAddress",
    other_name=acmpca.CfnCertificateAuthority.OtherNameProperty(
        type_id="typeId",
        value="value"
    ),
    registered_id="registeredId",
    rfc822_name="rfc822Name",
    uniform_resource_identifier="uniformResourceIdentifier"
)

Attributes

directory_name

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-directoryname

Return type

Union[IResolvable, SubjectProperty, None]

dns_name

Represents GeneralName as a DNS name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-dnsname

Return type

Optional[str]

edi_party_name

Represents GeneralName as an EdiPartyName object.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-edipartyname

Return type

Union[IResolvable, EdiPartyNameProperty, None]

ip_address

Represents GeneralName as an IPv4 or IPv6 address.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-ipaddress

Return type

Optional[str]

other_name

Represents GeneralName using an OtherName object.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-othername

Return type

Union[IResolvable, OtherNameProperty, None]

registered_id

Represents GeneralName as an object identifier (OID).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-registeredid

Return type

Optional[str]

rfc822_name

//datatracker.ietf.org/doc/html/rfc822>`_ email address.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-rfc822name

Type

Represents GeneralName as an `RFC 822 <https

Type

//docs.aws.amazon.com/https

Return type

Optional[str]

uniform_resource_identifier

Represents GeneralName as a URI.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html#cfn-acmpca-certificateauthority-generalname-uniformresourceidentifier

Return type

Optional[str]

KeyUsageProperty

class CfnCertificateAuthority.KeyUsageProperty(*, crl_sign=None, data_encipherment=None, decipher_only=None, digital_signature=None, encipher_only=None, key_agreement=None, key_cert_sign=None, key_encipherment=None, non_repudiation=None)

Bases: object

Defines one or more purposes for which the key contained in the certificate can be used.

Default value for each option is false.

Parameters
  • crl_sign (Union[bool, IResolvable, None]) – Key can be used to sign CRLs.

  • data_encipherment (Union[bool, IResolvable, None]) – Key can be used to decipher data.

  • decipher_only (Union[bool, IResolvable, None]) – Key can be used only to decipher data.

  • digital_signature (Union[bool, IResolvable, None]) – Key can be used for digital signing.

  • encipher_only (Union[bool, IResolvable, None]) – Key can be used only to encipher data.

  • key_agreement (Union[bool, IResolvable, None]) – Key can be used in a key-agreement protocol.

  • key_cert_sign (Union[bool, IResolvable, None]) – Key can be used to sign certificates.

  • key_encipherment (Union[bool, IResolvable, None]) – Key can be used to encipher data.

  • non_repudiation (Union[bool, IResolvable, None]) – Key can be used for non-repudiation.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-keyusage.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_acmpca as acmpca

key_usage_property = acmpca.CfnCertificateAuthority.KeyUsageProperty(
    crl_sign=False,
    data_encipherment=False,
    decipher_only=False,
    digital_signature=False,
    encipher_only=False,
    key_agreement=False,
    key_cert_sign=False,
    key_encipherment=False,
    non_repudiation=False
)

Attributes

crl_sign

Key can be used to sign CRLs.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-keyusage.html#cfn-acmpca-certificateauthority-keyusage-crlsign

Return type

Union[bool, IResolvable, None]

data_encipherment

Key can be used to decipher data.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-keyusage.html#cfn-acmpca-certificateauthority-keyusage-dataencipherment

Return type

Union[bool, IResolvable, None]

decipher_only

Key can be used only to decipher data.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-keyusage.html#cfn-acmpca-certificateauthority-keyusage-decipheronly

Return type

Union[bool, IResolvable, None]

digital_signature

Key can be used for digital signing.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-keyusage.html#cfn-acmpca-certificateauthority-keyusage-digitalsignature

Return type

Union[bool, IResolvable, None]

encipher_only

Key can be used only to encipher data.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-keyusage.html#cfn-acmpca-certificateauthority-keyusage-encipheronly

Return type

Union[bool, IResolvable, None]

key_agreement

Key can be used in a key-agreement protocol.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-keyusage.html#cfn-acmpca-certificateauthority-keyusage-keyagreement

Return type

Union[bool, IResolvable, None]

key_cert_sign

Key can be used to sign certificates.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-keyusage.html#cfn-acmpca-certificateauthority-keyusage-keycertsign

Return type

Union[bool, IResolvable, None]

key_encipherment

Key can be used to encipher data.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-keyusage.html#cfn-acmpca-certificateauthority-keyusage-keyencipherment

Return type

Union[bool, IResolvable, None]

non_repudiation

Key can be used for non-repudiation.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-keyusage.html#cfn-acmpca-certificateauthority-keyusage-nonrepudiation

Return type

Union[bool, IResolvable, None]

OcspConfigurationProperty

class CfnCertificateAuthority.OcspConfigurationProperty(*, enabled=None, ocsp_custom_cname=None)

Bases: object

Contains information to enable and configure Online Certificate Status Protocol (OCSP) for validating certificate revocation status.

Parameters
  • enabled (Union[bool, IResolvable, None]) – Flag enabling use of the Online Certificate Status Protocol (OCSP) for validating certificate revocation status.

  • ocsp_custom_cname (Optional[str]) – By default, ACM Private CA injects an Amazon domain into certificates being validated by the Online Certificate Status Protocol (OCSP). A customer can alternatively use this object to define a CNAME specifying a customized OCSP domain. Note: The value of the CNAME must not include a protocol prefix such as “http://” or “https://”.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-ocspconfiguration.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_acmpca as acmpca

ocsp_configuration_property = acmpca.CfnCertificateAuthority.OcspConfigurationProperty(
    enabled=False,
    ocsp_custom_cname="ocspCustomCname"
)

Attributes

enabled

Flag enabling use of the Online Certificate Status Protocol (OCSP) for validating certificate revocation status.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-ocspconfiguration.html#cfn-acmpca-certificateauthority-ocspconfiguration-enabled

Return type

Union[bool, IResolvable, None]

ocsp_custom_cname

By default, ACM Private CA injects an Amazon domain into certificates being validated by the Online Certificate Status Protocol (OCSP).

A customer can alternatively use this object to define a CNAME specifying a customized OCSP domain.

Note: The value of the CNAME must not include a protocol prefix such as “http://” or “https://”.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-ocspconfiguration.html#cfn-acmpca-certificateauthority-ocspconfiguration-ocspcustomcname

Return type

Optional[str]

OtherNameProperty

class CfnCertificateAuthority.OtherNameProperty(*, type_id, value)

Bases: object

Defines a custom ASN.1 X.400 GeneralName using an object identifier (OID) and value. The OID must satisfy the regular expression shown below. For more information, see NIST’s definition of Object Identifier (OID) .

Parameters
  • type_id (str) – Specifies an OID.

  • value (str) – Specifies an OID value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-othername.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_acmpca as acmpca

other_name_property = acmpca.CfnCertificateAuthority.OtherNameProperty(
    type_id="typeId",
    value="value"
)

Attributes

type_id

Specifies an OID.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-othername.html#cfn-acmpca-certificateauthority-othername-typeid

Return type

str

value

Specifies an OID value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-othername.html#cfn-acmpca-certificateauthority-othername-value

Return type

str

RevocationConfigurationProperty

class CfnCertificateAuthority.RevocationConfigurationProperty(*, crl_configuration=None, ocsp_configuration=None)

Bases: object

Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions.

Your private certificate authority (CA) can configure Online Certificate Status Protocol (OCSP) support and/or maintain a certificate revocation list (CRL). OCSP returns validation information about certificates as requested by clients, and a CRL contains an updated list of certificates revoked by your CA. For more information, see RevokeCertificate .

Parameters
  • crl_configuration (Union[IResolvable, CrlConfigurationProperty, None]) – Configuration of the certificate revocation list (CRL), if any, maintained by your private CA.

  • ocsp_configuration (Union[IResolvable, OcspConfigurationProperty, None]) – Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained by your private CA.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-revocationconfiguration.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_acmpca as acmpca

revocation_configuration_property = acmpca.CfnCertificateAuthority.RevocationConfigurationProperty(
    crl_configuration=acmpca.CfnCertificateAuthority.CrlConfigurationProperty(
        custom_cname="customCname",
        enabled=False,
        expiration_in_days=123,
        s3_bucket_name="s3BucketName",
        s3_object_acl="s3ObjectAcl"
    ),
    ocsp_configuration=acmpca.CfnCertificateAuthority.OcspConfigurationProperty(
        enabled=False,
        ocsp_custom_cname="ocspCustomCname"
    )
)

Attributes

crl_configuration

Configuration of the certificate revocation list (CRL), if any, maintained by your private CA.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-revocationconfiguration.html#cfn-acmpca-certificateauthority-revocationconfiguration-crlconfiguration

Return type

Union[IResolvable, CrlConfigurationProperty, None]

ocsp_configuration

Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained by your private CA.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-revocationconfiguration.html#cfn-acmpca-certificateauthority-revocationconfiguration-ocspconfiguration

Return type

Union[IResolvable, OcspConfigurationProperty, None]

SubjectProperty

class CfnCertificateAuthority.SubjectProperty(*, common_name=None, country=None, custom_attributes=None, distinguished_name_qualifier=None, generation_qualifier=None, given_name=None, initials=None, locality=None, organization=None, organizational_unit=None, pseudonym=None, serial_number=None, state=None, surname=None, title=None)

Bases: object

ASN1 subject for the certificate authority.

Parameters
  • common_name (Optional[str]) – Fully qualified domain name (FQDN) associated with the certificate subject.

  • country (Optional[str]) – Two-digit code that specifies the country in which the certificate subject located.

  • custom_attributes (Union[IResolvable, Sequence[Union[IResolvable, CustomAttributeProperty]], None]) –

    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) . .. epigraph:: Custom attributes cannot be used in combination with standard attributes.

  • distinguished_name_qualifier (Optional[str]) – Disambiguating information for the certificate subject.

  • generation_qualifier (Optional[str]) – Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.

  • given_name (Optional[str]) – First name.

  • initials (Optional[str]) – 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 (Optional[str]) – The locality (such as a city or town) in which the certificate subject is located.

  • organization (Optional[str]) – Legal name of the organization with which the certificate subject is affiliated.

  • organizational_unit (Optional[str]) – A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.

  • pseudonym (Optional[str]) – 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.

  • serial_number (Optional[str]) – The certificate serial number.

  • state (Optional[str]) – State in which the subject of the certificate is located.

  • surname (Optional[str]) – Family name.

  • title (Optional[str]) – A personal title such as Mr.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_acmpca as acmpca

subject_property = acmpca.CfnCertificateAuthority.SubjectProperty(
    common_name="commonName",
    country="country",
    custom_attributes=[acmpca.CfnCertificateAuthority.CustomAttributeProperty(
        object_identifier="objectIdentifier",
        value="value"
    )],
    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"
)

Attributes

common_name

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

Link

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

Return type

Optional[str]

country

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

Link

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

Return type

Optional[str]

custom_attributes

//csrc.nist.gov/glossary/term/Object_Identifier>`_ .

Custom attributes cannot be used in combination with standard attributes.

Link

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

Type

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

Type

//docs.aws.amazon.com/https

Return type

Union[IResolvable, List[Union[IResolvable, CustomAttributeProperty]], None]

distinguished_name_qualifier

Disambiguating information for the certificate subject.

Link

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

Return type

Optional[str]

generation_qualifier

Typically a qualifier appended to the name of an individual.

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

Link

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

Return type

Optional[str]

given_name

First name.

Link

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

Return type

Optional[str]

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.

Link

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

Return type

Optional[str]

locality

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

Link

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

Return type

Optional[str]

organization

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

Link

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

Return type

Optional[str]

organizational_unit

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

Link

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

Return type

Optional[str]

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.

Link

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

Return type

Optional[str]

serial_number

The certificate serial number.

Link

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

Return type

Optional[str]

state

State in which the subject of the certificate is located.

Link

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

Return type

Optional[str]

surname

Family name.

Link

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

Return type

Optional[str]

title

A personal title such as Mr.

Link

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

Return type

Optional[str]