acmpca_create_certificate_authority: Creates a root or subordinate private certificate authority...

Description Usage Arguments Value Request syntax

View source: R/acmpca_operations.R

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.

ACM Private CAA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs.

Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Configure Access to ACM Private CA.

Usage

1
2
3
acmpca_create_certificate_authority(CertificateAuthorityConfiguration,
  RevocationConfiguration, CertificateAuthorityType, IdempotencyToken,
  Tags)

Arguments

CertificateAuthorityConfiguration

[required] Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject information.

RevocationConfiguration

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.

CertificateAuthorityType

[required] The type of the certificate authority.

IdempotencyToken

Alphanumeric string that can be used to distinguish between calls to CreateCertificateAuthority. For a given token, ACM Private CA creates exactly one CA. If you issue a subsequent call using the same token, ACM Private CA returns the ARN of the existing CA and takes no further action. If you change the idempotency token across multiple calls, ACM Private CA creates a unique CA for each unique token.

Tags

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.

Value

A list with the following syntax:

1
2
3
list(
  CertificateAuthorityArn = "string"
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
svc$create_certificate_authority(
  CertificateAuthorityConfiguration = list(
    KeyAlgorithm = "RSA_2048"|"RSA_4096"|"EC_prime256v1"|"EC_secp384r1",
    SigningAlgorithm = "SHA256WITHECDSA"|"SHA384WITHECDSA"|"SHA512WITHECDSA"|"SHA256WITHRSA"|"SHA384WITHRSA"|"SHA512WITHRSA",
    Subject = list(
      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"
    ),
    CsrExtensions = list(
      KeyUsage = list(
        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 = list(
        list(
          AccessMethod = list(
            CustomObjectIdentifier = "string",
            AccessMethodType = "CA_REPOSITORY"|"RESOURCE_PKI_MANIFEST"|"RESOURCE_PKI_NOTIFY"
          ),
          AccessLocation = list(
            OtherName = list(
              TypeId = "string",
              Value = "string"
            ),
            Rfc822Name = "string",
            DnsName = "string",
            DirectoryName = list(
              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"
            ),
            EdiPartyName = list(
              PartyName = "string",
              NameAssigner = "string"
            ),
            UniformResourceIdentifier = "string",
            IpAddress = "string",
            RegisteredId = "string"
          )
        )
      )
    )
  ),
  RevocationConfiguration = list(
    CrlConfiguration = list(
      Enabled = TRUE|FALSE,
      ExpirationInDays = 123,
      CustomCname = "string",
      S3BucketName = "string"
    )
  ),
  CertificateAuthorityType = "ROOT"|"SUBORDINATE",
  IdempotencyToken = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)

paws.security.identity documentation built on Aug. 23, 2021, 9:16 a.m.