aws-cdk-lib.aws_acmpca

AWS::ACMPCA Construct Library

This module is part of the AWS Cloud Development Kit project.

import * as acmpca from 'aws-cdk-lib/aws-acmpca';

import aws_cdk.aws_acmpca as acmpca

import software.amazon.awscdk.services.acmpca.*;

using Amazon.CDK.AWS.ACMPCA;

import acmpca "github.com/aws/aws-cdk-go/awscdk"

Certificate Authority

This package contains a CertificateAuthority class. At the moment, you cannot create new Authorities using it, but you can import existing ones using the fromCertificateAuthorityArn static method:

const certificateAuthority = acmpca.CertificateAuthority.fromCertificateAuthorityArn(this, 'CA',
  'arn:aws:acm-pca:us-east-1:123456789012:certificate-authority/023077d8-2bfa-4eb0-8f22-05c96deade77');

certificate_authority = acmpca.CertificateAuthority.from_certificate_authority_arn(self, "CA", "arn:aws:acm-pca:us-east-1:123456789012:certificate-authority/023077d8-2bfa-4eb0-8f22-05c96deade77")

ICertificateAuthority certificateAuthority = CertificateAuthority.fromCertificateAuthorityArn(this, "CA", "arn:aws:acm-pca:us-east-1:123456789012:certificate-authority/023077d8-2bfa-4eb0-8f22-05c96deade77");

var certificateAuthority = CertificateAuthority.FromCertificateAuthorityArn(this, "CA", "arn:aws:acm-pca:us-east-1:123456789012:certificate-authority/023077d8-2bfa-4eb0-8f22-05c96deade77");

certificateAuthority := acmpca.CertificateAuthority_FromCertificateAuthorityArn(this, jsii.String("CA"), jsii.String("arn:aws:acm-pca:us-east-1:123456789012:certificate-authority/023077d8-2bfa-4eb0-8f22-05c96deade77"))

Low-level Cfn* classes

You can always use the low-level classes (starting with Cfn*) to create resources like the Certificate Authority:

const cfnCertificateAuthority = new acmpca.CfnCertificateAuthority(this, 'CA', {
  type: 'ROOT',
  keyAlgorithm: 'RSA_2048',
  signingAlgorithm: 'SHA256WITHRSA',
  subject: {
    country: 'US',
    organization: 'string',
    organizationalUnit: 'string',
    distinguishedNameQualifier: 'string',
    state: 'string',
    commonName: '123',
    serialNumber: 'string',
    locality: 'string',
    title: 'string',
    surname: 'string',
    givenName: 'string',
    initials: 'DG',
    pseudonym: 'string',
    generationQualifier: 'DBG',
  },
});

cfn_certificate_authority = acmpca.CfnCertificateAuthority(self, "CA",
    type="ROOT",
    key_algorithm="RSA_2048",
    signing_algorithm="SHA256WITHRSA",
    subject=acmpca.CfnCertificateAuthority.SubjectProperty(
        country="US",
        organization="string",
        organizational_unit="string",
        distinguished_name_qualifier="string",
        state="string",
        common_name="123",
        serial_number="string",
        locality="string",
        title="string",
        surname="string",
        given_name="string",
        initials="DG",
        pseudonym="string",
        generation_qualifier="DBG"
    )
)

CfnCertificateAuthority cfnCertificateAuthority = CfnCertificateAuthority.Builder.create(this, "CA")
        .type("ROOT")
        .keyAlgorithm("RSA_2048")
        .signingAlgorithm("SHA256WITHRSA")
        .subject(SubjectProperty.builder()
                .country("US")
                .organization("string")
                .organizationalUnit("string")
                .distinguishedNameQualifier("string")
                .state("string")
                .commonName("123")
                .serialNumber("string")
                .locality("string")
                .title("string")
                .surname("string")
                .givenName("string")
                .initials("DG")
                .pseudonym("string")
                .generationQualifier("DBG")
                .build())
        .build();

var cfnCertificateAuthority = new CfnCertificateAuthority(this, "CA", new CfnCertificateAuthorityProps {
    Type = "ROOT",
    KeyAlgorithm = "RSA_2048",
    SigningAlgorithm = "SHA256WITHRSA",
    Subject = new SubjectProperty {
        Country = "US",
        Organization = "string",
        OrganizationalUnit = "string",
        DistinguishedNameQualifier = "string",
        State = "string",
        CommonName = "123",
        SerialNumber = "string",
        Locality = "string",
        Title = "string",
        Surname = "string",
        GivenName = "string",
        Initials = "DG",
        Pseudonym = "string",
        GenerationQualifier = "DBG"
    }
});

cfnCertificateAuthority := acmpca.NewCfnCertificateAuthority(this, jsii.String("CA"), &CfnCertificateAuthorityProps{
	Type: jsii.String("ROOT"),
	KeyAlgorithm: jsii.String("RSA_2048"),
	SigningAlgorithm: jsii.String("SHA256WITHRSA"),
	Subject: &SubjectProperty{
		Country: jsii.String("US"),
		Organization: jsii.String("string"),
		OrganizationalUnit: jsii.String("string"),
		DistinguishedNameQualifier: jsii.String("string"),
		State: jsii.String("string"),
		CommonName: jsii.String("123"),
		SerialNumber: jsii.String("string"),
		Locality: jsii.String("string"),
		Title: jsii.String("string"),
		Surname: jsii.String("string"),
		GivenName: jsii.String("string"),
		Initials: jsii.String("DG"),
		Pseudonym: jsii.String("string"),
		GenerationQualifier: jsii.String("DBG"),
	},
})

If you need to pass the higher-level ICertificateAuthority somewhere, you can get it from the lower-level CfnCertificateAuthority using the same fromCertificateAuthorityArn method:

declare const cfnCertificateAuthority: acmpca.CfnCertificateAuthority;

const certificateAuthority = acmpca.CertificateAuthority.fromCertificateAuthorityArn(this, 'CertificateAuthority',
  cfnCertificateAuthority.attrArn);

# cfn_certificate_authority: acmpca.CfnCertificateAuthority


certificate_authority = acmpca.CertificateAuthority.from_certificate_authority_arn(self, "CertificateAuthority", cfn_certificate_authority.attr_arn)

CfnCertificateAuthority cfnCertificateAuthority;


ICertificateAuthority certificateAuthority = CertificateAuthority.fromCertificateAuthorityArn(this, "CertificateAuthority", cfnCertificateAuthority.getAttrArn());

CfnCertificateAuthority cfnCertificateAuthority;


var certificateAuthority = CertificateAuthority.FromCertificateAuthorityArn(this, "CertificateAuthority", cfnCertificateAuthority.AttrArn);

var cfnCertificateAuthority CfnCertificateAuthority


certificateAuthority := acmpca.CertificateAuthority_FromCertificateAuthorityArn(this, jsii.String("CertificateAuthority"), cfnCertificateAuthority.attrArn)

Types

Name	Kind	Summary
CfnCertificate	Construct (L1)	The AWS::ACMPCA::Certificate resource is used to issue a certificate using your private certificate authority.
CfnCertificateAuthority	Construct (L1)	Use the AWS::ACMPCA::CertificateAuthority resource to create a private CA.
CfnCertificateAuthorityActivation	Construct (L1)	The AWS::ACMPCA::CertificateAuthorityActivation resource creates and installs a CA certificate on a CA.
CfnPermission	Construct (L1)	Grants permissions to the Certificate Manager ( ACM ) service principal ( acm.amazonaws.com ) to perform IssueCertificate , GetCertificate , and ListPermissions actions on a CA. These actions are needed for the ACM principal to renew private PKI certificates requested through ACM and residing in the same AWS account as the CA.
CertificateAuthority	Class	Defines a Certificate for ACMPCA.
CfnCertificate.ApiPassthroughProperty	Struct	Contains X.509 certificate information to be placed in an issued certificate. An APIPassthrough or APICSRPassthrough template variant must be selected, or else this parameter is ignored.
CfnCertificate.CustomAttributeProperty	Struct	Defines the X.500 relative distinguished name (RDN).
CfnCertificate.CustomExtensionProperty	Struct	Specifies the X.509 extension information for a certificate.
CfnCertificate.EdiPartyNameProperty	Struct	Describes an Electronic Data Interchange (EDI) entity as described in as defined in Subject Alternative Name in RFC 5280.
CfnCertificate.ExtendedKeyUsageProperty	Struct	Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the KeyUsage extension.
CfnCertificate.ExtensionsProperty	Struct	Contains X.509 extension information for a certificate.
CfnCertificate.GeneralNameProperty	Struct	Describes an ASN.1 X.400 GeneralName as defined in RFC 5280 . Only one of the following naming options should be provided. Providing more than one option results in an InvalidArgsException error.
CfnCertificate.KeyUsageProperty	Struct	Defines one or more purposes for which the key contained in the certificate can be used.
CfnCertificate.OtherNameProperty	Struct	Defines a custom ASN.1 X.400 GeneralName using an object identifier (OID) and value. The OID must satisfy the regular expression shown below. For more information, see NIST's definition of Object Identifier (OID) .
CfnCertificate.PolicyInformationProperty	Struct	Defines the X.509 CertificatePolicies extension.
CfnCertificate.PolicyQualifierInfoProperty	Struct	Modifies the CertPolicyId of a PolicyInformation object with a qualifier.
CfnCertificate.QualifierProperty	Struct	Defines a PolicyInformation qualifier.
CfnCertificate.SubjectProperty	Struct	Contains information about the certificate subject.
CfnCertificate.ValidityProperty	Struct	Length of time for which the certificate issued by your private certificate authority (CA), or by the private CA itself, is valid in days, months, or years.
CfnCertificateAuthority.AccessDescriptionProperty	Struct	Provides access information used by the authorityInfoAccess and subjectInfoAccess extensions described in RFC 5280 .
CfnCertificateAuthority.AccessMethodProperty	Struct	Describes the type and format of extension access.
CfnCertificateAuthority.CrlConfigurationProperty	Struct	Contains configuration information for a certificate revocation list (CRL).
CfnCertificateAuthority.CrlDistributionPointExtensionConfigurationProperty	Struct	Contains configuration information for the default behavior of the CRL Distribution Point (CDP) extension in certificates issued by your CA.
CfnCertificateAuthority.CsrExtensionsProperty	Struct	Describes the certificate extensions to be added to the certificate signing request (CSR).
CfnCertificateAuthority.CustomAttributeProperty	Struct	Defines the X.500 relative distinguished name (RDN).
CfnCertificateAuthority.EdiPartyNameProperty	Struct	Describes an Electronic Data Interchange (EDI) entity as described in as defined in Subject Alternative Name in RFC 5280.
CfnCertificateAuthority.GeneralNameProperty	Struct	Describes an ASN.1 X.400 GeneralName as defined in RFC 5280 . Only one of the following naming options should be provided. Providing more than one option results in an InvalidArgsException error.
CfnCertificateAuthority.KeyUsageProperty	Struct	Defines one or more purposes for which the key contained in the certificate can be used.
CfnCertificateAuthority.OcspConfigurationProperty	Struct	Contains information to enable and configure Online Certificate Status Protocol (OCSP) for validating certificate revocation status.
CfnCertificateAuthority.OtherNameProperty	Struct	Defines a custom ASN.1 X.400 GeneralName using an object identifier (OID) and value. The OID must satisfy the regular expression shown below. For more information, see NIST's definition of Object Identifier (OID) .
CfnCertificateAuthority.RevocationConfigurationProperty	Struct	Certificate 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 .
CfnCertificateAuthority.SubjectProperty	Struct	ASN1 subject for the certificate authority.
CfnCertificateAuthorityActivationProps	Struct	Properties for defining a CfnCertificateAuthorityActivation.
CfnCertificateAuthorityProps	Struct	Properties for defining a CfnCertificateAuthority.
CfnCertificateProps	Struct	Properties for defining a CfnCertificate.
CfnPermissionProps	Struct	Properties for defining a CfnPermission.
ICertificateAuthority	Interface	Interface which all CertificateAuthority based class must implement.