amazonka-certificatemanager-pca-2.0: Amazon Certificate Manager Private Certificate Authority SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

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.

Both Amazon Web Services Private CA 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 Access policies for CRLs in Amazon S3.

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

Synopsis

Creating a Request

data CreateCertificateAuthority Source #

See: newCreateCertificateAuthority smart constructor.

Constructors

CreateCertificateAuthority' 

Fields

  • idempotencyToken :: Maybe Text

    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, Amazon Web Services Private CA recognizes that you are requesting only certificate authority and will issue only one. If you change the idempotency token for each call, Amazon Web Services Private CA recognizes that you are requesting multiple certificate authorities.

  • keyStorageSecurityStandard :: Maybe 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 the following Regions:

    • ap-northeast-3
    • ap-southeast-3

    When creating a CA in these Regions, 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."

  • revocationConfiguration :: Maybe 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.

    The following requirements apply to revocation configurations.

    • A configuration disabling CRLs or OCSP must contain only the Enabled=False parameter, and will fail if other parameters such as CustomCname or ExpirationInDays are included.
    • In a CRL configuration, the S3BucketName parameter must conform to Amazon S3 bucket naming rules.
    • A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.
    • In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as "http://" or "https://".

    For more information, see the OcspConfiguration and CrlConfiguration types.

  • tags :: Maybe (NonEmpty Tag)

    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.

  • usageMode :: Maybe CertificateAuthorityUsageMode

    Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days.

    The default value is GENERAL_PURPOSE.

  • certificateAuthorityConfiguration :: CertificateAuthorityConfiguration

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

  • certificateAuthorityType :: CertificateAuthorityType

    The type of the certificate authority.

Instances

Instances details
ToJSON CreateCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.CreateCertificateAuthority

Methods

toJSON :: CreateCertificateAuthority -> Value #

toEncoding :: CreateCertificateAuthority -> Encoding #

toJSONList :: [CreateCertificateAuthority] -> Value #

toEncodingList :: [CreateCertificateAuthority] -> Encoding #

ToHeaders CreateCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.CreateCertificateAuthority

Methods

toHeaders :: CreateCertificateAuthority -> [Header] #

ToPath CreateCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.CreateCertificateAuthority

Methods

toPath :: CreateCertificateAuthority -> ByteString #

ToQuery CreateCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.CreateCertificateAuthority

Methods

toQuery :: CreateCertificateAuthority -> QueryString #

AWSRequest CreateCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.CreateCertificateAuthority

Associated Types

type AWSResponse CreateCertificateAuthority #

Methods

request :: (Service -> Service) -> CreateCertificateAuthority -> Request CreateCertificateAuthority #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateCertificateAuthority -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateCertificateAuthority))) #

Generic CreateCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.CreateCertificateAuthority

Associated Types

type Rep CreateCertificateAuthority :: Type -> Type #

Methods

from :: CreateCertificateAuthority -> Rep CreateCertificateAuthority x #

to :: Rep CreateCertificateAuthority x -> CreateCertificateAuthority #

Read CreateCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.CreateCertificateAuthority

Methods

readsPrec :: Int -> ReadS CreateCertificateAuthority #

readList :: ReadS [CreateCertificateAuthority] #

readPrec :: ReadPrec CreateCertificateAuthority #

readListPrec :: ReadPrec [CreateCertificateAuthority] #

Show CreateCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.CreateCertificateAuthority

Methods

showsPrec :: Int -> CreateCertificateAuthority -> ShowS #

show :: CreateCertificateAuthority -> String #

showList :: [CreateCertificateAuthority] -> ShowS #

NFData CreateCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.CreateCertificateAuthority

Methods

rnf :: CreateCertificateAuthority -> () #

Eq CreateCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.CreateCertificateAuthority

Methods

(==) :: CreateCertificateAuthority -> CreateCertificateAuthority -> Bool #

(/=) :: CreateCertificateAuthority -> CreateCertificateAuthority -> Bool #

Hashable CreateCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.CreateCertificateAuthority

Methods

hashWithSalt :: Int -> CreateCertificateAuthority -> Int #

hash :: CreateCertificateAuthority -> Int #

type AWSResponse CreateCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.CreateCertificateAuthority

type AWSResponse CreateCertificateAuthority = CreateCertificateAuthorityResponse
type Rep CreateCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.CreateCertificateAuthority

type Rep CreateCertificateAuthority = D1 ('MetaData "CreateCertificateAuthority" "Amazonka.CertificateManagerPCA.CreateCertificateAuthority" "amazonka-certificatemanager-pca-2.0-BrCc8DEClV63rMSVXz2XYH" 'False) (C1 ('MetaCons "CreateCertificateAuthority'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "idempotencyToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "keyStorageSecurityStandard") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KeyStorageSecurityStandard)) :*: S1 ('MetaSel ('Just "revocationConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RevocationConfiguration)))) :*: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :*: S1 ('MetaSel ('Just "usageMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CertificateAuthorityUsageMode))) :*: (S1 ('MetaSel ('Just "certificateAuthorityConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CertificateAuthorityConfiguration) :*: S1 ('MetaSel ('Just "certificateAuthorityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CertificateAuthorityType)))))

newCreateCertificateAuthority Source #

Arguments

:: CertificateAuthorityConfiguration

CreateCertificateAuthority

-> CertificateAuthorityType

$sel:certificateAuthorityType:CreateCertificateAuthority'

-> 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, Amazon Web Services Private CA recognizes that you are requesting only certificate authority and will issue only one. If you change the idempotency token for each call, Amazon Web Services Private CA recognizes that you are requesting multiple certificate authorities.

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 the following Regions:

  • ap-northeast-3
  • ap-southeast-3

When creating a CA in these Regions, 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, 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.

The following requirements apply to revocation configurations.

  • A configuration disabling CRLs or OCSP must contain only the Enabled=False parameter, and will fail if other parameters such as CustomCname or ExpirationInDays are included.
  • In a CRL configuration, the S3BucketName parameter must conform to Amazon S3 bucket naming rules.
  • A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.
  • In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as "http://" or "https://".

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.

CreateCertificateAuthority, createCertificateAuthority_usageMode - Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days.

The default value is GENERAL_PURPOSE.

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, Amazon Web Services Private CA recognizes that you are requesting only certificate authority and will issue only one. If you change the idempotency token for each call, Amazon Web Services Private CA 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 the following Regions:

  • ap-northeast-3
  • ap-southeast-3

When creating a CA in these Regions, 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.

The following requirements apply to revocation configurations.

  • A configuration disabling CRLs or OCSP must contain only the Enabled=False parameter, and will fail if other parameters such as CustomCname or ExpirationInDays are included.
  • In a CRL configuration, the S3BucketName parameter must conform to Amazon S3 bucket naming rules.
  • A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.
  • In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as "http://" or "https://".

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_usageMode :: Lens' CreateCertificateAuthority (Maybe CertificateAuthorityUsageMode) Source #

Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days.

The default value is GENERAL_PURPOSE.

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

  • certificateAuthorityArn :: Maybe Text

    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 .

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic CreateCertificateAuthorityResponse Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.CreateCertificateAuthority

Associated Types

type Rep CreateCertificateAuthorityResponse :: Type -> Type #

Methods

from :: CreateCertificateAuthorityResponse -> Rep CreateCertificateAuthorityResponse x #

to :: Rep CreateCertificateAuthorityResponse x -> CreateCertificateAuthorityResponse #

Read CreateCertificateAuthorityResponse Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.CreateCertificateAuthority

Methods

readsPrec :: Int -> ReadS CreateCertificateAuthorityResponse #

readList :: ReadS [CreateCertificateAuthorityResponse] #

readPrec :: ReadPrec CreateCertificateAuthorityResponse #

readListPrec :: ReadPrec [CreateCertificateAuthorityResponse] #

Show CreateCertificateAuthorityResponse Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.CreateCertificateAuthority

Methods

showsPrec :: Int -> CreateCertificateAuthorityResponse -> ShowS #

show :: CreateCertificateAuthorityResponse -> String #

showList :: [CreateCertificateAuthorityResponse] -> ShowS #

NFData CreateCertificateAuthorityResponse Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.CreateCertificateAuthority

Methods

rnf :: CreateCertificateAuthorityResponse -> () #

Eq CreateCertificateAuthorityResponse Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.CreateCertificateAuthority

Methods

(==) :: CreateCertificateAuthorityResponse -> CreateCertificateAuthorityResponse -> Bool #

(/=) :: CreateCertificateAuthorityResponse -> CreateCertificateAuthorityResponse -> Bool #

type Rep CreateCertificateAuthorityResponse Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.CreateCertificateAuthority

type Rep CreateCertificateAuthorityResponse = D1 ('MetaData "CreateCertificateAuthorityResponse" "Amazonka.CertificateManagerPCA.CreateCertificateAuthority" "amazonka-certificatemanager-pca-2.0-BrCc8DEClV63rMSVXz2XYH" 'False) (C1 ('MetaCons "CreateCertificateAuthorityResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "certificateAuthorityArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateCertificateAuthorityResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateCertificateAuthorityResponse'

-> 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:

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.