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, usage_mode=None)

Bases: CfnResource

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificateauthority.html
CloudformationResource:: AWS::ACMPCA::CertificateAuthority
ExampleMetadata:: infused

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

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
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, Dict[str, Any]]) – Structure that contains X.500 distinguished name information for your private CA.
type (str) – Type of your private CA.
csr_extensions (Union[IResolvable, CsrExtensionsProperty, Dict[str, Any], 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 .. epigraph:: Some AWS Regions do not support the default. When creating a CA in these Regions, 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.” For information about security standard support in various Regions, see Storage and security compliance of AWS Private CA private keys .
revocation_configuration (Union[IResolvable, RevocationConfigurationProperty, Dict[str, Any], None]) – Information about the Online Certificate Status Protocol (OCSP) configuration or certificate revocation list (CRL) created and maintained by your private CA.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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 .
usage_mode (Optional[str]) – Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days. The default value is GENERAL_PURPOSE.

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_dependency(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_depends_on(target)

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

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

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.

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 intermediate 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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

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 resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

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.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

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.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

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

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

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

attr_certificate_signing_request

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

CloudformationAttribute:: CertificateSigningRequest

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

cfn_resource_type: AWS resource type.

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.

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

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.

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

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

Returns:

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

node: The tree node.

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

revocation_configuration: Information about the Online Certificate Status Protocol (OCSP) configuration or certificate revocation list (CRL) created and maintained by your private CA.

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

stack

The stack in which this element is defined.

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

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

tags: Tag Manager which manages the tags for this resource.

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

type: Type of your private CA.

usage_mode: Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly.

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(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

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:

access_location (Union[IResolvable, GeneralNameProperty, Dict[str, Any]]) – The location of AccessDescription information.
access_method (Union[IResolvable, AccessMethodProperty, Dict[str, Any]]) – The type and format of AccessDescription information.

See:

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.
from aws_cdk import 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(
            party_name="partyName",

            # the properties below are optional
            name_assigner="nameAssigner"
        ),
        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.

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

access_method

The type and format of AccessDescription information.

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

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

See:

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.
from aws_cdk import 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 .

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

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

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

CrlConfigurationProperty

class CfnCertificateAuthority.CrlConfigurationProperty(*, enabled, crl_distribution_point_extension_configuration=None, custom_cname=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 by default copies the CNAME or the S3 bucket name to the CRL Distribution Points extension of each certificate it issues. If you want to configure this default behavior to be something different, you can set the CrlDistributionPointExtensionConfiguration parameter. Your S3 bucket policy must give write permission to AWS Private CA.

AWS 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, AWS 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 AWS 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 Private Certificate Authority User Guide

Parameters:

enabled (Union[bool, IResolvable]) – 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.
crl_distribution_point_extension_configuration (Union[IResolvable, CrlDistributionPointExtensionConfigurationProperty, Dict[str, Any], None]) – Configures the default behavior of the CRL Distribution Point extension for certificates issued by your CA. If this field is not provided, then the CRL Distribution Point extension will be present and contain the default CRL URL.
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. .. epigraph:: The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as “http://” or “https://”.
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 AWS Private CA to write the CRL to your bucket. .. epigraph:: The S3BucketName parameter must conform to the S3 bucket naming rules .
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. Note: This default can cause CA creation to fail in some circumstances. If you have 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 .

See:

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.
from aws_cdk import aws_acmpca as acmpca

crl_configuration_property = acmpca.CfnCertificateAuthority.CrlConfigurationProperty(
    enabled=False,

    # the properties below are optional
    crl_distribution_point_extension_configuration=acmpca.CfnCertificateAuthority.CrlDistributionPointExtensionConfigurationProperty(
        omit_extension=False
    ),
    custom_cname="customCname",
    expiration_in_days=123,
    s3_bucket_name="s3BucketName",
    s3_object_acl="s3ObjectAcl"
)

Attributes

crl_distribution_point_extension_configuration

Configures the default behavior of the CRL Distribution Point extension for certificates issued by your CA.

If this field is not provided, then the CRL Distribution Point extension will be present and contain the default CRL URL.

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

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. .. epigraph:

The content of a Canonical Name (CNAME) record must conform to `RFC2396 <https://docs.aws.amazon.com/https://www.ietf.org/rfc/rfc2396.txt>`_ restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as "http://" or "https://".

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

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.

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

expiration_in_days

Validity period of the CRL in days.

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

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 AWS Private CA to write the CRL to your bucket. .. epigraph:

The ``S3BucketName`` parameter must conform to the `S3 bucket naming rules <https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html>`_ .

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

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.

Note: This default can cause CA creation to fail in some circumstances. If you have 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 .

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

CrlDistributionPointExtensionConfigurationProperty

class CfnCertificateAuthority.CrlDistributionPointExtensionConfigurationProperty(*, omit_extension)

Bases: object

Contains configuration information for the default behavior of the CRL Distribution Point (CDP) extension in certificates issued by your CA.

This extension contains a link to download the CRL, so you can check whether a certificate has been revoked. To choose whether you want this extension omitted or not in certificates issued by your CA, you can set the OmitExtension parameter.

Parameters:: omit_extension (Union[bool, IResolvable]) – Configures whether the CRL Distribution Point extension should be populated with the default URL to the CRL. If set to true , then the CDP extension will not be present in any certificates issued by that CA unless otherwise specified through CSR or API passthrough. .. epigraph:: Only set this if you have another way to distribute the CRL Distribution Points for certificates issued by your CA, such as the Matter Distributed Compliance Ledger. This configuration cannot be enabled with a custom CNAME set.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-crldistributionpointextensionconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

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

crl_distribution_point_extension_configuration_property = acmpca.CfnCertificateAuthority.CrlDistributionPointExtensionConfigurationProperty(
    omit_extension=False
)

Attributes

omit_extension

Configures whether the CRL Distribution Point extension should be populated with the default URL to the CRL.

If set to true , then the CDP extension will not be present in any certificates issued by that CA unless otherwise specified through CSR or API passthrough. .. epigraph:

Only set this if you have another way to distribute the CRL Distribution Points for certificates issued by your CA, such as the Matter Distributed Compliance Ledger.

This configuration cannot be enabled with a custom CNAME set.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-crldistributionpointextensionconfiguration.html#cfn-acmpca-certificateauthority-crldistributionpointextensionconfiguration-omitextension

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:

key_usage (Union[IResolvable, KeyUsageProperty, Dict[str, Any], None]) – Indicates the purpose of the certificate and of the key contained in the certificate.
subject_information_access (Union[IResolvable, Sequence[Union[IResolvable, AccessDescriptionProperty, Dict[str, Any]]], None]) – 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.

See:

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.
from aws_cdk import 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(
                party_name="partyName",

                # the properties below are optional
                name_assigner="nameAssigner"
            ),
            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.

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

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.

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

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

See:

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.
from aws_cdk import 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).

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

value

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

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

EdiPartyNameProperty

class CfnCertificateAuthority.EdiPartyNameProperty(*, party_name, name_assigner=None)

Bases: object

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

Parameters:

party_name (str) – Specifies the party name.
name_assigner (Optional[str]) – Specifies the name assigner.

See:

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.
from aws_cdk import aws_acmpca as acmpca

edi_party_name_property = acmpca.CfnCertificateAuthority.EdiPartyNameProperty(
    party_name="partyName",

    # the properties below are optional
    name_assigner="nameAssigner"
)

Attributes

name_assigner

Specifies the name assigner.

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

party_name

Specifies the party name.

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

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, Dict[str, Any], 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, Dict[str, Any], None]) – Represents GeneralName as an EdiPartyName object.
ip_address (Optional[str]) – Represents GeneralName as an IPv4 or IPv6 address.
other_name (Union[IResolvable, OtherNameProperty, Dict[str, Any], 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.

See:

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.
from aws_cdk import 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(
        party_name="partyName",

        # the properties below are optional
        name_assigner="nameAssigner"
    ),
    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.

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

dns_name

Represents GeneralName as a DNS name.

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

edi_party_name

Represents GeneralName as an EdiPartyName object.

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

ip_address

Represents GeneralName as an IPv4 or IPv6 address.

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

other_name

Represents GeneralName using an OtherName object.

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

registered_id

Represents GeneralName as an object identifier (OID).

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

rfc822_name

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

See:: 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

uniform_resource_identifier

Represents GeneralName as a URI.

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

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. Default: - false
data_encipherment (Union[bool, IResolvable, None]) – Key can be used to decipher data. Default: - false
decipher_only (Union[bool, IResolvable, None]) – Key can be used only to decipher data. Default: - false
digital_signature (Union[bool, IResolvable, None]) – Key can be used for digital signing. Default: - false
encipher_only (Union[bool, IResolvable, None]) – Key can be used only to encipher data. Default: - false
key_agreement (Union[bool, IResolvable, None]) – Key can be used in a key-agreement protocol. Default: - false
key_cert_sign (Union[bool, IResolvable, None]) – Key can be used to sign certificates. Default: - false
key_encipherment (Union[bool, IResolvable, None]) – Key can be used to encipher data. Default: - false
non_repudiation (Union[bool, IResolvable, None]) – Key can be used for non-repudiation. Default: - false

See:

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.
from aws_cdk import 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.

Default:

false

See:

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

data_encipherment

Key can be used to decipher data.

Default:

false

See:

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

decipher_only

Key can be used only to decipher data.

Default:

false

See:

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

digital_signature

Key can be used for digital signing.

Default:

false

See:

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

encipher_only

Key can be used only to encipher data.

Default:

false

See:

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

key_agreement

Key can be used in a key-agreement protocol.

Default:

false

See:

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

key_cert_sign

Key can be used to sign certificates.

Default:

false

See:

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

key_encipherment

Key can be used to encipher data.

Default:

false

See:

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

non_repudiation

Key can be used for non-repudiation.

Default:

false

See:

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

OcspConfigurationProperty

class CfnCertificateAuthority.OcspConfigurationProperty(*, enabled, 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]) – Flag enabling use of the Online Certificate Status Protocol (OCSP) for validating certificate revocation status.
ocsp_custom_cname (Optional[str]) –
By default, AWS 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. .. epigraph:: The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as “http://” or “https://”.

See:

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.
from aws_cdk import aws_acmpca as acmpca

ocsp_configuration_property = acmpca.CfnCertificateAuthority.OcspConfigurationProperty(
    enabled=False,

    # the properties below are optional
    ocsp_custom_cname="ocspCustomCname"
)

Attributes

enabled

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

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

ocsp_custom_cname

By default, AWS 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. .. epigraph:

The content of a Canonical Name (CNAME) record must conform to `RFC2396 <https://docs.aws.amazon.com/https://www.ietf.org/rfc/rfc2396.txt>`_ restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as "http://" or "https://".

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

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.

See:

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.
from aws_cdk import aws_acmpca as acmpca

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

Attributes

type_id

Specifies an OID.

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

value

Specifies an OID value.

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

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 in the AWS Private CA API Reference and Setting up a certificate revocation method in the AWS Private CA User Guide .

The following requirements and constraints apply to revocation configurations.

A configuration disabling CRLs or OCSP must contain only the Enabled=False parameter, and will fail if other parameters such as CustomCname or ExpirationInDays are included.
In a CRL configuration, the S3BucketName parameter must conform to the Amazon S3 bucket naming rules .
A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.
In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as “http://” or “https://”.
To revoke a certificate, delete the resource from your template, and call the AWS Private CA RevokeCertificate API and specify the resource’s certificate authority ARN.

Parameters:

crl_configuration (Union[IResolvable, CrlConfigurationProperty, Dict[str, Any], None]) – Configuration of the certificate revocation list (CRL), if any, maintained by your private CA.
ocsp_configuration (Union[IResolvable, OcspConfigurationProperty, Dict[str, Any], None]) – Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained by your private CA.

See:

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.
from aws_cdk import aws_acmpca as acmpca

revocation_configuration_property = acmpca.CfnCertificateAuthority.RevocationConfigurationProperty(
    crl_configuration=acmpca.CfnCertificateAuthority.CrlConfigurationProperty(
        enabled=False,

        # the properties below are optional
        crl_distribution_point_extension_configuration=acmpca.CfnCertificateAuthority.CrlDistributionPointExtensionConfigurationProperty(
            omit_extension=False
        ),
        custom_cname="customCname",
        expiration_in_days=123,
        s3_bucket_name="s3BucketName",
        s3_object_acl="s3ObjectAcl"
    ),
    ocsp_configuration=acmpca.CfnCertificateAuthority.OcspConfigurationProperty(
        enabled=False,

        # the properties below are optional
        ocsp_custom_cname="ocspCustomCname"
    )
)

Attributes

crl_configuration

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

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

ocsp_configuration

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

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

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, Dict[str, Any]]], 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.

See:

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.
from aws_cdk import 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.

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

country

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

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

custom_attributes

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

Custom attributes cannot be used in combination with standard attributes.

See:: 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

distinguished_name_qualifier

Disambiguating information for the certificate subject.

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

generation_qualifier

Typically a qualifier appended to the name of an individual.

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

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

given_name

First name.

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

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.