CfnCertificate

class aws_cdk.aws_acmpca.CfnCertificate(scope, id, *, certificate_authority_arn, certificate_signing_request, signing_algorithm, validity, api_passthrough=None, template_arn=None, validity_not_before=None)

Bases: CfnResource

A CloudFormation AWS::ACMPCA::Certificate.

The AWS::ACMPCA::Certificate resource is used to issue a certificate using your private certificate authority. For more information, see the IssueCertificate action.

CloudformationResource:: AWS::ACMPCA::Certificate
Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html
ExampleMetadata:: fixture=_generated

Example:

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

cfn_certificate = acmpca.CfnCertificate(self, "MyCfnCertificate",
    certificate_authority_arn="certificateAuthorityArn",
    certificate_signing_request="certificateSigningRequest",
    signing_algorithm="signingAlgorithm",
    validity=acmpca.CfnCertificate.ValidityProperty(
        type="type",
        value=123
    ),

    # the properties below are optional
    api_passthrough=acmpca.CfnCertificate.ApiPassthroughProperty(
        extensions=acmpca.CfnCertificate.ExtensionsProperty(
            certificate_policies=[acmpca.CfnCertificate.PolicyInformationProperty(
                cert_policy_id="certPolicyId",

                # the properties below are optional
                policy_qualifiers=[acmpca.CfnCertificate.PolicyQualifierInfoProperty(
                    policy_qualifier_id="policyQualifierId",
                    qualifier=acmpca.CfnCertificate.QualifierProperty(
                        cps_uri="cpsUri"
                    )
                )]
            )],
            custom_extensions=[acmpca.CfnCertificate.CustomExtensionProperty(
                object_identifier="objectIdentifier",
                value="value",

                # the properties below are optional
                critical=False
            )],
            extended_key_usage=[acmpca.CfnCertificate.ExtendedKeyUsageProperty(
                extended_key_usage_object_identifier="extendedKeyUsageObjectIdentifier",
                extended_key_usage_type="extendedKeyUsageType"
            )],
            key_usage=acmpca.CfnCertificate.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_alternative_names=[acmpca.CfnCertificate.GeneralNameProperty(
                directory_name=acmpca.CfnCertificate.SubjectProperty(
                    common_name="commonName",
                    country="country",
                    custom_attributes=[acmpca.CfnCertificate.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.CfnCertificate.EdiPartyNameProperty(
                    name_assigner="nameAssigner",
                    party_name="partyName"
                ),
                ip_address="ipAddress",
                other_name=acmpca.CfnCertificate.OtherNameProperty(
                    type_id="typeId",
                    value="value"
                ),
                registered_id="registeredId",
                rfc822_name="rfc822Name",
                uniform_resource_identifier="uniformResourceIdentifier"
            )]
        ),
        subject=acmpca.CfnCertificate.SubjectProperty(
            common_name="commonName",
            country="country",
            custom_attributes=[acmpca.CfnCertificate.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"
        )
    ),
    template_arn="templateArn",
    validity_not_before=acmpca.CfnCertificate.ValidityProperty(
        type="type",
        value=123
    )
)

Create a new AWS::ACMPCA::Certificate.

Parameters:

scope (Construct) –
- scope in which this resource is defined.
id (str) –
- scoped id of the resource.
certificate_authority_arn (str) – The Amazon Resource Name (ARN) for the private CA issues the certificate.
certificate_signing_request (str) – The certificate signing request (CSR) for the certificate.
signing_algorithm (str) – The name of the algorithm that will be used to sign the certificate to be issued. This parameter should not be confused with the SigningAlgorithm parameter used to sign a CSR in the CreateCertificateAuthority action. .. epigraph:: The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA’s secret key.
validity (Union[ValidityProperty, Dict[str, Any], IResolvable]) – The period of time during which the certificate will be valid.
api_passthrough (Union[IResolvable, ApiPassthroughProperty, Dict[str, Any], None]) – Specifies X.509 certificate information to be included in the issued certificate. An APIPassthrough or APICSRPassthrough template variant must be selected, or else this parameter is ignored.
template_arn (Optional[str]) – Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, AWS Private CA defaults to the EndEntityCertificate/V1 template. For more information about AWS Private CA templates, see Using Templates .
validity_not_before (Union[ValidityProperty, Dict[str, Any], IResolvable, None]) – Information describing the start of the validity period of the certificate. This parameter sets the “Not Before” date for the certificate. By default, when issuing a certificate, AWS Private CA sets the “Not Before” date to the issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The ValidityNotBefore parameter can be used to customize the “Not Before” value. Unlike the Validity parameter, the ValidityNotBefore parameter is optional. The ValidityNotBefore value is expressed as an explicit date and time, using the Validity type value ABSOLUTE .

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:

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

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::Certificate'

api_passthrough

Specifies X.509 certificate information to be included in the issued certificate. An APIPassthrough or APICSRPassthrough template variant must be selected, or else this parameter is ignored.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-apipassthrough

attr_arn

The Amazon Resource Name (ARN) of the issued certificate.

CloudformationAttribute:: Arn

attr_certificate

The issued Base64 PEM-encoded certificate.

CloudformationAttribute:: Certificate

certificate_authority_arn

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

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-certificateauthorityarn

certificate_signing_request

The certificate signing request (CSR) for the certificate.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-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.

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 construct tree node associated with this construct.

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

signing_algorithm

The name of the algorithm that will be used to sign the certificate to be issued.

This parameter should not be confused with the SigningAlgorithm parameter used to sign a CSR in the CreateCertificateAuthority action. .. epigraph:

The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.

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

stack

The stack in which this element is defined.

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

template_arn

Specifies a custom configuration template to use when issuing a certificate.

If this parameter is not provided, AWS Private CA defaults to the EndEntityCertificate/V1 template. For more information about AWS Private CA templates, see Using Templates .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-templatearn

validity

The period of time during which the certificate will be valid.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-validity

validity_not_before

Information describing the start of the validity period of the certificate.

This parameter sets the “Not Before” date for the certificate.

By default, when issuing a certificate, AWS Private CA sets the “Not Before” date to the issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The ValidityNotBefore parameter can be used to customize the “Not Before” value.

Unlike the Validity parameter, the ValidityNotBefore parameter is optional.

The ValidityNotBefore value is expressed as an explicit date and time, using the Validity type value ABSOLUTE .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#cfn-acmpca-certificate-validitynotbefore

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

ApiPassthroughProperty

class CfnCertificate.ApiPassthroughProperty(*, extensions=None, subject=None)

Bases: object

Contains X.509 certificate information to be placed in an issued certificate. An APIPassthrough or APICSRPassthrough template variant must be selected, or else this parameter is ignored.

If conflicting or duplicate certificate information is supplied from other sources, AWS Private CA applies order of operation rules to determine what information is used.

Parameters:

extensions (Union[IResolvable, ExtensionsProperty, Dict[str, Any], None]) – Specifies X.509 extension information for a certificate.
subject (Union[IResolvable, SubjectProperty, Dict[str, Any], None]) – Contains information about the certificate subject. 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.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-apipassthrough.html

ExampleMetadata:

fixture=_generated

Example:

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

api_passthrough_property = acmpca.CfnCertificate.ApiPassthroughProperty(
    extensions=acmpca.CfnCertificate.ExtensionsProperty(
        certificate_policies=[acmpca.CfnCertificate.PolicyInformationProperty(
            cert_policy_id="certPolicyId",

            # the properties below are optional
            policy_qualifiers=[acmpca.CfnCertificate.PolicyQualifierInfoProperty(
                policy_qualifier_id="policyQualifierId",
                qualifier=acmpca.CfnCertificate.QualifierProperty(
                    cps_uri="cpsUri"
                )
            )]
        )],
        custom_extensions=[acmpca.CfnCertificate.CustomExtensionProperty(
            object_identifier="objectIdentifier",
            value="value",

            # the properties below are optional
            critical=False
        )],
        extended_key_usage=[acmpca.CfnCertificate.ExtendedKeyUsageProperty(
            extended_key_usage_object_identifier="extendedKeyUsageObjectIdentifier",
            extended_key_usage_type="extendedKeyUsageType"
        )],
        key_usage=acmpca.CfnCertificate.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_alternative_names=[acmpca.CfnCertificate.GeneralNameProperty(
            directory_name=acmpca.CfnCertificate.SubjectProperty(
                common_name="commonName",
                country="country",
                custom_attributes=[acmpca.CfnCertificate.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.CfnCertificate.EdiPartyNameProperty(
                name_assigner="nameAssigner",
                party_name="partyName"
            ),
            ip_address="ipAddress",
            other_name=acmpca.CfnCertificate.OtherNameProperty(
                type_id="typeId",
                value="value"
            ),
            registered_id="registeredId",
            rfc822_name="rfc822Name",
            uniform_resource_identifier="uniformResourceIdentifier"
        )]
    ),
    subject=acmpca.CfnCertificate.SubjectProperty(
        common_name="commonName",
        country="country",
        custom_attributes=[acmpca.CfnCertificate.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

extensions

Specifies X.509 extension information for a certificate.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-apipassthrough.html#cfn-acmpca-certificate-apipassthrough-extensions

subject

Contains information about the certificate subject.

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.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-apipassthrough.html#cfn-acmpca-certificate-apipassthrough-subject

CustomAttributeProperty

class CfnCertificate.CustomAttributeProperty(*, object_identifier, value)

Bases: object

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

Parameters:

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

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

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

Attributes

object_identifier

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

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

value

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

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

CustomExtensionProperty

class CfnCertificate.CustomExtensionProperty(*, object_identifier, value, critical=None)

Bases: object

Specifies the X.509 extension information for a certificate.

Extensions present in CustomExtensions follow the ApiPassthrough template rules .

Parameters:

object_identifier (str) – Specifies the object identifier (OID) of the X.509 extension. For more information, see the Global OID reference database..
value (str) – Specifies the base64-encoded value of the X.509 extension.
critical (Union[bool, IResolvable, None]) – Specifies the critical flag of the X.509 extension.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-customextension.html

ExampleMetadata:

fixture=_generated

Example:

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

custom_extension_property = acmpca.CfnCertificate.CustomExtensionProperty(
    object_identifier="objectIdentifier",
    value="value",

    # the properties below are optional
    critical=False
)

Attributes

critical

Specifies the critical flag of the X.509 extension.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-customextension.html#cfn-acmpca-certificate-customextension-critical

object_identifier

Specifies the object identifier (OID) of the X.509 extension. For more information, see the Global OID reference database..

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-customextension.html#cfn-acmpca-certificate-customextension-objectidentifier

value

Specifies the base64-encoded value of the X.509 extension.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-customextension.html#cfn-acmpca-certificate-customextension-value

EdiPartyNameProperty

class CfnCertificate.EdiPartyNameProperty(*, name_assigner, party_name)

Bases: object

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

Parameters:

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

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

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

Attributes

name_assigner

Specifies the name assigner.

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

party_name

Specifies the party name.

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

ExtendedKeyUsageProperty

class CfnCertificate.ExtendedKeyUsageProperty(*, extended_key_usage_object_identifier=None, extended_key_usage_type=None)

Bases: object

Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the KeyUsage extension.

Parameters:

extended_key_usage_object_identifier (Optional[str]) – Specifies a custom ExtendedKeyUsage with an object identifier (OID).
extended_key_usage_type (Optional[str]) – Specifies a standard ExtendedKeyUsage as defined as in RFC 5280 .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extendedkeyusage.html

ExampleMetadata:

fixture=_generated

Example:

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

extended_key_usage_property = acmpca.CfnCertificate.ExtendedKeyUsageProperty(
    extended_key_usage_object_identifier="extendedKeyUsageObjectIdentifier",
    extended_key_usage_type="extendedKeyUsageType"
)

Attributes

extended_key_usage_object_identifier

Specifies a custom ExtendedKeyUsage with an object identifier (OID).

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extendedkeyusage.html#cfn-acmpca-certificate-extendedkeyusage-extendedkeyusageobjectidentifier

extended_key_usage_type

Specifies a standard ExtendedKeyUsage as defined as in RFC 5280 .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extendedkeyusage.html#cfn-acmpca-certificate-extendedkeyusage-extendedkeyusagetype

ExtensionsProperty

class CfnCertificate.ExtensionsProperty(*, certificate_policies=None, custom_extensions=None, extended_key_usage=None, key_usage=None, subject_alternative_names=None)

Bases: object

Contains X.509 extension information for a certificate.

Parameters:

certificate_policies (Union[IResolvable, Sequence[Union[IResolvable, PolicyInformationProperty, Dict[str, Any]]], None]) – Contains a sequence of one or more policy information terms, each of which consists of an object identifier (OID) and optional qualifiers. For more information, see NIST’s definition of Object Identifier (OID) . In an end-entity certificate, these terms indicate the policy under which the certificate was issued and the purposes for which it may be used. In a CA certificate, these terms limit the set of policies for certification paths that include this certificate.
custom_extensions (Union[IResolvable, Sequence[Union[IResolvable, CustomExtensionProperty, Dict[str, Any]]], None]) –
Contains a sequence of one or more X.509 extensions, each of which consists of an object identifier (OID), a base64-encoded value, and the critical flag. For more information, see the Global OID reference database..
extended_key_usage (Union[IResolvable, Sequence[Union[IResolvable, ExtendedKeyUsageProperty, Dict[str, Any]]], None]) – Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the KeyUsage extension.
key_usage (Union[IResolvable, KeyUsageProperty, Dict[str, Any], None]) – Defines one or more purposes for which the key contained in the certificate can be used. Default value for each option is false.
subject_alternative_names (Union[IResolvable, Sequence[Union[IResolvable, GeneralNameProperty, Dict[str, Any]]], None]) – The subject alternative name extension allows identities to be bound to the subject of the certificate. These identities may be included in addition to or in place of the identity in the subject field of the certificate.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extensions.html

ExampleMetadata:

fixture=_generated

Example:

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

extensions_property = acmpca.CfnCertificate.ExtensionsProperty(
    certificate_policies=[acmpca.CfnCertificate.PolicyInformationProperty(
        cert_policy_id="certPolicyId",

        # the properties below are optional
        policy_qualifiers=[acmpca.CfnCertificate.PolicyQualifierInfoProperty(
            policy_qualifier_id="policyQualifierId",
            qualifier=acmpca.CfnCertificate.QualifierProperty(
                cps_uri="cpsUri"
            )
        )]
    )],
    custom_extensions=[acmpca.CfnCertificate.CustomExtensionProperty(
        object_identifier="objectIdentifier",
        value="value",

        # the properties below are optional
        critical=False
    )],
    extended_key_usage=[acmpca.CfnCertificate.ExtendedKeyUsageProperty(
        extended_key_usage_object_identifier="extendedKeyUsageObjectIdentifier",
        extended_key_usage_type="extendedKeyUsageType"
    )],
    key_usage=acmpca.CfnCertificate.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_alternative_names=[acmpca.CfnCertificate.GeneralNameProperty(
        directory_name=acmpca.CfnCertificate.SubjectProperty(
            common_name="commonName",
            country="country",
            custom_attributes=[acmpca.CfnCertificate.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.CfnCertificate.EdiPartyNameProperty(
            name_assigner="nameAssigner",
            party_name="partyName"
        ),
        ip_address="ipAddress",
        other_name=acmpca.CfnCertificate.OtherNameProperty(
            type_id="typeId",
            value="value"
        ),
        registered_id="registeredId",
        rfc822_name="rfc822Name",
        uniform_resource_identifier="uniformResourceIdentifier"
    )]
)

Attributes

certificate_policies

Contains a sequence of one or more policy information terms, each of which consists of an object identifier (OID) and optional qualifiers.

For more information, see NIST’s definition of Object Identifier (OID) .

In an end-entity certificate, these terms indicate the policy under which the certificate was issued and the purposes for which it may be used. In a CA certificate, these terms limit the set of policies for certification paths that include this certificate.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extensions.html#cfn-acmpca-certificate-extensions-certificatepolicies

custom_extensions

Contains a sequence of one or more X.509 extensions, each of which consists of an object identifier (OID), a base64-encoded value, and the critical flag. For more information, see the Global OID reference database..

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extensions.html#cfn-acmpca-certificate-extensions-customextensions

extended_key_usage

Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the KeyUsage extension.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extensions.html#cfn-acmpca-certificate-extensions-extendedkeyusage

key_usage

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

Default value for each option is false.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extensions.html#cfn-acmpca-certificate-extensions-keyusage

subject_alternative_names

The subject alternative name extension allows identities to be bound to the subject of the certificate.

These identities may be included in addition to or in place of the identity in the subject field of the certificate.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extensions.html#cfn-acmpca-certificate-extensions-subjectalternativenames

GeneralNameProperty

class CfnCertificate.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.

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

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

Attributes

directory_name

Contains information about the certificate subject.

The certificate can be one issued by your private certificate authority (CA) or it can be your private CA certificate. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate. The DN must be unique for each entity, but your private CA can issue more than one certificate with the same DN to the same entity.

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

dns_name

Represents GeneralName as a DNS name.

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

edi_party_name

Represents GeneralName as an EdiPartyName object.

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

ip_address

Represents GeneralName as an IPv4 or IPv6 address.

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

other_name

Represents GeneralName using an OtherName object.

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

registered_id

Represents GeneralName as an object identifier (OID).

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

rfc822_name

Represents GeneralName as an RFC 822 email address.

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

uniform_resource_identifier

Represents GeneralName as a URI.

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

KeyUsageProperty

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

Bases: object

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

Default value for each option is false.

Parameters:

crl_sign (Union[bool, IResolvable, None]) – Key can be used to sign CRLs.
data_encipherment (Union[bool, IResolvable, None]) – Key can be used to decipher data.
decipher_only (Union[bool, IResolvable, None]) – Key can be used only to decipher data.
digital_signature (Union[bool, IResolvable, None]) – Key can be used for digital signing.
encipher_only (Union[bool, IResolvable, None]) – Key can be used only to encipher data.
key_agreement (Union[bool, IResolvable, None]) – Key can be used in a key-agreement protocol.
key_cert_sign (Union[bool, IResolvable, None]) – Key can be used to sign certificates.
key_encipherment (Union[bool, IResolvable, None]) – Key can be used to encipher data.
non_repudiation (Union[bool, IResolvable, None]) – Key can be used for non-repudiation.

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

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

Attributes

crl_sign

Key can be used to sign CRLs.

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

data_encipherment

Key can be used to decipher data.

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

decipher_only

Key can be used only to decipher data.

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

digital_signature

Key can be used for digital signing.

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

encipher_only

Key can be used only to encipher data.

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

key_agreement

Key can be used in a key-agreement protocol.

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

key_cert_sign

Key can be used to sign certificates.

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

key_encipherment

Key can be used to encipher data.

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

non_repudiation

Key can be used for non-repudiation.

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

OtherNameProperty

class CfnCertificate.OtherNameProperty(*, type_id, value)

Bases: object

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

Parameters:

type_id (str) – Specifies an OID.
value (str) – Specifies an OID value.

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

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

Attributes

type_id

Specifies an OID.

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

value

Specifies an OID value.

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

PolicyInformationProperty

class CfnCertificate.PolicyInformationProperty(*, cert_policy_id, policy_qualifiers=None)

Bases: object

Defines the X.509 CertificatePolicies extension.

Parameters:

cert_policy_id (str) –
Specifies the object identifier (OID) of the certificate policy under which the certificate was issued. For more information, see NIST’s definition of Object Identifier (OID) .
policy_qualifiers (Union[IResolvable, Sequence[Union[IResolvable, PolicyQualifierInfoProperty, Dict[str, Any]]], None]) – Modifies the given CertPolicyId with a qualifier. AWS Private CA supports the certification practice statement (CPS) qualifier.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-policyinformation.html

ExampleMetadata:

fixture=_generated

Example:

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

policy_information_property = acmpca.CfnCertificate.PolicyInformationProperty(
    cert_policy_id="certPolicyId",

    # the properties below are optional
    policy_qualifiers=[acmpca.CfnCertificate.PolicyQualifierInfoProperty(
        policy_qualifier_id="policyQualifierId",
        qualifier=acmpca.CfnCertificate.QualifierProperty(
            cps_uri="cpsUri"
        )
    )]
)

Attributes

cert_policy_id

Specifies the object identifier (OID) of the certificate policy under which the certificate was issued.

For more information, see NIST’s definition of Object Identifier (OID) .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-policyinformation.html#cfn-acmpca-certificate-policyinformation-certpolicyid

policy_qualifiers

Modifies the given CertPolicyId with a qualifier.

AWS Private CA supports the certification practice statement (CPS) qualifier.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-policyinformation.html#cfn-acmpca-certificate-policyinformation-policyqualifiers

PolicyQualifierInfoProperty

class CfnCertificate.PolicyQualifierInfoProperty(*, policy_qualifier_id, qualifier)

Bases: object

Modifies the CertPolicyId of a PolicyInformation object with a qualifier.

AWS Private CA supports the certification practice statement (CPS) qualifier.

Parameters:

policy_qualifier_id (str) – Identifies the qualifier modifying a CertPolicyId .
qualifier (Union[IResolvable, QualifierProperty, Dict[str, Any]]) – Defines the qualifier type. AWS Private CA supports the use of a URI for a CPS qualifier in this field.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-policyqualifierinfo.html

ExampleMetadata:

fixture=_generated

Example:

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

policy_qualifier_info_property = acmpca.CfnCertificate.PolicyQualifierInfoProperty(
    policy_qualifier_id="policyQualifierId",
    qualifier=acmpca.CfnCertificate.QualifierProperty(
        cps_uri="cpsUri"
    )
)

Attributes

policy_qualifier_id

Identifies the qualifier modifying a CertPolicyId .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-policyqualifierinfo.html#cfn-acmpca-certificate-policyqualifierinfo-policyqualifierid

qualifier

Defines the qualifier type.

AWS Private CA supports the use of a URI for a CPS qualifier in this field.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-policyqualifierinfo.html#cfn-acmpca-certificate-policyqualifierinfo-qualifier

QualifierProperty

class CfnCertificate.QualifierProperty(*, cps_uri)

Bases: object

Defines a PolicyInformation qualifier.

AWS Private CA supports the certification practice statement (CPS) qualifier defined in RFC 5280.

Parameters:: cps_uri (str) – Contains a pointer to a certification practice statement (CPS) published by the CA.
Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-qualifier.html
ExampleMetadata:: fixture=_generated

Example:

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

qualifier_property = acmpca.CfnCertificate.QualifierProperty(
    cps_uri="cpsUri"
)

Attributes

cps_uri

Contains a pointer to a certification practice statement (CPS) published by the CA.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-qualifier.html#cfn-acmpca-certificate-qualifier-cpsuri

SubjectProperty

class CfnCertificate.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

Contains information about the certificate subject.

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.

Parameters:

common_name (Optional[str]) – For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit. Note: In publicly trusted certificates, the common name must be a 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. In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first.
title (Optional[str]) – A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

subject_property = acmpca.CfnCertificate.SubjectProperty(
    common_name="commonName",
    country="country",
    custom_attributes=[acmpca.CfnCertificate.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

For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit.

Note: In publicly trusted certificates, the common name must be a fully qualified domain name (FQDN) associated with the certificate subject.

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

country

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

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

custom_attributes

Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of which consists of an object identifier (OID) and a value. For more information, see NIST’s definition of Object Identifier (OID) .

Custom attributes cannot be used in combination with standard attributes.

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

distinguished_name_qualifier

Disambiguating information for the certificate subject.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-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.

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

given_name

First name.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html#cfn-acmpca-certificate-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 .

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

locality

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

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

organization

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

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

organizational_unit

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

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

pseudonym

Typically a shortened version of a longer GivenName .

For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza.

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

serial_number

The certificate serial number.

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

state

State in which the subject of the certificate is located.

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

surname

Family name.

In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first.

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

title

A title such as Mr.

or Ms., which is pre-pended to the name to refer formally to the certificate subject.

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

ValidityProperty

class CfnCertificate.ValidityProperty(*, type, value)

Bases: object

Length of time for which the certificate issued by your private certificate authority (CA), or by the private CA itself, is valid in days, months, or years.

You can issue a certificate by calling the IssueCertificate operation.

Parameters:

type (str) – Specifies whether the Value parameter represents days, months, or years.
value (Union[int, float]) – A long integer interpreted according to the value of Type , below.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-validity.html

ExampleMetadata:

fixture=_generated

Example:

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

validity_property = acmpca.CfnCertificate.ValidityProperty(
    type="type",
    value=123
)

Attributes

type

Specifies whether the Value parameter represents days, months, or years.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-validity.html#cfn-acmpca-certificate-validity-type

value

A long integer interpreted according to the value of Type , below.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-validity.html#cfn-acmpca-certificate-validity-value