| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.CertificateManagerPCA.CreateCertificateAuthority
Description
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.
ACM Private CA 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.
Synopsis
- data CreateCertificateAuthority = CreateCertificateAuthority' {}
- newCreateCertificateAuthority :: CertificateAuthorityConfiguration -> CertificateAuthorityType -> CreateCertificateAuthority
- createCertificateAuthority_idempotencyToken :: Lens' CreateCertificateAuthority (Maybe Text)
- createCertificateAuthority_keyStorageSecurityStandard :: Lens' CreateCertificateAuthority (Maybe KeyStorageSecurityStandard)
- createCertificateAuthority_revocationConfiguration :: Lens' CreateCertificateAuthority (Maybe RevocationConfiguration)
- createCertificateAuthority_tags :: Lens' CreateCertificateAuthority (Maybe (NonEmpty Tag))
- createCertificateAuthority_certificateAuthorityConfiguration :: Lens' CreateCertificateAuthority CertificateAuthorityConfiguration
- createCertificateAuthority_certificateAuthorityType :: Lens' CreateCertificateAuthority CertificateAuthorityType
- data CreateCertificateAuthorityResponse = CreateCertificateAuthorityResponse' {}
- newCreateCertificateAuthorityResponse :: Int -> CreateCertificateAuthorityResponse
- createCertificateAuthorityResponse_certificateAuthorityArn :: Lens' CreateCertificateAuthorityResponse (Maybe Text)
- createCertificateAuthorityResponse_httpStatus :: Lens' CreateCertificateAuthorityResponse Int
Creating a Request
data CreateCertificateAuthority Source #
See: newCreateCertificateAuthority smart constructor.
Constructors
| CreateCertificateAuthority' | |
Fields
| |
Instances
newCreateCertificateAuthority Source #
Arguments
| :: CertificateAuthorityConfiguration |
|
| -> CertificateAuthorityType | |
| -> CreateCertificateAuthority |
Create a value of CreateCertificateAuthority with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:idempotencyToken:CreateCertificateAuthority', createCertificateAuthority_idempotencyToken - 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, ACM Private CA recognizes that
you are requesting only certificate authority and will issue only one.
If you change the idempotency token for each call, PCA recognizes that
you are requesting multiple certificate authorities.
$sel:keyStorageSecurityStandard:CreateCertificateAuthority', createCertificateAuthority_keyStorageSecurityStandard - Specifies a cryptographic key management compliance standard used for
handling CA keys.
Default: FIPS_140_2_LEVEL_3_OR_HIGHER
Note: FIPS_140_2_LEVEL_3_OR_HIGHER is not supported in Region
ap-northeast-3. When creating a CA in the ap-northeast-3, you must
provide FIPS_140_2_LEVEL_2_OR_HIGHER as the argument for
KeyStorageSecurityStandard. Failure to do this results in an
InvalidArgsException with the message, "A certificate authority
cannot be created in this region with the specified security standard."
$sel:revocationConfiguration:CreateCertificateAuthority', createCertificateAuthority_revocationConfiguration - 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. For more information, see the
OcspConfiguration
and
CrlConfiguration
types.
$sel:tags:CreateCertificateAuthority', createCertificateAuthority_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.
$sel:certificateAuthorityConfiguration:CreateCertificateAuthority', createCertificateAuthority_certificateAuthorityConfiguration - Name and bit size of the private key algorithm, the name of the signing
algorithm, and X.500 certificate subject information.
$sel:certificateAuthorityType:CreateCertificateAuthority', createCertificateAuthority_certificateAuthorityType - The type of the certificate authority.
Request Lenses
createCertificateAuthority_idempotencyToken :: Lens' CreateCertificateAuthority (Maybe Text) Source #
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, ACM Private CA recognizes that you are requesting only certificate authority and will issue only one. If you change the idempotency token for each call, PCA recognizes that you are requesting multiple certificate authorities.
createCertificateAuthority_keyStorageSecurityStandard :: Lens' CreateCertificateAuthority (Maybe KeyStorageSecurityStandard) Source #
Specifies a cryptographic key management compliance standard used for handling CA keys.
Default: FIPS_140_2_LEVEL_3_OR_HIGHER
Note: FIPS_140_2_LEVEL_3_OR_HIGHER is not supported in Region
ap-northeast-3. When creating a CA in the ap-northeast-3, you must
provide FIPS_140_2_LEVEL_2_OR_HIGHER as the argument for
KeyStorageSecurityStandard. Failure to do this results in an
InvalidArgsException with the message, "A certificate authority
cannot be created in this region with the specified security standard."
createCertificateAuthority_revocationConfiguration :: Lens' CreateCertificateAuthority (Maybe RevocationConfiguration) Source #
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. For more information, see the OcspConfiguration and CrlConfiguration types.
createCertificateAuthority_tags :: Lens' CreateCertificateAuthority (Maybe (NonEmpty Tag)) Source #
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.
createCertificateAuthority_certificateAuthorityConfiguration :: Lens' CreateCertificateAuthority CertificateAuthorityConfiguration Source #
Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject information.
createCertificateAuthority_certificateAuthorityType :: Lens' CreateCertificateAuthority CertificateAuthorityType Source #
The type of the certificate authority.
Destructuring the Response
data CreateCertificateAuthorityResponse Source #
See: newCreateCertificateAuthorityResponse smart constructor.
Constructors
| CreateCertificateAuthorityResponse' | |
Fields
| |
Instances
newCreateCertificateAuthorityResponse Source #
Arguments
| :: Int | |
| -> CreateCertificateAuthorityResponse |
Create a value of CreateCertificateAuthorityResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:certificateAuthorityArn:CreateCertificateAuthorityResponse', createCertificateAuthorityResponse_certificateAuthorityArn - If successful, the Amazon Resource Name (ARN) of the certificate
authority (CA). This is of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
$sel:httpStatus:CreateCertificateAuthorityResponse', createCertificateAuthorityResponse_httpStatus - The response's http status code.
Response Lenses
createCertificateAuthorityResponse_certificateAuthorityArn :: Lens' CreateCertificateAuthorityResponse (Maybe Text) Source #
If successful, the Amazon Resource Name (ARN) of the certificate authority (CA). This is of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
createCertificateAuthorityResponse_httpStatus :: Lens' CreateCertificateAuthorityResponse Int Source #
The response's http status code.