acmpca_issue_certificate: Uses your private certificate authority (CA) to issue a...

Description Usage Arguments Details Request syntax

View source: R/acmpca_operations.R

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.

Usage

1
2
acmpca_issue_certificate(CertificateAuthorityArn, Csr, SigningAlgorithm,
  TemplateArn, Validity, IdempotencyToken)

Arguments

CertificateAuthorityArn

[required] The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>

Csr

[required] 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_.csr

If you have a configuration file, you can use the following OpenSSL command. The usr_cert block 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

SigningAlgorithm

[required] The name of the algorithm that will be used to sign the certificate to be issued.

TemplateArn

Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template.

The following service-owned TemplateArn values 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

[required] The type of the validity period.

IdempotencyToken

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.

Details

You cannot use the ACM ListCertificateAuthorities action to retrieve the ARNs of the certificates that you issue by using ACM Private CA.

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
svc$issue_certificate(
  CertificateAuthorityArn = "string",
  Csr = raw,
  SigningAlgorithm = "SHA256WITHECDSA"|"SHA384WITHECDSA"|"SHA512WITHECDSA"|"SHA256WITHRSA"|"SHA384WITHRSA"|"SHA512WITHRSA",
  TemplateArn = "string",
  Validity = list(
    Value = 123,
    Type = "END_DATE"|"ABSOLUTE"|"DAYS"|"MONTHS"|"YEARS"
  ),
  IdempotencyToken = "string"
)

paws.security.identity documentation built on Oct. 30, 2019, 11:26 a.m.