CfnCertificateProps

class aws_cdk.aws_acmpca.CfnCertificateProps(*, certificate_authority_arn, certificate_signing_request, signing_algorithm, validity, api_passthrough=None, template_arn=None, validity_not_before=None)

Bases: object

Properties for defining a CfnCertificate.

Parameters

• 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, IResolvable]) – The period of time during which the certificate will be valid.

• api_passthrough (Union[IResolvable, ApiPassthroughProperty, 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, ACM Private CA defaults to the EndEntityCertificate/V1 template. For more information about ACM Private CA templates, see Using Templates .

• validity_not_before (Union[ValidityProperty, 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, ACM 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

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_props = acmpca.CfnCertificateProps(
    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
    )
)

Attributes

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

Return type

Union[IResolvable, ApiPassthroughProperty, None]

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

Return type

str

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

Return type

str

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

Return type

str

template_arn

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

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

Link

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

Return type

Optional[str]

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

Return type

Union[ValidityProperty, IResolvable]

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

Return type

Union[ValidityProperty, IResolvable, None]