AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, an optional configuration for Online Certificate Status Protocol (OCSP) and/or a certificate revocation list (CRL), the CA type, and an optional idempotency token to avoid accidental creation of multiple CAs. The CA configuration specifies the name of the algorithm and key size to be used to create the CA private key, the type of signing algorithm that the CA uses, and X.500 subject information. The OCSP configuration can optionally specify a custom URL for the OCSP responder. The CRL configuration specifies the CRL expiration period in days (the validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3 bucket that is included in certificates issued by the CA. If successful, this action returns the Amazon Resource Name (ARN) of the CA.
Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs .
See also: AWS API Documentation
create-certificate-authority
--certificate-authority-configuration <value>
[--revocation-configuration <value>]
--certificate-authority-type <value>
[--idempotency-token <value>]
[--key-storage-security-standard <value>]
[--tags <value>]
[--usage-mode <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--certificate-authority-configuration
(structure)
Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject information.
KeyAlgorithm -> (string)
Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. When you create a subordinate CA, you must use a key algorithm supported by the parent CA.SigningAlgorithm -> (string)
Name of the algorithm your private CA uses to sign certificate requests.
This parameter should not be confused with the
SigningAlgorithm
parameter used to sign certificates when they are issued.Subject -> (structure)
Structure that contains X.500 distinguished name information for your private CA.
Country -> (string)
Two-digit code that specifies the country in which the certificate subject located.Organization -> (string)
Legal name of the organization with which the certificate subject is affiliated.OrganizationalUnit -> (string)
A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.DistinguishedNameQualifier -> (string)
Disambiguating information for the certificate subject.State -> (string)
State in which the subject of the certificate is located.CommonName -> (string)
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.
SerialNumber -> (string)
The certificate serial number.Locality -> (string)
The locality (such as a city or town) in which the certificate subject is located.Title -> (string)
A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.Surname -> (string)
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.GivenName -> (string)
First name.Initials -> (string)
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 .Pseudonym -> (string)
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.GenerationQualifier -> (string)
Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.CustomAttributes -> (list)
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) .
Note
Custom attributes cannot be used in combination with standard attributes.(structure)
Defines the X.500 relative distinguished name (RDN).
ObjectIdentifier -> (string)
Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).Value -> (string)
Specifies the attribute value of relative distinguished name (RDN).CsrExtensions -> (structure)
Specifies information to be added to the extension section of the certificate signing request (CSR).
KeyUsage -> (structure)
Indicates the purpose of the certificate and of the key contained in the certificate.
DigitalSignature -> (boolean)
Key can be used for digital signing.NonRepudiation -> (boolean)
Key can be used for non-repudiation.KeyEncipherment -> (boolean)
Key can be used to encipher data.DataEncipherment -> (boolean)
Key can be used to decipher data.KeyAgreement -> (boolean)
Key can be used in a key-agreement protocol.KeyCertSign -> (boolean)
Key can be used to sign certificates.CRLSign -> (boolean)
Key can be used to sign CRLs.EncipherOnly -> (boolean)
Key can be used only to encipher data.DecipherOnly -> (boolean)
Key can be used only to decipher data.SubjectInformationAccess -> (list)
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.
(structure)
Provides access information used by the
authorityInfoAccess
andsubjectInfoAccess
extensions described in RFC 5280 .AccessMethod -> (structure)
The type and format of
AccessDescription
information.CustomObjectIdentifier -> (string)
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) .AccessMethodType -> (string)
Specifies theAccessMethod
.AccessLocation -> (structure)
The location of
AccessDescription
information.OtherName -> (structure)
Represents
GeneralName
using anOtherName
object.TypeId -> (string)
Specifies an OID.Value -> (string)
Specifies an OID value.Rfc822Name -> (string)
RepresentsGeneralName
as an RFC 822 email address.DnsName -> (string)
RepresentsGeneralName
as a DNS name.DirectoryName -> (structure)
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. TheSubject
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.Country -> (string)
Two-digit code that specifies the country in which the certificate subject located.Organization -> (string)
Legal name of the organization with which the certificate subject is affiliated.OrganizationalUnit -> (string)
A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.DistinguishedNameQualifier -> (string)
Disambiguating information for the certificate subject.State -> (string)
State in which the subject of the certificate is located.CommonName -> (string)
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.
SerialNumber -> (string)
The certificate serial number.Locality -> (string)
The locality (such as a city or town) in which the certificate subject is located.Title -> (string)
A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.Surname -> (string)
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.GivenName -> (string)
First name.Initials -> (string)
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 .Pseudonym -> (string)
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.GenerationQualifier -> (string)
Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.CustomAttributes -> (list)
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) .
Note
Custom attributes cannot be used in combination with standard attributes.(structure)
Defines the X.500 relative distinguished name (RDN).
ObjectIdentifier -> (string)
Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).Value -> (string)
Specifies the attribute value of relative distinguished name (RDN).EdiPartyName -> (structure)
Represents
GeneralName
as anEdiPartyName
object.PartyName -> (string)
Specifies the party name.NameAssigner -> (string)
Specifies the name assigner.UniformResourceIdentifier -> (string)
RepresentsGeneralName
as a URI.IpAddress -> (string)
RepresentsGeneralName
as an IPv4 or IPv6 address.RegisteredId -> (string)
RepresentsGeneralName
as an object identifier (OID).
JSON Syntax:
{
"KeyAlgorithm": "RSA_2048"|"RSA_4096"|"EC_prime256v1"|"EC_secp384r1"|"SM2",
"SigningAlgorithm": "SHA256WITHECDSA"|"SHA384WITHECDSA"|"SHA512WITHECDSA"|"SHA256WITHRSA"|"SHA384WITHRSA"|"SHA512WITHRSA"|"SM3WITHSM2",
"Subject": {
"Country": "string",
"Organization": "string",
"OrganizationalUnit": "string",
"DistinguishedNameQualifier": "string",
"State": "string",
"CommonName": "string",
"SerialNumber": "string",
"Locality": "string",
"Title": "string",
"Surname": "string",
"GivenName": "string",
"Initials": "string",
"Pseudonym": "string",
"GenerationQualifier": "string",
"CustomAttributes": [
{
"ObjectIdentifier": "string",
"Value": "string"
}
...
]
},
"CsrExtensions": {
"KeyUsage": {
"DigitalSignature": true|false,
"NonRepudiation": true|false,
"KeyEncipherment": true|false,
"DataEncipherment": true|false,
"KeyAgreement": true|false,
"KeyCertSign": true|false,
"CRLSign": true|false,
"EncipherOnly": true|false,
"DecipherOnly": true|false
},
"SubjectInformationAccess": [
{
"AccessMethod": {
"CustomObjectIdentifier": "string",
"AccessMethodType": "CA_REPOSITORY"|"RESOURCE_PKI_MANIFEST"|"RESOURCE_PKI_NOTIFY"
},
"AccessLocation": {
"OtherName": {
"TypeId": "string",
"Value": "string"
},
"Rfc822Name": "string",
"DnsName": "string",
"DirectoryName": {
"Country": "string",
"Organization": "string",
"OrganizationalUnit": "string",
"DistinguishedNameQualifier": "string",
"State": "string",
"CommonName": "string",
"SerialNumber": "string",
"Locality": "string",
"Title": "string",
"Surname": "string",
"GivenName": "string",
"Initials": "string",
"Pseudonym": "string",
"GenerationQualifier": "string",
"CustomAttributes": [
{
"ObjectIdentifier": "string",
"Value": "string"
}
...
]
},
"EdiPartyName": {
"PartyName": "string",
"NameAssigner": "string"
},
"UniformResourceIdentifier": "string",
"IpAddress": "string",
"RegisteredId": "string"
}
}
...
]
}
}
--revocation-configuration
(structure)
Contains information to enable Online Certificate Status Protocol (OCSP) support, to enable a certificate revocation list (CRL), to enable both, or to enable neither. The default is for both certificate validation mechanisms to be disabled.
Note
The following requirements apply to revocation configurations.
- A configuration disabling CRLs or OCSP must contain only the
Enabled=False
parameter, and will fail if other parameters such asCustomCname
orExpirationInDays
are included.- In a CRL configuration, the
S3BucketName
parameter must conform to 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://".
For more information, see the OcspConfiguration and CrlConfiguration types.
CrlConfiguration -> (structure)
Configuration of the certificate revocation list (CRL), if any, maintained by your private CA. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason a CRL update fails, Amazon Web Services Private CA makes further attempts every 15 minutes.
Enabled -> (boolean)
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 CreateCertificateAuthority action or for an existing CA when you call the UpdateCertificateAuthority action.ExpirationInDays -> (integer)
Validity period of the CRL in days.CustomCname -> (string)
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.
S3BucketName -> (string)
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 Amazon Web Services Private CA to write the CRL to your bucket.
S3ObjectAcl -> (string)
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_CONTROL
orPUBLIC_READ
as the value.For more information, see Blocking public access to the S3 bucket .
CrlDistributionPointExtensionConfiguration -> (structure)
Configures the behavior of the CRL Distribution Point extension for certificates issued by your certificate authority. If this field is not provided, then the CRl Distribution Point Extension will be present and contain the default CRL URL.
OmitExtension -> (boolean)
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.Note
Only set this if you have another way to distribute the CRL Distribution Points ffor certificates issued by your CA, such as the Matter Distributed Compliance Ledger
This configuration cannot be enabled with a custom CNAME set.
OcspConfiguration -> (structure)
Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained by your private CA. When you revoke a certificate, OCSP responses may take up to 60 minutes to reflect the new status.
Enabled -> (boolean)
Flag enabling use of the Online Certificate Status Protocol (OCSP) for validating certificate revocation status.OcspCustomCname -> (string)
By default, Amazon Web Services Private CA injects an Amazon Web Services 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.
Note
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://".For more information, see Customizing Online Certificate Status Protocol (OCSP) in the Amazon Web Services Private Certificate Authority User Guide .
Shorthand Syntax:
CrlConfiguration={Enabled=boolean,ExpirationInDays=integer,CustomCname=string,S3BucketName=string,S3ObjectAcl=string,CrlDistributionPointExtensionConfiguration={OmitExtension=boolean}},OcspConfiguration={Enabled=boolean,OcspCustomCname=string}
JSON Syntax:
{
"CrlConfiguration": {
"Enabled": true|false,
"ExpirationInDays": integer,
"CustomCname": "string",
"S3BucketName": "string",
"S3ObjectAcl": "PUBLIC_READ"|"BUCKET_OWNER_FULL_CONTROL",
"CrlDistributionPointExtensionConfiguration": {
"OmitExtension": true|false
}
},
"OcspConfiguration": {
"Enabled": true|false,
"OcspCustomCname": "string"
}
}
--certificate-authority-type
(string)
The type of the certificate authority.
Possible values:
ROOT
SUBORDINATE
--idempotency-token
(string)
Custom string that can be used to distinguish between calls to the CreateCertificateAuthority action. Idempotency tokens for CreateCertificateAuthority time out after five minutes. Therefore, if you call CreateCertificateAuthority multiple times with the same idempotency token within five minutes, Amazon Web Services Private CA recognizes that you are requesting only certificate authority and will issue only one. If you change the idempotency token for each call, Amazon Web Services Private CA recognizes that you are requesting multiple certificate authorities.
--key-storage-security-standard
(string)
Specifies a cryptographic key management compliance standard used for handling CA keys.
Default: FIPS_140_2_LEVEL_3_OR_HIGHER
Note
Some Amazon Web Services Regions do not support the default. When creating a CA in these Regions, you must provide
FIPS_140_2_LEVEL_2_OR_HIGHER
as the argument forKeyStorageSecurityStandard
. Failure to do this results in anInvalidArgsException
with the message, "A certificate authority cannot be created in this region with the specified security standard."For information about security standard support in various Regions, see Storage and security compliance of Amazon Web Services Private CA private keys .
Possible values:
FIPS_140_2_LEVEL_2_OR_HIGHER
FIPS_140_2_LEVEL_3_OR_HIGHER
CCPC_LEVEL_1_OR_HIGHER
--tags
(list)
Key-value pairs that will be attached to the new private CA. You can associate up to 50 tags with a private CA. For information using tags with IAM to manage permissions, see Controlling Access Using IAM Tags .
(structure)
Tags are labels that you can use to identify and organize your private CAs. Each tag consists of a key and an optional value. You can associate up to 50 tags with a private CA. To add one or more tags to a private CA, call the TagCertificateAuthority action. To remove a tag, call the UntagCertificateAuthority action.
Key -> (string)
Key (name) of the tag.Value -> (string)
Value of the tag.
Shorthand Syntax:
Key=string,Value=string ...
JSON Syntax:
[
{
"Key": "string",
"Value": "string"
}
...
]
--usage-mode
(string)
Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days.
The default value is GENERAL_PURPOSE.
Possible values:
GENERAL_PURPOSE
SHORT_LIVED_CERTIFICATE
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To create a private certificate authority
The following create-certificate-authority
command creates a private certificate authority in your AWS account.
aws acm-pca create-certificate-authority --certificate-authority-configuration file://C:\ca_config.txt --revocation-configuration file://C:\revoke_config.txt --certificate-authority-type "SUBORDINATE" --idempotency-token 98256344