issue-certificate¶
Description¶
Uses your private certificate authority (CA) to issue a client certificate. This action returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the GetCertificate action and specifying the ARN.
Note
You cannot use the ACM ListCertificateAuthorities action to retrieve the ARNs of the certificates that you issue by using ACM Private CA.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
issue-certificate
--certificate-authority-arn <value>
--csr <value>
--signing-algorithm <value>
[--template-arn <value>]
--validity <value>
[--idempotency-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--certificate-authority-arn (string)
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority . This must be of the form:
``arn:aws:acm-pca:region :account :certificate-authority/12345678-1234-1234-1234-123456789012 ``
--csr (blob)
The certificate signing request (CSR) for the certificate you want to issue. You can use the following OpenSSL command to create the CSR and a 2048 bit RSA private key.
openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csrIf you have a configuration file, you can use the following OpenSSL command. The
usr_certblock in the configuration file contains your X509 version 3 extensions.
openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 -days -365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr
--signing-algorithm (string)
The name of the algorithm that will be used to sign the certificate to be issued.
Possible values:
SHA256WITHECDSA
SHA384WITHECDSA
SHA512WITHECDSA
SHA256WITHRSA
SHA384WITHRSA
SHA512WITHRSA
--template-arn (string)
Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the
EndEntityCertificate/V1template.The following service-owned
TemplateArnvalues are supported by ACM Private CA:
arn:aws:acm-pca:::template/EndEntityCertificate/V1
arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen0/V1
arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen1/V1
arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen2/V1
arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen3/V1
arn:aws:acm-pca:::template/RootCACertificate/V1
For more information, see Using Templates .
--validity (structure)
The type of the validity period.
Value -> (long)
Time period.
Type -> (string)
Specifies whether the
Valueparameter represents days, months, or years.
Shorthand Syntax:
Value=long,Type=string
JSON Syntax:
{
"Value": long,
"Type": "END_DATE"|"ABSOLUTE"|"DAYS"|"MONTHS"|"YEARS"
}
--idempotency-token (string)
Custom string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens time out after one hour. Therefore, if you call IssueCertificate multiple times with the same idempotency token within 5 minutes, ACM Private CA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, PCA recognizes that you are requesting multiple certificates.
--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 issue a private certificate
The following issue-certificate command uses the private CA specified by the ARN to issue a private certificate.
aws acm-pca issue-certificate --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 --csr fileb://C:\cert_1.csr --signing-algorithm "SHA256WITHRSA" --validity Value=365,Type="DAYS" --idempotency-token 1234