create-certificate-authority¶
Description¶
Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, the certificate revocation list (CRL) configuration, 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 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.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
create-certificate-authority
--certificate-authority-configuration <value>
[--revocation-configuration <value>]
--certificate-authority-type <value>
[--idempotency-token <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--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.
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)
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.
Shorthand Syntax:
KeyAlgorithm=string,SigningAlgorithm=string,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}
JSON Syntax:
{
"KeyAlgorithm": "RSA_2048"|"RSA_4096"|"EC_prime256v1"|"EC_secp384r1",
"SigningAlgorithm": "SHA256WITHECDSA"|"SHA384WITHECDSA"|"SHA512WITHECDSA"|"SHA256WITHRSA"|"SHA384WITHRSA"|"SHA512WITHRSA",
"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"
}
}
--revocation-configuration (structure)
Contains a Boolean value that you can use to enable a certification revocation list (CRL) for the CA, the name of the S3 bucket to which ACM Private CA will write the CRL, and an optional CNAME alias that you can use to hide the name of your bucket in the CRL Distribution Points extension of your CA certificate. For more information, see the CrlConfiguration structure.
CrlConfiguration -> (structure)
Configuration of the certificate revocation list (CRL), if any, maintained by your private CA.
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)
Number of days until a certificate expires.
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 action. You must specify a bucket policy that allows ACM Private CA to write the CRL to your bucket.
Shorthand Syntax:
CrlConfiguration={Enabled=boolean,ExpirationInDays=integer,CustomCname=string,S3BucketName=string}
JSON Syntax:
{
"CrlConfiguration": {
"Enabled": true|false,
"ExpirationInDays": integer,
"CustomCname": "string",
"S3BucketName": "string"
}
}
--certificate-authority-type (string)
The type of the certificate authority.
Possible values:
ROOT
SUBORDINATE
--idempotency-token (string)
Alphanumeric string that can be used to distinguish between calls to CreateCertificateAuthority . Idempotency tokens time out after five minutes. Therefore, if you call CreateCertificateAuthority multiple times with the same idempotency token within a five minute period, ACM Private CA recognizes that you are requesting only one certificate. As a result, ACM Private CA issues only one. If you change the idempotency token for each call, however, ACM Private CA recognizes that you are requesting multiple certificates.
--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"
}
...
]
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.
--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
Examples¶
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