CfnCertificatePropsMixin
- class aws_cdk.mixins_preview.aws_acmpca.mixins.CfnCertificatePropsMixin(props, *, strategy=None)
Bases:
MixinThe
AWS::ACMPCA::Certificateresource is used to issue a certificate using your private certificate authority.For more information, see the IssueCertificate action.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html
- CloudformationResource:
AWS::ACMPCA::Certificate
- Mixin:
true
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview import mixins from aws_cdk.mixins_preview.aws_acmpca import mixins as acmpca_mixins cfn_certificate_props_mixin = acmpca_mixins.CfnCertificatePropsMixin(acmpca_mixins.CfnCertificateMixinProps( api_passthrough=acmpca_mixins.CfnCertificatePropsMixin.ApiPassthroughProperty( extensions=acmpca_mixins.CfnCertificatePropsMixin.ExtensionsProperty( certificate_policies=[acmpca_mixins.CfnCertificatePropsMixin.PolicyInformationProperty( cert_policy_id="certPolicyId", policy_qualifiers=[acmpca_mixins.CfnCertificatePropsMixin.PolicyQualifierInfoProperty( policy_qualifier_id="policyQualifierId", qualifier=acmpca_mixins.CfnCertificatePropsMixin.QualifierProperty( cps_uri="cpsUri" ) )] )], custom_extensions=[acmpca_mixins.CfnCertificatePropsMixin.CustomExtensionProperty( critical=False, object_identifier="objectIdentifier", value="value" )], extended_key_usage=[acmpca_mixins.CfnCertificatePropsMixin.ExtendedKeyUsageProperty( extended_key_usage_object_identifier="extendedKeyUsageObjectIdentifier", extended_key_usage_type="extendedKeyUsageType" )], key_usage=acmpca_mixins.CfnCertificatePropsMixin.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_mixins.CfnCertificatePropsMixin.GeneralNameProperty( directory_name=acmpca_mixins.CfnCertificatePropsMixin.SubjectProperty( common_name="commonName", country="country", custom_attributes=[acmpca_mixins.CfnCertificatePropsMixin.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_mixins.CfnCertificatePropsMixin.EdiPartyNameProperty( name_assigner="nameAssigner", party_name="partyName" ), ip_address="ipAddress", other_name=acmpca_mixins.CfnCertificatePropsMixin.OtherNameProperty( type_id="typeId", value="value" ), registered_id="registeredId", rfc822_name="rfc822Name", uniform_resource_identifier="uniformResourceIdentifier" )] ), subject=acmpca_mixins.CfnCertificatePropsMixin.SubjectProperty( common_name="commonName", country="country", custom_attributes=[acmpca_mixins.CfnCertificatePropsMixin.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" ) ), certificate_authority_arn="certificateAuthorityArn", certificate_signing_request="certificateSigningRequest", signing_algorithm="signingAlgorithm", template_arn="templateArn", validity=acmpca_mixins.CfnCertificatePropsMixin.ValidityProperty( type="type", value=123 ), validity_not_before=acmpca_mixins.CfnCertificatePropsMixin.ValidityProperty( type="type", value=123 ) ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::ACMPCA::Certificate.- Parameters:
props (
Union[CfnCertificateMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['apiPassthrough', 'certificateAuthorityArn', 'certificateSigningRequest', 'signingAlgorithm', 'templateArn', 'validity', 'validityNotBefore']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
ApiPassthroughProperty
- class CfnCertificatePropsMixin.ApiPassthroughProperty(*, extensions=None, subject=None)
Bases:
objectContains X.509 certificate information to be placed in an issued certificate. An
APIPassthroughorAPICSRPassthroughtemplate 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.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_acmpca import mixins as acmpca_mixins api_passthrough_property = acmpca_mixins.CfnCertificatePropsMixin.ApiPassthroughProperty( extensions=acmpca_mixins.CfnCertificatePropsMixin.ExtensionsProperty( certificate_policies=[acmpca_mixins.CfnCertificatePropsMixin.PolicyInformationProperty( cert_policy_id="certPolicyId", policy_qualifiers=[acmpca_mixins.CfnCertificatePropsMixin.PolicyQualifierInfoProperty( policy_qualifier_id="policyQualifierId", qualifier=acmpca_mixins.CfnCertificatePropsMixin.QualifierProperty( cps_uri="cpsUri" ) )] )], custom_extensions=[acmpca_mixins.CfnCertificatePropsMixin.CustomExtensionProperty( critical=False, object_identifier="objectIdentifier", value="value" )], extended_key_usage=[acmpca_mixins.CfnCertificatePropsMixin.ExtendedKeyUsageProperty( extended_key_usage_object_identifier="extendedKeyUsageObjectIdentifier", extended_key_usage_type="extendedKeyUsageType" )], key_usage=acmpca_mixins.CfnCertificatePropsMixin.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_mixins.CfnCertificatePropsMixin.GeneralNameProperty( directory_name=acmpca_mixins.CfnCertificatePropsMixin.SubjectProperty( common_name="commonName", country="country", custom_attributes=[acmpca_mixins.CfnCertificatePropsMixin.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_mixins.CfnCertificatePropsMixin.EdiPartyNameProperty( name_assigner="nameAssigner", party_name="partyName" ), ip_address="ipAddress", other_name=acmpca_mixins.CfnCertificatePropsMixin.OtherNameProperty( type_id="typeId", value="value" ), registered_id="registeredId", rfc822_name="rfc822Name", uniform_resource_identifier="uniformResourceIdentifier" )] ), subject=acmpca_mixins.CfnCertificatePropsMixin.SubjectProperty( common_name="commonName", country="country", custom_attributes=[acmpca_mixins.CfnCertificatePropsMixin.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.
- 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.
CustomAttributeProperty
- class CfnCertificatePropsMixin.CustomAttributeProperty(*, object_identifier=None, value=None)
Bases:
objectDefines the X.500 relative distinguished name (RDN).
- Parameters:
object_identifier (
Optional[str]) – Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).value (
Optional[str]) – Specifies the attribute value of relative distinguished name (RDN).
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_acmpca import mixins as acmpca_mixins custom_attribute_property = acmpca_mixins.CfnCertificatePropsMixin.CustomAttributeProperty( object_identifier="objectIdentifier", value="value" )
Attributes
- object_identifier
Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).
- value
Specifies the attribute value of relative distinguished name (RDN).
CustomExtensionProperty
- class CfnCertificatePropsMixin.CustomExtensionProperty(*, critical=None, object_identifier=None, value=None)
Bases:
objectSpecifies the X.509 extension information for a certificate.
Extensions present in
CustomExtensionsfollow theApiPassthroughtemplate rules .- Parameters:
critical (
Union[bool,IResolvable,None]) – Specifies the critical flag of the X.509 extension.object_identifier (
Optional[str]) – Specifies the object identifier (OID) of the X.509 extension. For more information, see the Global OID reference database..value (
Optional[str]) – Specifies the base64-encoded value of the X.509 extension.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_acmpca import mixins as acmpca_mixins custom_extension_property = acmpca_mixins.CfnCertificatePropsMixin.CustomExtensionProperty( critical=False, object_identifier="objectIdentifier", value="value" )
Attributes
- critical
Specifies the critical flag of the X.509 extension.
- object_identifier
Specifies the object identifier (OID) of the X.509 extension. For more information, see the Global OID reference database..
- value
Specifies the base64-encoded value of the X.509 extension.
EdiPartyNameProperty
- class CfnCertificatePropsMixin.EdiPartyNameProperty(*, name_assigner=None, party_name=None)
Bases:
objectDescribes an Electronic Data Interchange (EDI) entity as described in as defined in Subject Alternative Name in RFC 5280.
- Parameters:
name_assigner (
Optional[str]) – Specifies the name assigner.party_name (
Optional[str]) – Specifies the party name.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_acmpca import mixins as acmpca_mixins edi_party_name_property = acmpca_mixins.CfnCertificatePropsMixin.EdiPartyNameProperty( name_assigner="nameAssigner", party_name="partyName" )
Attributes
- name_assigner
Specifies the name assigner.
- party_name
Specifies the party name.
ExtendedKeyUsageProperty
- class CfnCertificatePropsMixin.ExtendedKeyUsageProperty(*, extended_key_usage_object_identifier=None, extended_key_usage_type=None)
Bases:
objectSpecifies additional purposes for which the certified public key may be used other than basic purposes indicated in the
KeyUsageextension.- Parameters:
extended_key_usage_object_identifier (
Optional[str]) – Specifies a customExtendedKeyUsagewith an object identifier (OID).extended_key_usage_type (
Optional[str]) – Specifies a standardExtendedKeyUsageas defined as in RFC 5280 .
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_acmpca import mixins as acmpca_mixins extended_key_usage_property = acmpca_mixins.CfnCertificatePropsMixin.ExtendedKeyUsageProperty( extended_key_usage_object_identifier="extendedKeyUsageObjectIdentifier", extended_key_usage_type="extendedKeyUsageType" )
Attributes
- extended_key_usage_object_identifier
Specifies a custom
ExtendedKeyUsagewith an object identifier (OID).
ExtensionsProperty
- class CfnCertificatePropsMixin.ExtensionsProperty(*, certificate_policies=None, custom_extensions=None, extended_key_usage=None, key_usage=None, subject_alternative_names=None)
Bases:
objectContains 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 theKeyUsageextension.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.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_acmpca import mixins as acmpca_mixins extensions_property = acmpca_mixins.CfnCertificatePropsMixin.ExtensionsProperty( certificate_policies=[acmpca_mixins.CfnCertificatePropsMixin.PolicyInformationProperty( cert_policy_id="certPolicyId", policy_qualifiers=[acmpca_mixins.CfnCertificatePropsMixin.PolicyQualifierInfoProperty( policy_qualifier_id="policyQualifierId", qualifier=acmpca_mixins.CfnCertificatePropsMixin.QualifierProperty( cps_uri="cpsUri" ) )] )], custom_extensions=[acmpca_mixins.CfnCertificatePropsMixin.CustomExtensionProperty( critical=False, object_identifier="objectIdentifier", value="value" )], extended_key_usage=[acmpca_mixins.CfnCertificatePropsMixin.ExtendedKeyUsageProperty( extended_key_usage_object_identifier="extendedKeyUsageObjectIdentifier", extended_key_usage_type="extendedKeyUsageType" )], key_usage=acmpca_mixins.CfnCertificatePropsMixin.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_mixins.CfnCertificatePropsMixin.GeneralNameProperty( directory_name=acmpca_mixins.CfnCertificatePropsMixin.SubjectProperty( common_name="commonName", country="country", custom_attributes=[acmpca_mixins.CfnCertificatePropsMixin.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_mixins.CfnCertificatePropsMixin.EdiPartyNameProperty( name_assigner="nameAssigner", party_name="partyName" ), ip_address="ipAddress", other_name=acmpca_mixins.CfnCertificatePropsMixin.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.
- 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..
- extended_key_usage
Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the
KeyUsageextension.
- 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.
- 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.
GeneralNameProperty
- class CfnCertificatePropsMixin.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:
objectDescribes an ASN.1 X.400
GeneralNameas defined in RFC 5280 . Only one of the following naming options should be provided. Providing more than one option results in anInvalidArgsExceptionerror.- 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]) – RepresentsGeneralNameas a DNS name.edi_party_name (
Union[IResolvable,EdiPartyNameProperty,Dict[str,Any],None]) – RepresentsGeneralNameas anEdiPartyNameobject.ip_address (
Optional[str]) – RepresentsGeneralNameas an IPv4 or IPv6 address.other_name (
Union[IResolvable,OtherNameProperty,Dict[str,Any],None]) – RepresentsGeneralNameusing anOtherNameobject.registered_id (
Optional[str]) – RepresentsGeneralNameas an object identifier (OID).rfc822_name (
Optional[str]) – RepresentsGeneralNameas an RFC 822 email address.uniform_resource_identifier (
Optional[str]) – RepresentsGeneralNameas a URI.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_acmpca import mixins as acmpca_mixins general_name_property = acmpca_mixins.CfnCertificatePropsMixin.GeneralNameProperty( directory_name=acmpca_mixins.CfnCertificatePropsMixin.SubjectProperty( common_name="commonName", country="country", custom_attributes=[acmpca_mixins.CfnCertificatePropsMixin.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_mixins.CfnCertificatePropsMixin.EdiPartyNameProperty( name_assigner="nameAssigner", party_name="partyName" ), ip_address="ipAddress", other_name=acmpca_mixins.CfnCertificatePropsMixin.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.
- dns_name
Represents
GeneralNameas a DNS name.
- edi_party_name
Represents
GeneralNameas anEdiPartyNameobject.
- ip_address
Represents
GeneralNameas an IPv4 or IPv6 address.
- other_name
Represents
GeneralNameusing anOtherNameobject.
- registered_id
Represents
GeneralNameas an object identifier (OID).
- uniform_resource_identifier
Represents
GeneralNameas a URI.
KeyUsageProperty
- class CfnCertificatePropsMixin.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:
objectDefines one or more purposes for which the key contained in the certificate can be used.
Default value for each option is false.
- Parameters:
crl_sign (
Union[bool,IResolvable,None]) – Key can be used to sign CRLs. Default: - falsedata_encipherment (
Union[bool,IResolvable,None]) – Key can be used to decipher data. Default: - falsedecipher_only (
Union[bool,IResolvable,None]) – Key can be used only to decipher data. Default: - falsedigital_signature (
Union[bool,IResolvable,None]) – Key can be used for digital signing. Default: - falseencipher_only (
Union[bool,IResolvable,None]) – Key can be used only to encipher data. Default: - falsekey_agreement (
Union[bool,IResolvable,None]) – Key can be used in a key-agreement protocol. Default: - falsekey_cert_sign (
Union[bool,IResolvable,None]) – Key can be used to sign certificates. Default: - falsekey_encipherment (
Union[bool,IResolvable,None]) – Key can be used to encipher data. Default: - falsenon_repudiation (
Union[bool,IResolvable,None]) – Key can be used for non-repudiation. Default: - false
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_acmpca import mixins as acmpca_mixins key_usage_property = acmpca_mixins.CfnCertificatePropsMixin.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.
- data_encipherment
Key can be used to decipher data.
- decipher_only
Key can be used only to decipher data.
- digital_signature
Key can be used for digital signing.
- encipher_only
Key can be used only to encipher data.
- key_agreement
Key can be used in a key-agreement protocol.
- key_cert_sign
Key can be used to sign certificates.
- key_encipherment
Key can be used to encipher data.
- non_repudiation
Key can be used for non-repudiation.
OtherNameProperty
- class CfnCertificatePropsMixin.OtherNameProperty(*, type_id=None, value=None)
Bases:
objectDefines a custom ASN.1 X.400
GeneralNameusing 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 (
Optional[str]) – Specifies an OID.value (
Optional[str]) – Specifies an OID value.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_acmpca import mixins as acmpca_mixins other_name_property = acmpca_mixins.CfnCertificatePropsMixin.OtherNameProperty( type_id="typeId", value="value" )
Attributes
- type_id
Specifies an OID.
PolicyInformationProperty
- class CfnCertificatePropsMixin.PolicyInformationProperty(*, cert_policy_id=None, policy_qualifiers=None)
Bases:
objectDefines the X.509
CertificatePoliciesextension.- Parameters:
cert_policy_id (
Optional[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 givenCertPolicyIdwith a qualifier. AWS Private CA supports the certification practice statement (CPS) qualifier.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_acmpca import mixins as acmpca_mixins policy_information_property = acmpca_mixins.CfnCertificatePropsMixin.PolicyInformationProperty( cert_policy_id="certPolicyId", policy_qualifiers=[acmpca_mixins.CfnCertificatePropsMixin.PolicyQualifierInfoProperty( policy_qualifier_id="policyQualifierId", qualifier=acmpca_mixins.CfnCertificatePropsMixin.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) .
- policy_qualifiers
Modifies the given
CertPolicyIdwith a qualifier.AWS Private CA supports the certification practice statement (CPS) qualifier.
PolicyQualifierInfoProperty
- class CfnCertificatePropsMixin.PolicyQualifierInfoProperty(*, policy_qualifier_id=None, qualifier=None)
Bases:
objectModifies the
CertPolicyIdof aPolicyInformationobject with a qualifier.AWS Private CA supports the certification practice statement (CPS) qualifier.
- Parameters:
policy_qualifier_id (
Optional[str]) – Identifies the qualifier modifying aCertPolicyId.qualifier (
Union[IResolvable,QualifierProperty,Dict[str,Any],None]) – Defines the qualifier type. AWS Private CA supports the use of a URI for a CPS qualifier in this field.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_acmpca import mixins as acmpca_mixins policy_qualifier_info_property = acmpca_mixins.CfnCertificatePropsMixin.PolicyQualifierInfoProperty( policy_qualifier_id="policyQualifierId", qualifier=acmpca_mixins.CfnCertificatePropsMixin.QualifierProperty( cps_uri="cpsUri" ) )
Attributes
- policy_qualifier_id
Identifies the qualifier modifying a
CertPolicyId.
- qualifier
Defines the qualifier type.
AWS Private CA supports the use of a URI for a CPS qualifier in this field.
QualifierProperty
- class CfnCertificatePropsMixin.QualifierProperty(*, cps_uri=None)
Bases:
objectDefines a
PolicyInformationqualifier.AWS Private CA supports the certification practice statement (CPS) qualifier defined in RFC 5280.
- Parameters:
cps_uri (
Optional[str]) – Contains a pointer to a certification practice statement (CPS) published by the CA.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_acmpca import mixins as acmpca_mixins qualifier_property = acmpca_mixins.CfnCertificatePropsMixin.QualifierProperty( cps_uri="cpsUri" )
Attributes
- cps_uri
Contains a pointer to a certification practice statement (CPS) published by the CA.
SubjectProperty
- class CfnCertificatePropsMixin.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:
objectContains information about the certificate subject.
The
Subjectfield 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. TheSubjectmust 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.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_acmpca import mixins as acmpca_mixins subject_property = acmpca_mixins.CfnCertificatePropsMixin.SubjectProperty( common_name="commonName", country="country", custom_attributes=[acmpca_mixins.CfnCertificatePropsMixin.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.
- country
Two-digit code that specifies the country in which the certificate subject located.
- 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.
- distinguished_name_qualifier
Disambiguating information for the certificate subject.
- generation_qualifier
Typically a qualifier appended to the name of an individual.
Examples include Jr. for junior, Sr. for senior, and III for third.
- given_name
First name.
- 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 .
- locality
The locality (such as a city or town) in which the certificate subject is located.
- organization
Legal name of the organization with which the certificate subject is affiliated.
- organizational_unit
A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.
- 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.
- serial_number
The certificate serial number.
- state
State in which the subject of the certificate is located.
- 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.
- title
A title such as Mr.
or Ms., which is pre-pended to the name to refer formally to the certificate subject.
ValidityProperty
- class CfnCertificatePropsMixin.ValidityProperty(*, type=None, value=None)
Bases:
objectLength 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
IssueCertificateoperation.- Parameters:
type (
Optional[str]) – Specifies whether theValueparameter represents days, months, or years.value (
Union[int,float,None]) – A long integer interpreted according to the value ofType, below.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_acmpca import mixins as acmpca_mixins validity_property = acmpca_mixins.CfnCertificatePropsMixin.ValidityProperty( type="type", value=123 )
Attributes
- type
Specifies whether the
Valueparameter represents days, months, or years.
- value
A long integer interpreted according to the value of
Type, below.