CfnCertificateAuthorityPropsMixin
- class aws_cdk.mixins_preview.aws_acmpca.mixins.CfnCertificateAuthorityPropsMixin(props, *, strategy=None)
Bases:
MixinUse the
AWS::ACMPCA::CertificateAuthorityresource to create a private CA.Once the CA exists, you can use the
AWS::ACMPCA::Certificateresource to issue a new CA certificate. Alternatively, you can issue a CA certificate using an on-premises CA, and then use theAWS::ACMPCA::CertificateAuthorityActivationresource to import the new CA certificate and activate the CA. .. epigraph:Before removing a ``AWS::ACMPCA::CertificateAuthority`` resource from the CloudFormation stack, disable the affected CA. Otherwise, the action will fail. You can disable the CA by removing its associated ``AWS::ACMPCA::CertificateAuthorityActivation`` resource from CloudFormation.
- See:
- CloudformationResource:
AWS::ACMPCA::CertificateAuthority
- 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_authority_props_mixin = acmpca_mixins.CfnCertificateAuthorityPropsMixin(acmpca_mixins.CfnCertificateAuthorityMixinProps( csr_extensions=acmpca_mixins.CfnCertificateAuthorityPropsMixin.CsrExtensionsProperty( key_usage=acmpca_mixins.CfnCertificateAuthorityPropsMixin.KeyUsageProperty( crl_sign=False, data_encipherment=False, decipher_only=False, digital_signature=False, encipher_only=False, key_agreement=False, key_cert_sign=False, key_encipherment=False, non_repudiation=False ), subject_information_access=[acmpca_mixins.CfnCertificateAuthorityPropsMixin.AccessDescriptionProperty( access_location=acmpca_mixins.CfnCertificateAuthorityPropsMixin.GeneralNameProperty( directory_name=acmpca_mixins.CfnCertificateAuthorityPropsMixin.SubjectProperty( common_name="commonName", country="country", custom_attributes=[acmpca_mixins.CfnCertificateAuthorityPropsMixin.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.CfnCertificateAuthorityPropsMixin.EdiPartyNameProperty( name_assigner="nameAssigner", party_name="partyName" ), ip_address="ipAddress", other_name=acmpca_mixins.CfnCertificateAuthorityPropsMixin.OtherNameProperty( type_id="typeId", value="value" ), registered_id="registeredId", rfc822_name="rfc822Name", uniform_resource_identifier="uniformResourceIdentifier" ), access_method=acmpca_mixins.CfnCertificateAuthorityPropsMixin.AccessMethodProperty( access_method_type="accessMethodType", custom_object_identifier="customObjectIdentifier" ) )] ), key_algorithm="keyAlgorithm", key_storage_security_standard="keyStorageSecurityStandard", revocation_configuration=acmpca_mixins.CfnCertificateAuthorityPropsMixin.RevocationConfigurationProperty( crl_configuration=acmpca_mixins.CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty( crl_distribution_point_extension_configuration=acmpca_mixins.CfnCertificateAuthorityPropsMixin.CrlDistributionPointExtensionConfigurationProperty( omit_extension=False ), crl_type="crlType", custom_cname="customCname", custom_path="customPath", enabled=False, expiration_in_days=123, s3_bucket_name="s3BucketName", s3_object_acl="s3ObjectAcl" ), ocsp_configuration=acmpca_mixins.CfnCertificateAuthorityPropsMixin.OcspConfigurationProperty( enabled=False, ocsp_custom_cname="ocspCustomCname" ) ), signing_algorithm="signingAlgorithm", subject=acmpca_mixins.CfnCertificateAuthorityPropsMixin.SubjectProperty( common_name="commonName", country="country", custom_attributes=[acmpca_mixins.CfnCertificateAuthorityPropsMixin.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" ), tags=[CfnTag( key="key", value="value" )], type="type", usage_mode="usageMode" ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::ACMPCA::CertificateAuthority.- Parameters:
props (
Union[CfnCertificateAuthorityMixinProps,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 = ['csrExtensions', 'keyAlgorithm', 'keyStorageSecurityStandard', 'revocationConfiguration', 'signingAlgorithm', 'subject', 'tags', 'type', 'usageMode']
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
AccessDescriptionProperty
- class CfnCertificateAuthorityPropsMixin.AccessDescriptionProperty(*, access_location=None, access_method=None)
Bases:
objectProvides access information used by the
authorityInfoAccessandsubjectInfoAccessextensions described in RFC 5280 .- Parameters:
access_location (
Union[IResolvable,GeneralNameProperty,Dict[str,Any],None]) – The location ofAccessDescriptioninformation.access_method (
Union[IResolvable,AccessMethodProperty,Dict[str,Any],None]) – The type and format ofAccessDescriptioninformation.
- 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 access_description_property = acmpca_mixins.CfnCertificateAuthorityPropsMixin.AccessDescriptionProperty( access_location=acmpca_mixins.CfnCertificateAuthorityPropsMixin.GeneralNameProperty( directory_name=acmpca_mixins.CfnCertificateAuthorityPropsMixin.SubjectProperty( common_name="commonName", country="country", custom_attributes=[acmpca_mixins.CfnCertificateAuthorityPropsMixin.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.CfnCertificateAuthorityPropsMixin.EdiPartyNameProperty( name_assigner="nameAssigner", party_name="partyName" ), ip_address="ipAddress", other_name=acmpca_mixins.CfnCertificateAuthorityPropsMixin.OtherNameProperty( type_id="typeId", value="value" ), registered_id="registeredId", rfc822_name="rfc822Name", uniform_resource_identifier="uniformResourceIdentifier" ), access_method=acmpca_mixins.CfnCertificateAuthorityPropsMixin.AccessMethodProperty( access_method_type="accessMethodType", custom_object_identifier="customObjectIdentifier" ) )
Attributes
- access_location
The location of
AccessDescriptioninformation.
- access_method
The type and format of
AccessDescriptioninformation.
AccessMethodProperty
- class CfnCertificateAuthorityPropsMixin.AccessMethodProperty(*, access_method_type=None, custom_object_identifier=None)
Bases:
objectDescribes the type and format of extension access.
Only one of
CustomObjectIdentifierorAccessMethodTypemay be provided. Providing both results inInvalidArgsException.- Parameters:
access_method_type (
Optional[str]) – Specifies theAccessMethod.custom_object_identifier (
Optional[str]) – An object identifier (OID) specifying theAccessMethod. The OID must satisfy the regular expression shown below. For more information, see NIST’s definition of Object Identifier (OID) .
- 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 access_method_property = acmpca_mixins.CfnCertificateAuthorityPropsMixin.AccessMethodProperty( access_method_type="accessMethodType", custom_object_identifier="customObjectIdentifier" )
Attributes
- access_method_type
Specifies the
AccessMethod.
- custom_object_identifier
An object identifier (OID) specifying the
AccessMethod.The OID must satisfy the regular expression shown below. For more information, see NIST’s definition of Object Identifier (OID) .
CrlConfigurationProperty
- class CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty(*, crl_distribution_point_extension_configuration=None, crl_type=None, custom_cname=None, custom_path=None, enabled=None, expiration_in_days=None, s3_bucket_name=None, s3_object_acl=None)
Bases:
objectContains configuration information for a certificate revocation list (CRL).
Your private certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You can enable CRLs for your new or an existing private CA by setting the Enabled parameter to
true. Your private CA writes CRLs to an S3 bucket that you specify in the S3BucketName parameter. You can hide the name of your bucket by specifying a value for the CustomCname parameter. Your private CA by default copies the CNAME or the S3 bucket name to the CRL Distribution Points extension of each certificate it issues. If you want to configure this default behavior to be something different, you can set the CrlDistributionPointExtensionConfiguration parameter. Your S3 bucket policy must give write permission to AWS Private CA.AWS Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs .
Your private CA uses the value in the ExpirationInDays parameter to calculate the nextUpdate field in the CRL. The CRL is refreshed prior to a certificate’s expiration date or when a certificate is revoked. When a certificate is revoked, it appears in the CRL until the certificate expires, and then in one additional CRL after expiration, and it always appears in the audit report.
A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason a CRL update fails, AWS Private CA makes further attempts every 15 minutes.
CRLs contain the following fields:
Version : The current version number defined in RFC 5280 is V2. The integer value is 0x1.
Signature Algorithm : The name of the algorithm used to sign the CRL.
Issuer : The X.500 distinguished name of your private CA that issued the CRL.
Last Update : The issue date and time of this CRL.
Next Update : The day and time by which the next CRL will be issued.
Revoked Certificates : List of revoked certificates. Each list item contains the following information.
Serial Number : The serial number, in hexadecimal format, of the revoked certificate.
Revocation Date : Date and time the certificate was revoked.
CRL Entry Extensions : Optional extensions for the CRL entry.
X509v3 CRL Reason Code : Reason the certificate was revoked.
CRL Extensions : Optional extensions for the CRL.
X509v3 Authority Key Identifier : Identifies the public key associated with the private key used to sign the certificate.
X509v3 CRL Number: : Decimal sequence number for the CRL.
Signature Algorithm : Algorithm used by your private CA to sign the CRL.
Signature Value : Signature computed over the CRL.
Certificate revocation lists created by AWS Private CA are DER-encoded. You can use the following OpenSSL command to list a CRL.
openssl crl -inform DER -text -in *crl_path* -nooutFor more information, see Planning a certificate revocation list (CRL) in the AWS Private Certificate Authority User Guide
- Parameters:
crl_distribution_point_extension_configuration (
Union[IResolvable,CrlDistributionPointExtensionConfigurationProperty,Dict[str,Any],None]) – Configures the default behavior of the CRL Distribution Point extension for certificates issued by your CA. If this field is not provided, then the CRL Distribution Point extension will be present and contain the default CRL URL.crl_type (
Optional[str]) –Specifies the type of CRL. This setting determines the maximum number of certificates that the certificate authority can issue and revoke. For more information, see AWS Private CA quotas . -
COMPLETE- The default setting. AWS Private CA maintains a single CRL file for all unexpired certificates issued by a CA that have been revoked for any reason. Each certificate that AWS Private CA issues is bound to a specific CRL through the CRL distribution point (CDP) defined in RFC 5280 . -PARTITIONED- Compared to complete CRLs, partitioned CRLs dramatically increase the number of certificates your private CA can issue. .. epigraph:: When using partitioned CRLs, you must validate that the CRL’s associated issuing distribution point (IDP) URI matches the certificate’s CDP URI to ensure the right CRL has been fetched. AWS Private CA marks the IDP extension as critical, which your client must be able to process.custom_cname (
Optional[str]) – Name inserted into the certificate CRL Distribution Points extension that enables the use of an alias for the CRL distribution point. Use this value if you don’t want the name of your S3 bucket to be public. .. epigraph:: The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as “http://” or “https://”.custom_path (
Optional[str]) – Designates a custom file path in S3 for CRL(s). For example,http://<CustomName>/<CustomPath>/<CrlPartition_GUID>.crl.enabled (
Union[bool,IResolvable,None]) – Boolean value that specifies whether certificate revocation lists (CRLs) are enabled. You can use this value to enable certificate revocation for a new CA when you call theCreateCertificateAuthorityoperation or for an existing CA when you call theUpdateCertificateAuthorityoperation.expiration_in_days (
Union[int,float,None]) – Validity period of the CRL in days.s3_bucket_name (
Optional[str]) – Name of the S3 bucket that contains the CRL. If you do not provide a value for the CustomCname argument, the name of your S3 bucket is placed into the CRL Distribution Points extension of the issued certificate. You can change the name of your bucket by calling the UpdateCertificateAuthority operation. You must specify a bucket policy that allows AWS Private CA to write the CRL to your bucket. .. epigraph:: TheS3BucketNameparameter must conform to the S3 bucket naming rules .s3_object_acl (
Optional[str]) – Determines whether the CRL will be publicly readable or privately held in the CRL Amazon S3 bucket. If you choose PUBLIC_READ, the CRL will be accessible over the public internet. If you choose BUCKET_OWNER_FULL_CONTROL, only the owner of the CRL S3 bucket can access the CRL, and your PKI clients may need an alternative method of access. If no value is specified, the default is PUBLIC_READ. Note: This default can cause CA creation to fail in some circumstances. If you have have enabled the Block Public Access (BPA) feature in your S3 account, then you must specify the value of this parameter asBUCKET_OWNER_FULL_CONTROL, and not doing so results in an error. If you have disabled BPA in S3, then you can specify eitherBUCKET_OWNER_FULL_CONTROLorPUBLIC_READas the value. For more information, see Blocking public access to the S3 bucket .
- 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 crl_configuration_property = acmpca_mixins.CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty( crl_distribution_point_extension_configuration=acmpca_mixins.CfnCertificateAuthorityPropsMixin.CrlDistributionPointExtensionConfigurationProperty( omit_extension=False ), crl_type="crlType", custom_cname="customCname", custom_path="customPath", enabled=False, expiration_in_days=123, s3_bucket_name="s3BucketName", s3_object_acl="s3ObjectAcl" )
Attributes
- crl_distribution_point_extension_configuration
Configures the default behavior of the CRL Distribution Point extension for certificates issued by your CA.
If this field is not provided, then the CRL Distribution Point extension will be present and contain the default CRL URL.
- crl_type
Specifies the type of CRL.
This setting determines the maximum number of certificates that the certificate authority can issue and revoke. For more information, see AWS Private CA quotas .
COMPLETE- The default setting. AWS Private CA maintains a single CRL file for all unexpired certificates issued by a CA that have been revoked for any reason. Each certificate that AWS Private CA issues is bound to a specific CRL through the CRL distribution point (CDP) defined in RFC 5280 .PARTITIONED- Compared to complete CRLs, partitioned CRLs dramatically increase the number of certificates your private CA can issue.
When using partitioned CRLs, you must validate that the CRL’s associated issuing distribution point (IDP) URI matches the certificate’s CDP URI to ensure the right CRL has been fetched. AWS Private CA marks the IDP extension as critical, which your client must be able to process.
- custom_cname
Name inserted into the certificate CRL Distribution Points extension that enables the use of an alias for the CRL distribution point.
Use this value if you don’t want the name of your S3 bucket to be public. .. epigraph:
The content of a Canonical Name (CNAME) record must conform to `RFC2396 <https://docs.aws.amazon.com/https://www.ietf.org/rfc/rfc2396.txt>`_ restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as "http://" or "https://".
- custom_path
Designates a custom file path in S3 for CRL(s).
For example,
http://<CustomName>/<CustomPath>/<CrlPartition_GUID>.crl.
- enabled
Boolean value that specifies whether certificate revocation lists (CRLs) are enabled.
You can use this value to enable certificate revocation for a new CA when you call the
CreateCertificateAuthorityoperation or for an existing CA when you call theUpdateCertificateAuthorityoperation.
- expiration_in_days
Validity period of the CRL in days.
- s3_bucket_name
Name of the S3 bucket that contains the CRL.
If you do not provide a value for the CustomCname argument, the name of your S3 bucket is placed into the CRL Distribution Points extension of the issued certificate. You can change the name of your bucket by calling the UpdateCertificateAuthority operation. You must specify a bucket policy that allows AWS Private CA to write the CRL to your bucket. .. epigraph:
The ``S3BucketName`` parameter must conform to the `S3 bucket naming rules <https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html>`_ .
- s3_object_acl
Determines whether the CRL will be publicly readable or privately held in the CRL Amazon S3 bucket.
If you choose PUBLIC_READ, the CRL will be accessible over the public internet. If you choose BUCKET_OWNER_FULL_CONTROL, only the owner of the CRL S3 bucket can access the CRL, and your PKI clients may need an alternative method of access.
If no value is specified, the default is PUBLIC_READ.
Note: This default can cause CA creation to fail in some circumstances. If you have have enabled the Block Public Access (BPA) feature in your S3 account, then you must specify the value of this parameter as
BUCKET_OWNER_FULL_CONTROL, and not doing so results in an error. If you have disabled BPA in S3, then you can specify eitherBUCKET_OWNER_FULL_CONTROLorPUBLIC_READas the value.For more information, see Blocking public access to the S3 bucket .
CrlDistributionPointExtensionConfigurationProperty
- class CfnCertificateAuthorityPropsMixin.CrlDistributionPointExtensionConfigurationProperty(*, omit_extension=None)
Bases:
objectContains configuration information for the default behavior of the CRL Distribution Point (CDP) extension in certificates issued by your CA.
This extension contains a link to download the CRL, so you can check whether a certificate has been revoked. To choose whether you want this extension omitted or not in certificates issued by your CA, you can set the OmitExtension parameter.
- Parameters:
omit_extension (
Union[bool,IResolvable,None]) – Configures whether the CRL Distribution Point extension should be populated with the default URL to the CRL. If set totrue, then the CDP extension will not be present in any certificates issued by that CA unless otherwise specified through CSR or API passthrough. .. epigraph:: Only set this if you have another way to distribute the CRL Distribution Points for certificates issued by your CA, such as the Matter Distributed Compliance Ledger. This configuration cannot be enabled with a custom CNAME set.- See:
- 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 crl_distribution_point_extension_configuration_property = acmpca_mixins.CfnCertificateAuthorityPropsMixin.CrlDistributionPointExtensionConfigurationProperty( omit_extension=False )
Attributes
- omit_extension
Configures whether the CRL Distribution Point extension should be populated with the default URL to the CRL.
If set to
true, then the CDP extension will not be present in any certificates issued by that CA unless otherwise specified through CSR or API passthrough. .. epigraph:Only set this if you have another way to distribute the CRL Distribution Points for certificates issued by your CA, such as the Matter Distributed Compliance Ledger. This configuration cannot be enabled with a custom CNAME set.
CsrExtensionsProperty
- class CfnCertificateAuthorityPropsMixin.CsrExtensionsProperty(*, key_usage=None, subject_information_access=None)
Bases:
objectDescribes the certificate extensions to be added to the certificate signing request (CSR).
- Parameters:
key_usage (
Union[IResolvable,KeyUsageProperty,Dict[str,Any],None]) – Indicates the purpose of the certificate and of the key contained in the certificate.subject_information_access (
Union[IResolvable,Sequence[Union[IResolvable,AccessDescriptionProperty,Dict[str,Any]]],None]) – For CA certificates, provides a path to additional information pertaining to the CA, such as revocation and policy. For more information, see Subject Information Access in RFC 5280.
- See:
- 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 csr_extensions_property = acmpca_mixins.CfnCertificateAuthorityPropsMixin.CsrExtensionsProperty( key_usage=acmpca_mixins.CfnCertificateAuthorityPropsMixin.KeyUsageProperty( crl_sign=False, data_encipherment=False, decipher_only=False, digital_signature=False, encipher_only=False, key_agreement=False, key_cert_sign=False, key_encipherment=False, non_repudiation=False ), subject_information_access=[acmpca_mixins.CfnCertificateAuthorityPropsMixin.AccessDescriptionProperty( access_location=acmpca_mixins.CfnCertificateAuthorityPropsMixin.GeneralNameProperty( directory_name=acmpca_mixins.CfnCertificateAuthorityPropsMixin.SubjectProperty( common_name="commonName", country="country", custom_attributes=[acmpca_mixins.CfnCertificateAuthorityPropsMixin.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.CfnCertificateAuthorityPropsMixin.EdiPartyNameProperty( name_assigner="nameAssigner", party_name="partyName" ), ip_address="ipAddress", other_name=acmpca_mixins.CfnCertificateAuthorityPropsMixin.OtherNameProperty( type_id="typeId", value="value" ), registered_id="registeredId", rfc822_name="rfc822Name", uniform_resource_identifier="uniformResourceIdentifier" ), access_method=acmpca_mixins.CfnCertificateAuthorityPropsMixin.AccessMethodProperty( access_method_type="accessMethodType", custom_object_identifier="customObjectIdentifier" ) )] )
Attributes
- key_usage
Indicates the purpose of the certificate and of the key contained in the certificate.
- subject_information_access
For CA certificates, provides a path to additional information pertaining to the CA, such as revocation and policy.
For more information, see Subject Information Access in RFC 5280.
CustomAttributeProperty
- class CfnCertificateAuthorityPropsMixin.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.CfnCertificateAuthorityPropsMixin.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).
EdiPartyNameProperty
- class CfnCertificateAuthorityPropsMixin.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.CfnCertificateAuthorityPropsMixin.EdiPartyNameProperty( name_assigner="nameAssigner", party_name="partyName" )
Attributes
- name_assigner
Specifies the name assigner.
GeneralNameProperty
- class CfnCertificateAuthorityPropsMixin.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.CfnCertificateAuthorityPropsMixin.GeneralNameProperty( directory_name=acmpca_mixins.CfnCertificateAuthorityPropsMixin.SubjectProperty( common_name="commonName", country="country", custom_attributes=[acmpca_mixins.CfnCertificateAuthorityPropsMixin.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.CfnCertificateAuthorityPropsMixin.EdiPartyNameProperty( name_assigner="nameAssigner", party_name="partyName" ), ip_address="ipAddress", other_name=acmpca_mixins.CfnCertificateAuthorityPropsMixin.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 CfnCertificateAuthorityPropsMixin.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.CfnCertificateAuthorityPropsMixin.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.
OcspConfigurationProperty
- class CfnCertificateAuthorityPropsMixin.OcspConfigurationProperty(*, enabled=None, ocsp_custom_cname=None)
Bases:
objectContains information to enable and configure Online Certificate Status Protocol (OCSP) for validating certificate revocation status.
- Parameters:
enabled (
Union[bool,IResolvable,None]) – Flag enabling use of the Online Certificate Status Protocol (OCSP) for validating certificate revocation status.ocsp_custom_cname (
Optional[str]) –By default, AWS Private CA injects an Amazon domain into certificates being validated by the Online Certificate Status Protocol (OCSP). A customer can alternatively use this object to define a CNAME specifying a customized OCSP domain. .. epigraph:: The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as “http://” or “https://”.
- See:
- 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 ocsp_configuration_property = acmpca_mixins.CfnCertificateAuthorityPropsMixin.OcspConfigurationProperty( enabled=False, ocsp_custom_cname="ocspCustomCname" )
Attributes
- enabled
Flag enabling use of the Online Certificate Status Protocol (OCSP) for validating certificate revocation status.
- ocsp_custom_cname
By default, AWS Private CA injects an Amazon domain into certificates being validated by the Online Certificate Status Protocol (OCSP).
A customer can alternatively use this object to define a CNAME specifying a customized OCSP domain. .. epigraph:
The content of a Canonical Name (CNAME) record must conform to `RFC2396 <https://docs.aws.amazon.com/https://www.ietf.org/rfc/rfc2396.txt>`_ restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as "http://" or "https://".
OtherNameProperty
- class CfnCertificateAuthorityPropsMixin.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.CfnCertificateAuthorityPropsMixin.OtherNameProperty( type_id="typeId", value="value" )
Attributes
- type_id
Specifies an OID.
RevocationConfigurationProperty
- class CfnCertificateAuthorityPropsMixin.RevocationConfigurationProperty(*, crl_configuration=None, ocsp_configuration=None)
Bases:
objectCertificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions. Your private certificate authority (CA) can configure Online Certificate Status Protocol (OCSP) support and/or maintain a certificate revocation list (CRL). OCSP returns validation information about certificates as requested by clients, and a CRL contains an updated list of certificates revoked by your CA. For more information, see RevokeCertificate in the AWS Private CA API Reference and Setting up a certificate revocation method in the AWS Private CA User Guide .
The following requirements and constraints apply to revocation configurations.
A configuration disabling CRLs or OCSP must contain only the
Enabled=Falseparameter, and will fail if other parameters such asCustomCnameorExpirationInDaysare included.In a CRL configuration, the
S3BucketNameparameter must conform to the Amazon S3 bucket naming rules .A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.
In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as “http://” or “https://”.
To revoke a certificate, delete the resource from your template, and call the AWS Private CA RevokeCertificate API and specify the resource’s certificate authority ARN.
- Parameters:
crl_configuration (
Union[IResolvable,CrlConfigurationProperty,Dict[str,Any],None]) – Configuration of the certificate revocation list (CRL), if any, maintained by your private CA.ocsp_configuration (
Union[IResolvable,OcspConfigurationProperty,Dict[str,Any],None]) – Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained by your private CA.
- See:
- 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 revocation_configuration_property = acmpca_mixins.CfnCertificateAuthorityPropsMixin.RevocationConfigurationProperty( crl_configuration=acmpca_mixins.CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty( crl_distribution_point_extension_configuration=acmpca_mixins.CfnCertificateAuthorityPropsMixin.CrlDistributionPointExtensionConfigurationProperty( omit_extension=False ), crl_type="crlType", custom_cname="customCname", custom_path="customPath", enabled=False, expiration_in_days=123, s3_bucket_name="s3BucketName", s3_object_acl="s3ObjectAcl" ), ocsp_configuration=acmpca_mixins.CfnCertificateAuthorityPropsMixin.OcspConfigurationProperty( enabled=False, ocsp_custom_cname="ocspCustomCname" ) )
Attributes
- crl_configuration
Configuration of the certificate revocation list (CRL), if any, maintained by your private CA.
- ocsp_configuration
Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained by your private CA.
SubjectProperty
- class CfnCertificateAuthorityPropsMixin.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:
objectASN1 subject for the certificate authority.
- Parameters:
common_name (
Optional[str]) – Fully qualified domain name (FQDN) associated with the certificate subject.country (
Optional[str]) – Two-digit code that specifies the country in which the certificate subject located.custom_attributes (
Union[IResolvable,Sequence[Union[IResolvable,CustomAttributeProperty,Dict[str,Any]]],None]) –Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of which consists of an object identifier (OID) and a value. For more information, see NIST’s definition of Object Identifier (OID) . .. epigraph:: Custom attributes cannot be used in combination with standard attributes.
distinguished_name_qualifier (
Optional[str]) – Disambiguating information for the certificate subject.generation_qualifier (
Optional[str]) – Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.given_name (
Optional[str]) – First name.initials (
Optional[str]) – Concatenation that typically contains the first letter of the GivenName, the first letter of the middle name if one exists, and the first letter of the SurName.locality (
Optional[str]) – The locality (such as a city or town) in which the certificate subject is located.organization (
Optional[str]) – Legal name of the organization with which the certificate subject is affiliated.organizational_unit (
Optional[str]) – A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.pseudonym (
Optional[str]) – Typically a shortened version of a longer GivenName. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza.serial_number (
Optional[str]) – The certificate serial number.state (
Optional[str]) – State in which the subject of the certificate is located.surname (
Optional[str]) – Family name.title (
Optional[str]) – A personal title such as Mr.
- See:
- 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.CfnCertificateAuthorityPropsMixin.SubjectProperty( common_name="commonName", country="country", custom_attributes=[acmpca_mixins.CfnCertificateAuthorityPropsMixin.CustomAttributeProperty( object_identifier="objectIdentifier", value="value" )], distinguished_name_qualifier="distinguishedNameQualifier", generation_qualifier="generationQualifier", given_name="givenName", initials="initials", locality="locality", organization="organization", organizational_unit="organizationalUnit", pseudonym="pseudonym", serial_number="serialNumber", state="state", surname="surname", title="title" )
Attributes
- common_name
Fully qualified domain name (FQDN) associated with the certificate subject.
- 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.