Skip to content
v2.274.0

KeyAlgorithm Class ​

Certificate Manager key algorithm.

If you need to use an algorithm that doesn't exist as a static member, you can instantiate a KeyAlgorithm object, e.g: new KeyAlgorithm('RSA_2048').

Example ​

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

new acm.PrivateCertificate(this, 'PrivateCertificate', {
  domainName: 'test.example.com',
  subjectAlternativeNames: ['cool.example.com', 'test.example.net'], // optional
  certificateAuthority: acmpca.CertificateAuthority.fromCertificateAuthorityArn(this, 'CA',
    'arn:aws:acm-pca:us-east-1:123456789012:certificate-authority/023077d8-2bfa-4eb0-8f22-05c96deade77'),
  keyAlgorithm: acm.KeyAlgorithm.RSA_2048, // optional, default algorithm is RSA_2048
});
python
import aws_cdk.aws_acmpca as acmpca


acm.PrivateCertificate(self, "PrivateCertificate",
    domain_name="test.example.com",
    subject_alternative_names=["cool.example.com", "test.example.net"],  # optional
    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"),
    key_algorithm=acm.KeyAlgorithm.RSA_2048
)
java
import software.amazon.awscdk.services.acmpca.*;


PrivateCertificate.Builder.create(this, "PrivateCertificate")
        .domainName("test.example.com")
        .subjectAlternativeNames(List.of("cool.example.com", "test.example.net")) // optional
        .certificateAuthority(CertificateAuthority.fromCertificateAuthorityArn(this, "CA", "arn:aws:acm-pca:us-east-1:123456789012:certificate-authority/023077d8-2bfa-4eb0-8f22-05c96deade77"))
        .keyAlgorithm(KeyAlgorithm.RSA_2048)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK.AWS.ACMPCA;


new PrivateCertificate(this, "PrivateCertificate", new PrivateCertificateProps {
    DomainName = "test.example.com",
    SubjectAlternativeNames = new [] { "cool.example.com", "test.example.net" },  // optional
    CertificateAuthority = CertificateAuthority.FromCertificateAuthorityArn(this, "CA", "arn:aws:acm-pca:us-east-1:123456789012:certificate-authority/023077d8-2bfa-4eb0-8f22-05c96deade77"),
    KeyAlgorithm = KeyAlgorithm.RSA_2048
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import acmpca "github.com/aws/aws-cdk-go/awscdk"


acm.NewPrivateCertificate(this, jsii.String("PrivateCertificate"), &PrivateCertificateProps{
	DomainName: jsii.String("test.example.com"),
	SubjectAlternativeNames: []*string{
		jsii.String("cool.example.com"),
		jsii.String("test.example.net"),
	},
	 // optional
	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")),
	KeyAlgorithm: acm.KeyAlgorithm_RSA_2048(),
})

Initializer ​

ts
new KeyAlgorithm(name: string)
python
KeyAlgorithm(name: str)
java
new KeyAlgorithm(String name)
csharp
new KeyAlgorithm(string name)
go
NewKeyAlgorithm(Name *string)

Properties ​

EC_PRIME256V1KeyAlgorithmec_prime256_v1KeyAlgorithmEC_PRIME256V1KeyAlgorithmEC_PRIME256V1KeyAlgorithmEC_PRIME256V1KeyAlgorithmstatic#
EC_prime256v1 algorithm.
EC_SECP384R1KeyAlgorithmec_secp384_r1KeyAlgorithmEC_SECP384R1KeyAlgorithmEC_SECP384R1KeyAlgorithmEC_SECP384R1KeyAlgorithmstatic#
EC_secp384r1 algorithm.
EC_SECP521R1KeyAlgorithmec_secp521_r1KeyAlgorithmEC_SECP521R1KeyAlgorithmEC_SECP521R1KeyAlgorithmEC_SECP521R1KeyAlgorithmstatic#
EC_secp521r1 algorithm.
namestringnamestrnameStringNamestringName*string#
The name of the algorithm.
RSA_1024KeyAlgorithmrsa_1024KeyAlgorithmRSA_1024KeyAlgorithmRSA_1024KeyAlgorithmRSA_1024KeyAlgorithmstatic#
RSA_1024 algorithm.
RSA_2048KeyAlgorithmrsa_2048KeyAlgorithmRSA_2048KeyAlgorithmRSA_2048KeyAlgorithmRSA_2048KeyAlgorithmstatic#
RSA_2048 algorithm.
RSA_3072KeyAlgorithmrsa_3072KeyAlgorithmRSA_3072KeyAlgorithmRSA_3072KeyAlgorithmRSA_3072KeyAlgorithmstatic#
RSA_3072 algorithm.
RSA_4096KeyAlgorithmrsa_4096KeyAlgorithmRSA_4096KeyAlgorithmRSA_4096KeyAlgorithmRSA_4096KeyAlgorithmstatic#
RSA_4096 algorithm.