CfnCertificateAuthority

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

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::ACMPCA::CertificateAuthority.

CloudformationResource

AWS::ACMPCA::CertificateAuthority

Link

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

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

cfn_certificate_authority = acmpca.CfnCertificateAuthority(self, "MyCfnCertificateAuthority",
    key_algorithm="keyAlgorithm",
    signing_algorithm="signingAlgorithm",
    subject=acmpca.CfnCertificateAuthority.SubjectProperty(
        common_name="commonName",
        country="country",
        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"
    ),
    type="type",

    # the properties below are optional
    csr_extensions=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",
                    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"
            )
        )]
    ),
    key_storage_security_standard="keyStorageSecurityStandard",
    revocation_configuration=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"
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Create a new AWS::ACMPCA::CertificateAuthority.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • csr_extensions (Union[IResolvable, CsrExtensionsProperty, None]) – AWS::ACMPCA::CertificateAuthority.CsrExtensions.

  • key_algorithm (str) – AWS::ACMPCA::CertificateAuthority.KeyAlgorithm.

  • key_storage_security_standard (Optional[str]) – AWS::ACMPCA::CertificateAuthority.KeyStorageSecurityStandard.

  • revocation_configuration (Union[IResolvable, RevocationConfigurationProperty, None]) – AWS::ACMPCA::CertificateAuthority.RevocationConfiguration.

  • signing_algorithm (str) – AWS::ACMPCA::CertificateAuthority.SigningAlgorithm.

  • subject (Union[SubjectProperty, IResolvable]) – AWS::ACMPCA::CertificateAuthority.Subject.

  • tags (Optional[Sequence[CfnTag]]) – AWS::ACMPCA::CertificateAuthority.Tags.

  • type (str) – AWS::ACMPCA::CertificateAuthority.Type.

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"
       ...
     },
   ]
   ...
}
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

Arn

Type

cloudformationAttribute

Return type

str

attr_certificate_signing_request

CertificateSigningRequest

Type

cloudformationAttribute

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

AWS::ACMPCA::CertificateAuthority.CsrExtensions.

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

AWS::ACMPCA::CertificateAuthority.KeyAlgorithm.

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

AWS::ACMPCA::CertificateAuthority.KeyStorageSecurityStandard.

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

AWS::ACMPCA::CertificateAuthority.RevocationConfiguration.

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

AWS::ACMPCA::CertificateAuthority.SigningAlgorithm.

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

AWS::ACMPCA::CertificateAuthority.Subject.

Link

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

Return type

Union[SubjectProperty, IResolvable]

tags

AWS::ACMPCA::CertificateAuthority.Tags.

Link

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

Return type

TagManager

type

AWS::ACMPCA::CertificateAuthority.Type.

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

Parameters
Link

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

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

CfnCertificateAuthority.AccessDescriptionProperty.AccessLocation.

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

CfnCertificateAuthority.AccessDescriptionProperty.AccessMethod.

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

Parameters
  • access_method_type (Optional[str]) – CfnCertificateAuthority.AccessMethodProperty.AccessMethodType.

  • custom_object_identifier (Optional[str]) – CfnCertificateAuthority.AccessMethodProperty.CustomObjectIdentifier.

Link

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

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

CfnCertificateAuthority.AccessMethodProperty.AccessMethodType.

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

CfnCertificateAuthority.AccessMethodProperty.CustomObjectIdentifier.

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

Parameters
  • custom_cname (Optional[str]) – CfnCertificateAuthority.CrlConfigurationProperty.CustomCname.

  • enabled (Union[bool, IResolvable, None]) – CfnCertificateAuthority.CrlConfigurationProperty.Enabled.

  • expiration_in_days (Union[int, float, None]) – CfnCertificateAuthority.CrlConfigurationProperty.ExpirationInDays.

  • s3_bucket_name (Optional[str]) – CfnCertificateAuthority.CrlConfigurationProperty.S3BucketName.

  • s3_object_acl (Optional[str]) – CfnCertificateAuthority.CrlConfigurationProperty.S3ObjectAcl.

Link

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

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

CfnCertificateAuthority.CrlConfigurationProperty.CustomCname.

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

CfnCertificateAuthority.CrlConfigurationProperty.Enabled.

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

CfnCertificateAuthority.CrlConfigurationProperty.ExpirationInDays.

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

CfnCertificateAuthority.CrlConfigurationProperty.S3BucketName.

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

CfnCertificateAuthority.CrlConfigurationProperty.S3ObjectAcl.

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

Parameters
Link

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

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

CfnCertificateAuthority.CsrExtensionsProperty.KeyUsage.

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

CfnCertificateAuthority.CsrExtensionsProperty.SubjectInformationAccess.

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]

EdiPartyNameProperty

class CfnCertificateAuthority.EdiPartyNameProperty(*, name_assigner, party_name)

Bases: object

Parameters
  • name_assigner (str) – CfnCertificateAuthority.EdiPartyNameProperty.NameAssigner.

  • party_name (str) – CfnCertificateAuthority.EdiPartyNameProperty.PartyName.

Link

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

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

CfnCertificateAuthority.EdiPartyNameProperty.NameAssigner.

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

CfnCertificateAuthority.EdiPartyNameProperty.PartyName.

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

Parameters
  • directory_name (Union[SubjectProperty, IResolvable, None]) – CfnCertificateAuthority.GeneralNameProperty.DirectoryName.

  • dns_name (Optional[str]) – CfnCertificateAuthority.GeneralNameProperty.DnsName.

  • edi_party_name (Union[IResolvable, EdiPartyNameProperty, None]) – CfnCertificateAuthority.GeneralNameProperty.EdiPartyName.

  • ip_address (Optional[str]) – CfnCertificateAuthority.GeneralNameProperty.IpAddress.

  • other_name (Union[IResolvable, OtherNameProperty, None]) – CfnCertificateAuthority.GeneralNameProperty.OtherName.

  • registered_id (Optional[str]) – CfnCertificateAuthority.GeneralNameProperty.RegisteredId.

  • rfc822_name (Optional[str]) – CfnCertificateAuthority.GeneralNameProperty.Rfc822Name.

  • uniform_resource_identifier (Optional[str]) – CfnCertificateAuthority.GeneralNameProperty.UniformResourceIdentifier.

Link

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

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

CfnCertificateAuthority.GeneralNameProperty.DirectoryName.

Link

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

Return type

Union[SubjectProperty, IResolvable, None]

dns_name

CfnCertificateAuthority.GeneralNameProperty.DnsName.

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

CfnCertificateAuthority.GeneralNameProperty.EdiPartyName.

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

CfnCertificateAuthority.GeneralNameProperty.IpAddress.

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

CfnCertificateAuthority.GeneralNameProperty.OtherName.

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

CfnCertificateAuthority.GeneralNameProperty.RegisteredId.

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

CfnCertificateAuthority.GeneralNameProperty.Rfc822Name.

Link

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

Return type

Optional[str]

uniform_resource_identifier

CfnCertificateAuthority.GeneralNameProperty.UniformResourceIdentifier.

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

Parameters
  • crl_sign (Union[bool, IResolvable, None]) – CfnCertificateAuthority.KeyUsageProperty.CRLSign.

  • data_encipherment (Union[bool, IResolvable, None]) – CfnCertificateAuthority.KeyUsageProperty.DataEncipherment.

  • decipher_only (Union[bool, IResolvable, None]) – CfnCertificateAuthority.KeyUsageProperty.DecipherOnly.

  • digital_signature (Union[bool, IResolvable, None]) – CfnCertificateAuthority.KeyUsageProperty.DigitalSignature.

  • encipher_only (Union[bool, IResolvable, None]) – CfnCertificateAuthority.KeyUsageProperty.EncipherOnly.

  • key_agreement (Union[bool, IResolvable, None]) – CfnCertificateAuthority.KeyUsageProperty.KeyAgreement.

  • key_cert_sign (Union[bool, IResolvable, None]) – CfnCertificateAuthority.KeyUsageProperty.KeyCertSign.

  • key_encipherment (Union[bool, IResolvable, None]) – CfnCertificateAuthority.KeyUsageProperty.KeyEncipherment.

  • non_repudiation (Union[bool, IResolvable, None]) – CfnCertificateAuthority.KeyUsageProperty.NonRepudiation.

Link

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

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

CfnCertificateAuthority.KeyUsageProperty.CRLSign.

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

CfnCertificateAuthority.KeyUsageProperty.DataEncipherment.

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

CfnCertificateAuthority.KeyUsageProperty.DecipherOnly.

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

CfnCertificateAuthority.KeyUsageProperty.DigitalSignature.

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

CfnCertificateAuthority.KeyUsageProperty.EncipherOnly.

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

CfnCertificateAuthority.KeyUsageProperty.KeyAgreement.

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

CfnCertificateAuthority.KeyUsageProperty.KeyCertSign.

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

CfnCertificateAuthority.KeyUsageProperty.KeyEncipherment.

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

CfnCertificateAuthority.KeyUsageProperty.NonRepudiation.

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

Parameters
  • enabled (Union[bool, IResolvable, None]) – CfnCertificateAuthority.OcspConfigurationProperty.Enabled.

  • ocsp_custom_cname (Optional[str]) – CfnCertificateAuthority.OcspConfigurationProperty.OcspCustomCname.

Link

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

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

CfnCertificateAuthority.OcspConfigurationProperty.Enabled.

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

CfnCertificateAuthority.OcspConfigurationProperty.OcspCustomCname.

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

Parameters
  • type_id (str) – CfnCertificateAuthority.OtherNameProperty.TypeId.

  • value (str) – CfnCertificateAuthority.OtherNameProperty.Value.

Link

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

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

CfnCertificateAuthority.OtherNameProperty.TypeId.

Link

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

Return type

str

value

CfnCertificateAuthority.OtherNameProperty.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

Parameters
Link

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

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

CfnCertificateAuthority.RevocationConfigurationProperty.CrlConfiguration.

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

CfnCertificateAuthority.RevocationConfigurationProperty.OcspConfiguration.

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

Parameters
  • common_name (Optional[str]) – CfnCertificateAuthority.SubjectProperty.CommonName.

  • country (Optional[str]) – CfnCertificateAuthority.SubjectProperty.Country.

  • distinguished_name_qualifier (Optional[str]) – CfnCertificateAuthority.SubjectProperty.DistinguishedNameQualifier.

  • generation_qualifier (Optional[str]) – CfnCertificateAuthority.SubjectProperty.GenerationQualifier.

  • given_name (Optional[str]) – CfnCertificateAuthority.SubjectProperty.GivenName.

  • initials (Optional[str]) – CfnCertificateAuthority.SubjectProperty.Initials.

  • locality (Optional[str]) – CfnCertificateAuthority.SubjectProperty.Locality.

  • organization (Optional[str]) – CfnCertificateAuthority.SubjectProperty.Organization.

  • organizational_unit (Optional[str]) – CfnCertificateAuthority.SubjectProperty.OrganizationalUnit.

  • pseudonym (Optional[str]) – CfnCertificateAuthority.SubjectProperty.Pseudonym.

  • serial_number (Optional[str]) – CfnCertificateAuthority.SubjectProperty.SerialNumber.

  • state (Optional[str]) – CfnCertificateAuthority.SubjectProperty.State.

  • surname (Optional[str]) – CfnCertificateAuthority.SubjectProperty.Surname.

  • title (Optional[str]) – CfnCertificateAuthority.SubjectProperty.Title.

Link

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

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

CfnCertificateAuthority.SubjectProperty.CommonName.

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

CfnCertificateAuthority.SubjectProperty.Country.

Link

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

Return type

Optional[str]

distinguished_name_qualifier

CfnCertificateAuthority.SubjectProperty.DistinguishedNameQualifier.

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

CfnCertificateAuthority.SubjectProperty.GenerationQualifier.

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

CfnCertificateAuthority.SubjectProperty.GivenName.

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

CfnCertificateAuthority.SubjectProperty.Initials.

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

CfnCertificateAuthority.SubjectProperty.Locality.

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

CfnCertificateAuthority.SubjectProperty.Organization.

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

CfnCertificateAuthority.SubjectProperty.OrganizationalUnit.

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

CfnCertificateAuthority.SubjectProperty.Pseudonym.

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

CfnCertificateAuthority.SubjectProperty.SerialNumber.

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

CfnCertificateAuthority.SubjectProperty.State.

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

CfnCertificateAuthority.SubjectProperty.Surname.

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

CfnCertificateAuthority.SubjectProperty.Title.

Link

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

Return type

Optional[str]