| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.CertificateManagerPCA.Types
Contents
- Service Configuration
- Errors
- AccessMethodType
- ActionType
- AuditReportResponseFormat
- AuditReportStatus
- CertificateAuthorityStatus
- CertificateAuthorityType
- CertificateAuthorityUsageMode
- ExtendedKeyUsageType
- FailureReason
- KeyAlgorithm
- KeyStorageSecurityStandard
- PolicyQualifierId
- ResourceOwner
- RevocationReason
- S3ObjectAcl
- SigningAlgorithm
- ValidityPeriodType
- ASN1Subject
- AccessDescription
- AccessMethod
- ApiPassthrough
- CertificateAuthority
- CertificateAuthorityConfiguration
- CrlConfiguration
- CsrExtensions
- CustomAttribute
- CustomExtension
- EdiPartyName
- ExtendedKeyUsage
- Extensions
- GeneralName
- KeyUsage
- OcspConfiguration
- OtherName
- Permission
- PolicyInformation
- PolicyQualifierInfo
- Qualifier
- RevocationConfiguration
- Tag
- Validity
Description
Synopsis
- defaultService :: Service
- _CertificateMismatchException :: AsError a => Fold a ServiceError
- _ConcurrentModificationException :: AsError a => Fold a ServiceError
- _InvalidArgsException :: AsError a => Fold a ServiceError
- _InvalidArnException :: AsError a => Fold a ServiceError
- _InvalidNextTokenException :: AsError a => Fold a ServiceError
- _InvalidPolicyException :: AsError a => Fold a ServiceError
- _InvalidRequestException :: AsError a => Fold a ServiceError
- _InvalidStateException :: AsError a => Fold a ServiceError
- _InvalidTagException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _LockoutPreventedException :: AsError a => Fold a ServiceError
- _MalformedCSRException :: AsError a => Fold a ServiceError
- _MalformedCertificateException :: AsError a => Fold a ServiceError
- _PermissionAlreadyExistsException :: AsError a => Fold a ServiceError
- _RequestAlreadyProcessedException :: AsError a => Fold a ServiceError
- _RequestFailedException :: AsError a => Fold a ServiceError
- _RequestInProgressException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _TooManyTagsException :: AsError a => Fold a ServiceError
- newtype AccessMethodType where
- newtype ActionType where
- ActionType' { }
- pattern ActionType_GetCertificate :: ActionType
- pattern ActionType_IssueCertificate :: ActionType
- pattern ActionType_ListPermissions :: ActionType
- newtype AuditReportResponseFormat where
- newtype AuditReportStatus where
- AuditReportStatus' { }
- pattern AuditReportStatus_CREATING :: AuditReportStatus
- pattern AuditReportStatus_FAILED :: AuditReportStatus
- pattern AuditReportStatus_SUCCESS :: AuditReportStatus
- newtype CertificateAuthorityStatus where
- CertificateAuthorityStatus' { }
- pattern CertificateAuthorityStatus_ACTIVE :: CertificateAuthorityStatus
- pattern CertificateAuthorityStatus_CREATING :: CertificateAuthorityStatus
- pattern CertificateAuthorityStatus_DELETED :: CertificateAuthorityStatus
- pattern CertificateAuthorityStatus_DISABLED :: CertificateAuthorityStatus
- pattern CertificateAuthorityStatus_EXPIRED :: CertificateAuthorityStatus
- pattern CertificateAuthorityStatus_FAILED :: CertificateAuthorityStatus
- pattern CertificateAuthorityStatus_PENDING_CERTIFICATE :: CertificateAuthorityStatus
- newtype CertificateAuthorityType where
- newtype CertificateAuthorityUsageMode where
- newtype ExtendedKeyUsageType where
- ExtendedKeyUsageType' { }
- pattern ExtendedKeyUsageType_CERTIFICATE_TRANSPARENCY :: ExtendedKeyUsageType
- pattern ExtendedKeyUsageType_CLIENT_AUTH :: ExtendedKeyUsageType
- pattern ExtendedKeyUsageType_CODE_SIGNING :: ExtendedKeyUsageType
- pattern ExtendedKeyUsageType_DOCUMENT_SIGNING :: ExtendedKeyUsageType
- pattern ExtendedKeyUsageType_EMAIL_PROTECTION :: ExtendedKeyUsageType
- pattern ExtendedKeyUsageType_OCSP_SIGNING :: ExtendedKeyUsageType
- pattern ExtendedKeyUsageType_SERVER_AUTH :: ExtendedKeyUsageType
- pattern ExtendedKeyUsageType_SMART_CARD_LOGIN :: ExtendedKeyUsageType
- pattern ExtendedKeyUsageType_TIME_STAMPING :: ExtendedKeyUsageType
- newtype FailureReason where
- FailureReason' { }
- pattern FailureReason_OTHER :: FailureReason
- pattern FailureReason_REQUEST_TIMED_OUT :: FailureReason
- pattern FailureReason_UNSUPPORTED_ALGORITHM :: FailureReason
- newtype KeyAlgorithm where
- KeyAlgorithm' { }
- pattern KeyAlgorithm_EC_prime256v1 :: KeyAlgorithm
- pattern KeyAlgorithm_EC_secp384r1 :: KeyAlgorithm
- pattern KeyAlgorithm_RSA_2048 :: KeyAlgorithm
- pattern KeyAlgorithm_RSA_4096 :: KeyAlgorithm
- newtype KeyStorageSecurityStandard where
- newtype PolicyQualifierId where
- PolicyQualifierId' { }
- pattern PolicyQualifierId_CPS :: PolicyQualifierId
- newtype ResourceOwner where
- ResourceOwner' { }
- pattern ResourceOwner_OTHER_ACCOUNTS :: ResourceOwner
- pattern ResourceOwner_SELF :: ResourceOwner
- newtype RevocationReason where
- RevocationReason' { }
- pattern RevocationReason_AFFILIATION_CHANGED :: RevocationReason
- pattern RevocationReason_A_A_COMPROMISE :: RevocationReason
- pattern RevocationReason_CERTIFICATE_AUTHORITY_COMPROMISE :: RevocationReason
- pattern RevocationReason_CESSATION_OF_OPERATION :: RevocationReason
- pattern RevocationReason_KEY_COMPROMISE :: RevocationReason
- pattern RevocationReason_PRIVILEGE_WITHDRAWN :: RevocationReason
- pattern RevocationReason_SUPERSEDED :: RevocationReason
- pattern RevocationReason_UNSPECIFIED :: RevocationReason
- newtype S3ObjectAcl where
- S3ObjectAcl' { }
- pattern S3ObjectAcl_BUCKET_OWNER_FULL_CONTROL :: S3ObjectAcl
- pattern S3ObjectAcl_PUBLIC_READ :: S3ObjectAcl
- newtype SigningAlgorithm where
- SigningAlgorithm' { }
- pattern SigningAlgorithm_SHA256WITHECDSA :: SigningAlgorithm
- pattern SigningAlgorithm_SHA256WITHRSA :: SigningAlgorithm
- pattern SigningAlgorithm_SHA384WITHECDSA :: SigningAlgorithm
- pattern SigningAlgorithm_SHA384WITHRSA :: SigningAlgorithm
- pattern SigningAlgorithm_SHA512WITHECDSA :: SigningAlgorithm
- pattern SigningAlgorithm_SHA512WITHRSA :: SigningAlgorithm
- newtype ValidityPeriodType where
- ValidityPeriodType' { }
- pattern ValidityPeriodType_ABSOLUTE :: ValidityPeriodType
- pattern ValidityPeriodType_DAYS :: ValidityPeriodType
- pattern ValidityPeriodType_END_DATE :: ValidityPeriodType
- pattern ValidityPeriodType_MONTHS :: ValidityPeriodType
- pattern ValidityPeriodType_YEARS :: ValidityPeriodType
- data ASN1Subject = ASN1Subject' {
- commonName :: Maybe Text
- country :: Maybe Text
- customAttributes :: Maybe (NonEmpty CustomAttribute)
- distinguishedNameQualifier :: Maybe Text
- generationQualifier :: Maybe Text
- givenName :: Maybe Text
- initials :: Maybe Text
- locality :: Maybe Text
- organization :: Maybe Text
- organizationalUnit :: Maybe Text
- pseudonym :: Maybe Text
- serialNumber :: Maybe Text
- state :: Maybe Text
- surname :: Maybe Text
- title :: Maybe Text
- newASN1Subject :: ASN1Subject
- aSN1Subject_commonName :: Lens' ASN1Subject (Maybe Text)
- aSN1Subject_country :: Lens' ASN1Subject (Maybe Text)
- aSN1Subject_customAttributes :: Lens' ASN1Subject (Maybe (NonEmpty CustomAttribute))
- aSN1Subject_distinguishedNameQualifier :: Lens' ASN1Subject (Maybe Text)
- aSN1Subject_generationQualifier :: Lens' ASN1Subject (Maybe Text)
- aSN1Subject_givenName :: Lens' ASN1Subject (Maybe Text)
- aSN1Subject_initials :: Lens' ASN1Subject (Maybe Text)
- aSN1Subject_locality :: Lens' ASN1Subject (Maybe Text)
- aSN1Subject_organization :: Lens' ASN1Subject (Maybe Text)
- aSN1Subject_organizationalUnit :: Lens' ASN1Subject (Maybe Text)
- aSN1Subject_pseudonym :: Lens' ASN1Subject (Maybe Text)
- aSN1Subject_serialNumber :: Lens' ASN1Subject (Maybe Text)
- aSN1Subject_state :: Lens' ASN1Subject (Maybe Text)
- aSN1Subject_surname :: Lens' ASN1Subject (Maybe Text)
- aSN1Subject_title :: Lens' ASN1Subject (Maybe Text)
- data AccessDescription = AccessDescription' {}
- newAccessDescription :: AccessMethod -> GeneralName -> AccessDescription
- accessDescription_accessMethod :: Lens' AccessDescription AccessMethod
- accessDescription_accessLocation :: Lens' AccessDescription GeneralName
- data AccessMethod = AccessMethod' {}
- newAccessMethod :: AccessMethod
- accessMethod_accessMethodType :: Lens' AccessMethod (Maybe AccessMethodType)
- accessMethod_customObjectIdentifier :: Lens' AccessMethod (Maybe Text)
- data ApiPassthrough = ApiPassthrough' {}
- newApiPassthrough :: ApiPassthrough
- apiPassthrough_extensions :: Lens' ApiPassthrough (Maybe Extensions)
- apiPassthrough_subject :: Lens' ApiPassthrough (Maybe ASN1Subject)
- data CertificateAuthority = CertificateAuthority' {
- arn :: Maybe Text
- certificateAuthorityConfiguration :: Maybe CertificateAuthorityConfiguration
- createdAt :: Maybe POSIX
- failureReason :: Maybe FailureReason
- keyStorageSecurityStandard :: Maybe KeyStorageSecurityStandard
- lastStateChangeAt :: Maybe POSIX
- notAfter :: Maybe POSIX
- notBefore :: Maybe POSIX
- ownerAccount :: Maybe Text
- restorableUntil :: Maybe POSIX
- revocationConfiguration :: Maybe RevocationConfiguration
- serial :: Maybe Text
- status :: Maybe CertificateAuthorityStatus
- type' :: Maybe CertificateAuthorityType
- usageMode :: Maybe CertificateAuthorityUsageMode
- newCertificateAuthority :: CertificateAuthority
- certificateAuthority_arn :: Lens' CertificateAuthority (Maybe Text)
- certificateAuthority_certificateAuthorityConfiguration :: Lens' CertificateAuthority (Maybe CertificateAuthorityConfiguration)
- certificateAuthority_createdAt :: Lens' CertificateAuthority (Maybe UTCTime)
- certificateAuthority_failureReason :: Lens' CertificateAuthority (Maybe FailureReason)
- certificateAuthority_keyStorageSecurityStandard :: Lens' CertificateAuthority (Maybe KeyStorageSecurityStandard)
- certificateAuthority_lastStateChangeAt :: Lens' CertificateAuthority (Maybe UTCTime)
- certificateAuthority_notAfter :: Lens' CertificateAuthority (Maybe UTCTime)
- certificateAuthority_notBefore :: Lens' CertificateAuthority (Maybe UTCTime)
- certificateAuthority_ownerAccount :: Lens' CertificateAuthority (Maybe Text)
- certificateAuthority_restorableUntil :: Lens' CertificateAuthority (Maybe UTCTime)
- certificateAuthority_revocationConfiguration :: Lens' CertificateAuthority (Maybe RevocationConfiguration)
- certificateAuthority_serial :: Lens' CertificateAuthority (Maybe Text)
- certificateAuthority_status :: Lens' CertificateAuthority (Maybe CertificateAuthorityStatus)
- certificateAuthority_type :: Lens' CertificateAuthority (Maybe CertificateAuthorityType)
- certificateAuthority_usageMode :: Lens' CertificateAuthority (Maybe CertificateAuthorityUsageMode)
- data CertificateAuthorityConfiguration = CertificateAuthorityConfiguration' {}
- newCertificateAuthorityConfiguration :: KeyAlgorithm -> SigningAlgorithm -> ASN1Subject -> CertificateAuthorityConfiguration
- certificateAuthorityConfiguration_csrExtensions :: Lens' CertificateAuthorityConfiguration (Maybe CsrExtensions)
- certificateAuthorityConfiguration_keyAlgorithm :: Lens' CertificateAuthorityConfiguration KeyAlgorithm
- certificateAuthorityConfiguration_signingAlgorithm :: Lens' CertificateAuthorityConfiguration SigningAlgorithm
- certificateAuthorityConfiguration_subject :: Lens' CertificateAuthorityConfiguration ASN1Subject
- data CrlConfiguration = CrlConfiguration' {}
- newCrlConfiguration :: Bool -> CrlConfiguration
- crlConfiguration_customCname :: Lens' CrlConfiguration (Maybe Text)
- crlConfiguration_expirationInDays :: Lens' CrlConfiguration (Maybe Natural)
- crlConfiguration_s3BucketName :: Lens' CrlConfiguration (Maybe Text)
- crlConfiguration_s3ObjectAcl :: Lens' CrlConfiguration (Maybe S3ObjectAcl)
- crlConfiguration_enabled :: Lens' CrlConfiguration Bool
- data CsrExtensions = CsrExtensions' {}
- newCsrExtensions :: CsrExtensions
- csrExtensions_keyUsage :: Lens' CsrExtensions (Maybe KeyUsage)
- csrExtensions_subjectInformationAccess :: Lens' CsrExtensions (Maybe [AccessDescription])
- data CustomAttribute = CustomAttribute' {
- objectIdentifier :: Text
- value :: Text
- newCustomAttribute :: Text -> Text -> CustomAttribute
- customAttribute_objectIdentifier :: Lens' CustomAttribute Text
- customAttribute_value :: Lens' CustomAttribute Text
- data CustomExtension = CustomExtension' {}
- newCustomExtension :: Text -> Text -> CustomExtension
- customExtension_critical :: Lens' CustomExtension (Maybe Bool)
- customExtension_objectIdentifier :: Lens' CustomExtension Text
- customExtension_value :: Lens' CustomExtension Text
- data EdiPartyName = EdiPartyName' {
- nameAssigner :: Maybe Text
- partyName :: Text
- newEdiPartyName :: Text -> EdiPartyName
- ediPartyName_nameAssigner :: Lens' EdiPartyName (Maybe Text)
- ediPartyName_partyName :: Lens' EdiPartyName Text
- data ExtendedKeyUsage = ExtendedKeyUsage' {}
- newExtendedKeyUsage :: ExtendedKeyUsage
- extendedKeyUsage_extendedKeyUsageObjectIdentifier :: Lens' ExtendedKeyUsage (Maybe Text)
- extendedKeyUsage_extendedKeyUsageType :: Lens' ExtendedKeyUsage (Maybe ExtendedKeyUsageType)
- data Extensions = Extensions' {}
- newExtensions :: Extensions
- extensions_certificatePolicies :: Lens' Extensions (Maybe (NonEmpty PolicyInformation))
- extensions_customExtensions :: Lens' Extensions (Maybe (NonEmpty CustomExtension))
- extensions_extendedKeyUsage :: Lens' Extensions (Maybe (NonEmpty ExtendedKeyUsage))
- extensions_keyUsage :: Lens' Extensions (Maybe KeyUsage)
- extensions_subjectAlternativeNames :: Lens' Extensions (Maybe (NonEmpty GeneralName))
- data GeneralName = GeneralName' {}
- newGeneralName :: GeneralName
- generalName_directoryName :: Lens' GeneralName (Maybe ASN1Subject)
- generalName_dnsName :: Lens' GeneralName (Maybe Text)
- generalName_ediPartyName :: Lens' GeneralName (Maybe EdiPartyName)
- generalName_ipAddress :: Lens' GeneralName (Maybe Text)
- generalName_otherName :: Lens' GeneralName (Maybe OtherName)
- generalName_registeredId :: Lens' GeneralName (Maybe Text)
- generalName_rfc822Name :: Lens' GeneralName (Maybe Text)
- generalName_uniformResourceIdentifier :: Lens' GeneralName (Maybe Text)
- data KeyUsage = KeyUsage' {}
- newKeyUsage :: KeyUsage
- keyUsage_cRLSign :: Lens' KeyUsage (Maybe Bool)
- keyUsage_dataEncipherment :: Lens' KeyUsage (Maybe Bool)
- keyUsage_decipherOnly :: Lens' KeyUsage (Maybe Bool)
- keyUsage_digitalSignature :: Lens' KeyUsage (Maybe Bool)
- keyUsage_encipherOnly :: Lens' KeyUsage (Maybe Bool)
- keyUsage_keyAgreement :: Lens' KeyUsage (Maybe Bool)
- keyUsage_keyCertSign :: Lens' KeyUsage (Maybe Bool)
- keyUsage_keyEncipherment :: Lens' KeyUsage (Maybe Bool)
- keyUsage_nonRepudiation :: Lens' KeyUsage (Maybe Bool)
- data OcspConfiguration = OcspConfiguration' {
- ocspCustomCname :: Maybe Text
- enabled :: Bool
- newOcspConfiguration :: Bool -> OcspConfiguration
- ocspConfiguration_ocspCustomCname :: Lens' OcspConfiguration (Maybe Text)
- ocspConfiguration_enabled :: Lens' OcspConfiguration Bool
- data OtherName = OtherName' {}
- newOtherName :: Text -> Text -> OtherName
- otherName_typeId :: Lens' OtherName Text
- otherName_value :: Lens' OtherName Text
- data Permission = Permission' {}
- newPermission :: Permission
- permission_actions :: Lens' Permission (Maybe (NonEmpty ActionType))
- permission_certificateAuthorityArn :: Lens' Permission (Maybe Text)
- permission_createdAt :: Lens' Permission (Maybe UTCTime)
- permission_policy :: Lens' Permission (Maybe Text)
- permission_principal :: Lens' Permission (Maybe Text)
- permission_sourceAccount :: Lens' Permission (Maybe Text)
- data PolicyInformation = PolicyInformation' {}
- newPolicyInformation :: Text -> PolicyInformation
- policyInformation_policyQualifiers :: Lens' PolicyInformation (Maybe (NonEmpty PolicyQualifierInfo))
- policyInformation_certPolicyId :: Lens' PolicyInformation Text
- data PolicyQualifierInfo = PolicyQualifierInfo' {}
- newPolicyQualifierInfo :: PolicyQualifierId -> Qualifier -> PolicyQualifierInfo
- policyQualifierInfo_policyQualifierId :: Lens' PolicyQualifierInfo PolicyQualifierId
- policyQualifierInfo_qualifier :: Lens' PolicyQualifierInfo Qualifier
- data Qualifier = Qualifier' {}
- newQualifier :: Text -> Qualifier
- qualifier_cpsUri :: Lens' Qualifier Text
- data RevocationConfiguration = RevocationConfiguration' {}
- newRevocationConfiguration :: RevocationConfiguration
- revocationConfiguration_crlConfiguration :: Lens' RevocationConfiguration (Maybe CrlConfiguration)
- revocationConfiguration_ocspConfiguration :: Lens' RevocationConfiguration (Maybe OcspConfiguration)
- data Tag = Tag' {}
- newTag :: Text -> Tag
- tag_value :: Lens' Tag (Maybe Text)
- tag_key :: Lens' Tag Text
- data Validity = Validity' {}
- newValidity :: Natural -> ValidityPeriodType -> Validity
- validity_value :: Lens' Validity Natural
- validity_type :: Lens' Validity ValidityPeriodType
Service Configuration
defaultService :: Service Source #
API version 2017-08-22 of the Amazon Certificate Manager Private Certificate Authority SDK configuration.
Errors
_CertificateMismatchException :: AsError a => Fold a ServiceError Source #
The certificate authority certificate you are importing does not comply with conditions specified in the certificate that signed it.
_ConcurrentModificationException :: AsError a => Fold a ServiceError Source #
A previous update to your private CA is still ongoing.
_InvalidArgsException :: AsError a => Fold a ServiceError Source #
One or more of the specified arguments was not valid.
_InvalidArnException :: AsError a => Fold a ServiceError Source #
The requested Amazon Resource Name (ARN) does not refer to an existing resource.
_InvalidNextTokenException :: AsError a => Fold a ServiceError Source #
The token specified in the NextToken argument is not valid. Use the
token returned from your previous call to
ListCertificateAuthorities.
_InvalidPolicyException :: AsError a => Fold a ServiceError Source #
The resource policy is invalid or is missing a required statement. For general information about IAM policy and statement structure, see Overview of JSON Policies.
_InvalidRequestException :: AsError a => Fold a ServiceError Source #
The request action cannot be performed or is prohibited.
_InvalidStateException :: AsError a => Fold a ServiceError Source #
The state of the private CA does not allow this action to occur.
_InvalidTagException :: AsError a => Fold a ServiceError Source #
The tag associated with the CA is not valid. The invalid argument is contained in the message field.
_LimitExceededException :: AsError a => Fold a ServiceError Source #
An Amazon Web Services Private CA quota has been exceeded. See the exception message returned to determine the quota that was exceeded.
_LockoutPreventedException :: AsError a => Fold a ServiceError Source #
The current action was prevented because it would lock the caller out from performing subsequent actions. Verify that the specified parameters would not result in the caller being denied access to the resource.
_MalformedCSRException :: AsError a => Fold a ServiceError Source #
The certificate signing request is invalid.
_MalformedCertificateException :: AsError a => Fold a ServiceError Source #
One or more fields in the certificate are invalid.
_PermissionAlreadyExistsException :: AsError a => Fold a ServiceError Source #
The designated permission has already been given to the user.
_RequestAlreadyProcessedException :: AsError a => Fold a ServiceError Source #
Your request has already been completed.
_RequestFailedException :: AsError a => Fold a ServiceError Source #
The request has failed for an unspecified reason.
_RequestInProgressException :: AsError a => Fold a ServiceError Source #
Your request is already in progress.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.
_TooManyTagsException :: AsError a => Fold a ServiceError Source #
You can associate up to 50 tags with a private CA. Exception information is contained in the exception message field.
AccessMethodType
newtype AccessMethodType Source #
Constructors
| AccessMethodType' | |
Fields | |
Bundled Patterns
| pattern AccessMethodType_CA_REPOSITORY :: AccessMethodType | |
| pattern AccessMethodType_RESOURCE_PKI_MANIFEST :: AccessMethodType | |
| pattern AccessMethodType_RESOURCE_PKI_NOTIFY :: AccessMethodType |
Instances
ActionType
newtype ActionType Source #
Constructors
| ActionType' | |
Fields | |
Bundled Patterns
| pattern ActionType_GetCertificate :: ActionType | |
| pattern ActionType_IssueCertificate :: ActionType | |
| pattern ActionType_ListPermissions :: ActionType |
Instances
AuditReportResponseFormat
newtype AuditReportResponseFormat Source #
Constructors
| AuditReportResponseFormat' | |
Fields | |
Bundled Patterns
| pattern AuditReportResponseFormat_CSV :: AuditReportResponseFormat | |
| pattern AuditReportResponseFormat_JSON :: AuditReportResponseFormat |
Instances
AuditReportStatus
newtype AuditReportStatus Source #
Constructors
| AuditReportStatus' | |
Fields | |
Bundled Patterns
| pattern AuditReportStatus_CREATING :: AuditReportStatus | |
| pattern AuditReportStatus_FAILED :: AuditReportStatus | |
| pattern AuditReportStatus_SUCCESS :: AuditReportStatus |
Instances
CertificateAuthorityStatus
newtype CertificateAuthorityStatus Source #
Constructors
| CertificateAuthorityStatus' | |
Fields | |
Bundled Patterns
Instances
CertificateAuthorityType
newtype CertificateAuthorityType Source #
Constructors
| CertificateAuthorityType' | |
Fields | |
Bundled Patterns
| pattern CertificateAuthorityType_ROOT :: CertificateAuthorityType | |
| pattern CertificateAuthorityType_SUBORDINATE :: CertificateAuthorityType |
Instances
CertificateAuthorityUsageMode
newtype CertificateAuthorityUsageMode Source #
Constructors
| CertificateAuthorityUsageMode' | |
Fields | |
Bundled Patterns
| pattern CertificateAuthorityUsageMode_GENERAL_PURPOSE :: CertificateAuthorityUsageMode | |
| pattern CertificateAuthorityUsageMode_SHORT_LIVED_CERTIFICATE :: CertificateAuthorityUsageMode |
Instances
ExtendedKeyUsageType
newtype ExtendedKeyUsageType Source #
Constructors
| ExtendedKeyUsageType' | |
Fields | |
Bundled Patterns
Instances
FailureReason
newtype FailureReason Source #
Constructors
| FailureReason' | |
Fields | |
Bundled Patterns
| pattern FailureReason_OTHER :: FailureReason | |
| pattern FailureReason_REQUEST_TIMED_OUT :: FailureReason | |
| pattern FailureReason_UNSUPPORTED_ALGORITHM :: FailureReason |
Instances
KeyAlgorithm
newtype KeyAlgorithm Source #
Constructors
| KeyAlgorithm' | |
Fields | |
Bundled Patterns
| pattern KeyAlgorithm_EC_prime256v1 :: KeyAlgorithm | |
| pattern KeyAlgorithm_EC_secp384r1 :: KeyAlgorithm | |
| pattern KeyAlgorithm_RSA_2048 :: KeyAlgorithm | |
| pattern KeyAlgorithm_RSA_4096 :: KeyAlgorithm |
Instances
KeyStorageSecurityStandard
newtype KeyStorageSecurityStandard Source #
Constructors
| KeyStorageSecurityStandard' | |
Fields | |
Bundled Patterns
| pattern KeyStorageSecurityStandard_FIPS_140_2_LEVEL_2_OR_HIGHER :: KeyStorageSecurityStandard | |
| pattern KeyStorageSecurityStandard_FIPS_140_2_LEVEL_3_OR_HIGHER :: KeyStorageSecurityStandard |
Instances
PolicyQualifierId
newtype PolicyQualifierId Source #
Constructors
| PolicyQualifierId' | |
Fields | |
Bundled Patterns
| pattern PolicyQualifierId_CPS :: PolicyQualifierId |
Instances
ResourceOwner
newtype ResourceOwner Source #
Constructors
| ResourceOwner' | |
Fields | |
Bundled Patterns
| pattern ResourceOwner_OTHER_ACCOUNTS :: ResourceOwner | |
| pattern ResourceOwner_SELF :: ResourceOwner |
Instances
RevocationReason
newtype RevocationReason Source #
Constructors
| RevocationReason' | |
Fields | |
Bundled Patterns
| pattern RevocationReason_AFFILIATION_CHANGED :: RevocationReason | |
| pattern RevocationReason_A_A_COMPROMISE :: RevocationReason | |
| pattern RevocationReason_CERTIFICATE_AUTHORITY_COMPROMISE :: RevocationReason | |
| pattern RevocationReason_CESSATION_OF_OPERATION :: RevocationReason | |
| pattern RevocationReason_KEY_COMPROMISE :: RevocationReason | |
| pattern RevocationReason_PRIVILEGE_WITHDRAWN :: RevocationReason | |
| pattern RevocationReason_SUPERSEDED :: RevocationReason | |
| pattern RevocationReason_UNSPECIFIED :: RevocationReason |
Instances
S3ObjectAcl
newtype S3ObjectAcl Source #
Constructors
| S3ObjectAcl' | |
Fields | |
Bundled Patterns
| pattern S3ObjectAcl_BUCKET_OWNER_FULL_CONTROL :: S3ObjectAcl | |
| pattern S3ObjectAcl_PUBLIC_READ :: S3ObjectAcl |
Instances
SigningAlgorithm
newtype SigningAlgorithm Source #
Constructors
| SigningAlgorithm' | |
Fields | |
Bundled Patterns
| pattern SigningAlgorithm_SHA256WITHECDSA :: SigningAlgorithm | |
| pattern SigningAlgorithm_SHA256WITHRSA :: SigningAlgorithm | |
| pattern SigningAlgorithm_SHA384WITHECDSA :: SigningAlgorithm | |
| pattern SigningAlgorithm_SHA384WITHRSA :: SigningAlgorithm | |
| pattern SigningAlgorithm_SHA512WITHECDSA :: SigningAlgorithm | |
| pattern SigningAlgorithm_SHA512WITHRSA :: SigningAlgorithm |
Instances
ValidityPeriodType
newtype ValidityPeriodType Source #
Constructors
| ValidityPeriodType' | |
Fields | |
Bundled Patterns
| pattern ValidityPeriodType_ABSOLUTE :: ValidityPeriodType | |
| pattern ValidityPeriodType_DAYS :: ValidityPeriodType | |
| pattern ValidityPeriodType_END_DATE :: ValidityPeriodType | |
| pattern ValidityPeriodType_MONTHS :: ValidityPeriodType | |
| pattern ValidityPeriodType_YEARS :: ValidityPeriodType |
Instances
ASN1Subject
data ASN1Subject Source #
Contains information about the certificate subject. The Subject field
in the certificate identifies the entity that owns or controls the
public key in the certificate. The entity can be a user, computer,
device, or service. The Subject must contain an X.500 distinguished
name (DN). A DN is a sequence of relative distinguished names (RDNs).
The RDNs are separated by commas in the certificate.
See: newASN1Subject smart constructor.
Constructors
| ASN1Subject' | |
Fields
| |
Instances
newASN1Subject :: ASN1Subject Source #
Create a value of ASN1Subject 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:commonName:ASN1Subject', aSN1Subject_commonName - For CA and end-entity certificates in a private PKI, the common name
(CN) can be any string within the length limit.
Note: In publicly trusted certificates, the common name must be a fully qualified domain name (FQDN) associated with the certificate subject.
$sel:country:ASN1Subject', aSN1Subject_country - Two-digit code that specifies the country in which the certificate
subject located.
$sel:customAttributes:ASN1Subject', aSN1Subject_customAttributes - Contains a sequence of one or more X.500 relative distinguished names
(RDNs), each of which consists of an object identifier (OID) and a
value. For more information, see NIST’s definition of
Object Identifier (OID).
Custom attributes cannot be used in combination with standard attributes.
$sel:distinguishedNameQualifier:ASN1Subject', aSN1Subject_distinguishedNameQualifier - Disambiguating information for the certificate subject.
$sel:generationQualifier:ASN1Subject', aSN1Subject_generationQualifier - Typically a qualifier appended to the name of an individual. Examples
include Jr. for junior, Sr. for senior, and III for third.
$sel:givenName:ASN1Subject', aSN1Subject_givenName - First name.
$sel:initials:ASN1Subject', aSN1Subject_initials - Concatenation that typically contains the first letter of the
GivenName, the first letter of the middle name if one exists, and
the first letter of the Surname.
$sel:locality:ASN1Subject', aSN1Subject_locality - The locality (such as a city or town) in which the certificate subject
is located.
$sel:organization:ASN1Subject', aSN1Subject_organization - Legal name of the organization with which the certificate subject is
affiliated.
$sel:organizationalUnit:ASN1Subject', aSN1Subject_organizationalUnit - A subdivision or unit of the organization (such as sales or finance)
with which the certificate subject is affiliated.
$sel:pseudonym:ASN1Subject', aSN1Subject_pseudonym - Typically a shortened version of a longer GivenName. For example,
Jonathan is often shortened to John. Elizabeth is often shortened to
Beth, Liz, or Eliza.
$sel:serialNumber:ASN1Subject', aSN1Subject_serialNumber - The certificate serial number.
$sel:state:ASN1Subject', aSN1Subject_state - State in which the subject of the certificate is located.
$sel:surname:ASN1Subject', aSN1Subject_surname - Family name. In the US and the UK, for example, the surname of an
individual is ordered last. In Asian cultures the surname is typically
ordered first.
$sel:title:ASN1Subject', aSN1Subject_title - A title such as Mr. or Ms., which is pre-pended to the name to refer
formally to the certificate subject.
aSN1Subject_commonName :: Lens' ASN1Subject (Maybe Text) Source #
For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit.
Note: In publicly trusted certificates, the common name must be a fully qualified domain name (FQDN) associated with the certificate subject.
aSN1Subject_country :: Lens' ASN1Subject (Maybe Text) Source #
Two-digit code that specifies the country in which the certificate subject located.
aSN1Subject_customAttributes :: Lens' ASN1Subject (Maybe (NonEmpty CustomAttribute)) Source #
Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of which consists of an object identifier (OID) and a value. For more information, see NIST’s definition of Object Identifier (OID).
Custom attributes cannot be used in combination with standard attributes.
aSN1Subject_distinguishedNameQualifier :: Lens' ASN1Subject (Maybe Text) Source #
Disambiguating information for the certificate subject.
aSN1Subject_generationQualifier :: Lens' ASN1Subject (Maybe Text) Source #
Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.
aSN1Subject_givenName :: Lens' ASN1Subject (Maybe Text) Source #
First name.
aSN1Subject_initials :: Lens' ASN1Subject (Maybe Text) Source #
Concatenation that typically contains the first letter of the GivenName, the first letter of the middle name if one exists, and the first letter of the Surname.
aSN1Subject_locality :: Lens' ASN1Subject (Maybe Text) Source #
The locality (such as a city or town) in which the certificate subject is located.
aSN1Subject_organization :: Lens' ASN1Subject (Maybe Text) Source #
Legal name of the organization with which the certificate subject is affiliated.
aSN1Subject_organizationalUnit :: Lens' ASN1Subject (Maybe Text) Source #
A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.
aSN1Subject_pseudonym :: Lens' ASN1Subject (Maybe Text) Source #
Typically a shortened version of a longer GivenName. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza.
aSN1Subject_serialNumber :: Lens' ASN1Subject (Maybe Text) Source #
The certificate serial number.
aSN1Subject_state :: Lens' ASN1Subject (Maybe Text) Source #
State in which the subject of the certificate is located.
aSN1Subject_surname :: Lens' ASN1Subject (Maybe Text) Source #
Family name. In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first.
aSN1Subject_title :: Lens' ASN1Subject (Maybe Text) Source #
A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.
AccessDescription
data AccessDescription Source #
Provides access information used by the authorityInfoAccess and
subjectInfoAccess extensions described in
RFC 5280.
See: newAccessDescription smart constructor.
Constructors
| AccessDescription' | |
Fields
| |
Instances
Arguments
| :: AccessMethod | |
| -> GeneralName | |
| -> AccessDescription |
Create a value of AccessDescription 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:accessMethod:AccessDescription', accessDescription_accessMethod - The type and format of AccessDescription information.
$sel:accessLocation:AccessDescription', accessDescription_accessLocation - The location of AccessDescription information.
accessDescription_accessMethod :: Lens' AccessDescription AccessMethod Source #
The type and format of AccessDescription information.
accessDescription_accessLocation :: Lens' AccessDescription GeneralName Source #
The location of AccessDescription information.
AccessMethod
data AccessMethod Source #
Describes the type and format of extension access. Only one of
CustomObjectIdentifier or AccessMethodType may be provided.
Providing both results in InvalidArgsException.
See: newAccessMethod smart constructor.
Constructors
| AccessMethod' | |
Fields
| |
Instances
newAccessMethod :: AccessMethod Source #
Create a value of AccessMethod 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:accessMethodType:AccessMethod', accessMethod_accessMethodType - Specifies the AccessMethod.
$sel:customObjectIdentifier:AccessMethod', accessMethod_customObjectIdentifier - An object identifier (OID) specifying the AccessMethod. The OID must
satisfy the regular expression shown below. For more information, see
NIST's definition of
Object Identifier (OID).
accessMethod_accessMethodType :: Lens' AccessMethod (Maybe AccessMethodType) Source #
Specifies the AccessMethod.
accessMethod_customObjectIdentifier :: Lens' AccessMethod (Maybe Text) Source #
An object identifier (OID) specifying the AccessMethod. The OID must
satisfy the regular expression shown below. For more information, see
NIST's definition of
Object Identifier (OID).
ApiPassthrough
data ApiPassthrough Source #
Contains X.509 certificate information to be placed in an issued
certificate. An APIPassthrough or APICSRPassthrough template variant
must be selected, or else this parameter is ignored.
If conflicting or duplicate certificate information is supplied from other sources, Amazon Web Services Private CA applies order of operation rules to determine what information is used.
See: newApiPassthrough smart constructor.
Constructors
| ApiPassthrough' | |
Fields
| |
Instances
newApiPassthrough :: ApiPassthrough Source #
Create a value of ApiPassthrough 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:extensions:ApiPassthrough', apiPassthrough_extensions - Specifies X.509 extension information for a certificate.
$sel:subject:ApiPassthrough', apiPassthrough_subject - Undocumented member.
apiPassthrough_extensions :: Lens' ApiPassthrough (Maybe Extensions) Source #
Specifies X.509 extension information for a certificate.
apiPassthrough_subject :: Lens' ApiPassthrough (Maybe ASN1Subject) Source #
Undocumented member.
CertificateAuthority
data CertificateAuthority Source #
Contains information about your private certificate authority (CA). Your private CA can issue and revoke X.509 digital certificates. Digital certificates verify that the entity named in the certificate Subject field owns or controls the public key contained in the __Subject Public Key Info__ field. Call the CreateCertificateAuthority action to create your private CA. You must then call the GetCertificateAuthorityCertificate action to retrieve a private CA certificate signing request (CSR). Sign the CSR with your Amazon Web Services Private CA-hosted or on-premises root or subordinate CA certificate. Call the ImportCertificateAuthorityCertificate action to import the signed certificate into Certificate Manager (ACM).
See: newCertificateAuthority smart constructor.
Constructors
| CertificateAuthority' | |
Fields
| |
Instances
newCertificateAuthority :: CertificateAuthority Source #
Create a value of CertificateAuthority 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:arn:CertificateAuthority', certificateAuthority_arn - Amazon Resource Name (ARN) for your private certificate authority (CA).
The format is 12345678-1234-1234-1234-123456789012 .
$sel:certificateAuthorityConfiguration:CertificateAuthority', certificateAuthority_certificateAuthorityConfiguration - Your private CA configuration.
$sel:createdAt:CertificateAuthority', certificateAuthority_createdAt - Date and time at which your private CA was created.
$sel:failureReason:CertificateAuthority', certificateAuthority_failureReason - Reason the request to create your private CA failed.
$sel:keyStorageSecurityStandard:CertificateAuthority', certificateAuthority_keyStorageSecurityStandard - Defines a cryptographic key management compliance standard used for
handling CA keys.
Default: FIPS_140_2_LEVEL_3_OR_HIGHER
Note: Amazon Web Services Region ap-northeast-3 supports only
FIPS_140_2_LEVEL_2_OR_HIGHER. You must explicitly specify this parameter
and value when creating a CA in that Region. Specifying a different
value (or no value) results in an InvalidArgsException with the
message "A certificate authority cannot be created in this region with
the specified security standard."
$sel:lastStateChangeAt:CertificateAuthority', certificateAuthority_lastStateChangeAt - Date and time at which your private CA was last updated.
$sel:notAfter:CertificateAuthority', certificateAuthority_notAfter - Date and time after which your private CA certificate is not valid.
$sel:notBefore:CertificateAuthority', certificateAuthority_notBefore - Date and time before which your private CA certificate is not valid.
$sel:ownerAccount:CertificateAuthority', certificateAuthority_ownerAccount - The Amazon Web Services account ID that owns the certificate authority.
$sel:restorableUntil:CertificateAuthority', certificateAuthority_restorableUntil - The period during which a deleted CA can be restored. For more
information, see the PermanentDeletionTimeInDays parameter of the
DeleteCertificateAuthorityRequest
action.
$sel:revocationConfiguration:CertificateAuthority', certificateAuthority_revocationConfiguration - Information about the Online Certificate Status Protocol (OCSP)
configuration or certificate revocation list (CRL) created and
maintained by your private CA.
$sel:serial:CertificateAuthority', certificateAuthority_serial - Serial number of your private CA.
$sel:status:CertificateAuthority', certificateAuthority_status - Status of your private CA.
$sel:type':CertificateAuthority', certificateAuthority_type - Type of your private CA.
$sel:usageMode:CertificateAuthority', certificateAuthority_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.
certificateAuthority_arn :: Lens' CertificateAuthority (Maybe Text) Source #
Amazon Resource Name (ARN) for your private certificate authority (CA).
The format is 12345678-1234-1234-1234-123456789012 .
certificateAuthority_certificateAuthorityConfiguration :: Lens' CertificateAuthority (Maybe CertificateAuthorityConfiguration) Source #
Your private CA configuration.
certificateAuthority_createdAt :: Lens' CertificateAuthority (Maybe UTCTime) Source #
Date and time at which your private CA was created.
certificateAuthority_failureReason :: Lens' CertificateAuthority (Maybe FailureReason) Source #
Reason the request to create your private CA failed.
certificateAuthority_keyStorageSecurityStandard :: Lens' CertificateAuthority (Maybe KeyStorageSecurityStandard) Source #
Defines a cryptographic key management compliance standard used for handling CA keys.
Default: FIPS_140_2_LEVEL_3_OR_HIGHER
Note: Amazon Web Services Region ap-northeast-3 supports only
FIPS_140_2_LEVEL_2_OR_HIGHER. You must explicitly specify this parameter
and value when creating a CA in that Region. Specifying a different
value (or no value) results in an InvalidArgsException with the
message "A certificate authority cannot be created in this region with
the specified security standard."
certificateAuthority_lastStateChangeAt :: Lens' CertificateAuthority (Maybe UTCTime) Source #
Date and time at which your private CA was last updated.
certificateAuthority_notAfter :: Lens' CertificateAuthority (Maybe UTCTime) Source #
Date and time after which your private CA certificate is not valid.
certificateAuthority_notBefore :: Lens' CertificateAuthority (Maybe UTCTime) Source #
Date and time before which your private CA certificate is not valid.
certificateAuthority_ownerAccount :: Lens' CertificateAuthority (Maybe Text) Source #
The Amazon Web Services account ID that owns the certificate authority.
certificateAuthority_restorableUntil :: Lens' CertificateAuthority (Maybe UTCTime) Source #
The period during which a deleted CA can be restored. For more
information, see the PermanentDeletionTimeInDays parameter of the
DeleteCertificateAuthorityRequest
action.
certificateAuthority_revocationConfiguration :: Lens' CertificateAuthority (Maybe RevocationConfiguration) Source #
Information about the Online Certificate Status Protocol (OCSP) configuration or certificate revocation list (CRL) created and maintained by your private CA.
certificateAuthority_serial :: Lens' CertificateAuthority (Maybe Text) Source #
Serial number of your private CA.
certificateAuthority_status :: Lens' CertificateAuthority (Maybe CertificateAuthorityStatus) Source #
Status of your private CA.
certificateAuthority_type :: Lens' CertificateAuthority (Maybe CertificateAuthorityType) Source #
Type of your private CA.
certificateAuthority_usageMode :: Lens' CertificateAuthority (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.
CertificateAuthorityConfiguration
data CertificateAuthorityConfiguration Source #
Contains configuration information for your private certificate authority (CA). This includes information about the class of public key algorithm and the key pair that your private CA creates when it issues a certificate. It also includes the signature algorithm that it uses when issuing certificates, and its X.500 distinguished name. You must specify this information when you call the CreateCertificateAuthority action.
See: newCertificateAuthorityConfiguration smart constructor.
Constructors
| CertificateAuthorityConfiguration' | |
Fields
| |
Instances
newCertificateAuthorityConfiguration Source #
Arguments
| :: KeyAlgorithm | |
| -> SigningAlgorithm | |
| -> ASN1Subject | |
| -> CertificateAuthorityConfiguration |
Create a value of CertificateAuthorityConfiguration 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:csrExtensions:CertificateAuthorityConfiguration', certificateAuthorityConfiguration_csrExtensions - Specifies information to be added to the extension section of the
certificate signing request (CSR).
$sel:keyAlgorithm:CertificateAuthorityConfiguration', certificateAuthorityConfiguration_keyAlgorithm - Type of the public key algorithm and size, in bits, of the key pair that
your CA creates when it issues a certificate. When you create a
subordinate CA, you must use a key algorithm supported by the parent CA.
$sel:signingAlgorithm:CertificateAuthorityConfiguration', certificateAuthorityConfiguration_signingAlgorithm - Name of the algorithm your private CA uses to sign certificate requests.
This parameter should not be confused with the SigningAlgorithm
parameter used to sign certificates when they are issued.
$sel:subject:CertificateAuthorityConfiguration', certificateAuthorityConfiguration_subject - Structure that contains X.500 distinguished name information for your
private CA.
certificateAuthorityConfiguration_csrExtensions :: Lens' CertificateAuthorityConfiguration (Maybe CsrExtensions) Source #
Specifies information to be added to the extension section of the certificate signing request (CSR).
certificateAuthorityConfiguration_keyAlgorithm :: Lens' CertificateAuthorityConfiguration KeyAlgorithm Source #
Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. When you create a subordinate CA, you must use a key algorithm supported by the parent CA.
certificateAuthorityConfiguration_signingAlgorithm :: Lens' CertificateAuthorityConfiguration SigningAlgorithm Source #
Name of the algorithm your private CA uses to sign certificate requests.
This parameter should not be confused with the SigningAlgorithm
parameter used to sign certificates when they are issued.
certificateAuthorityConfiguration_subject :: Lens' CertificateAuthorityConfiguration ASN1Subject Source #
Structure that contains X.500 distinguished name information for your private CA.
CrlConfiguration
data CrlConfiguration Source #
Contains configuration information for a certificate revocation list
(CRL). Your private certificate authority (CA) creates base CRLs. Delta
CRLs are not supported. You can enable CRLs for your new or an existing
private CA by setting the Enabled parameter to true. Your private
CA writes CRLs to an S3 bucket that you specify in the S3BucketName
parameter. You can hide the name of your bucket by specifying a value
for the CustomCname parameter. Your private CA copies the CNAME or
the S3 bucket name to the CRL Distribution Points extension of each
certificate it issues. Your S3 bucket policy must give write permission
to Amazon Web Services Private CA.
Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs.
Your private CA uses the value in the ExpirationInDays parameter to calculate the nextUpdate field in the CRL. The CRL is refreshed prior to a certificate's expiration date or when a certificate is revoked. When a certificate is revoked, it appears in the CRL until the certificate expires, and then in one additional CRL after expiration, and it always appears in the audit report.
A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason a CRL update fails, Amazon Web Services Private CA makes further attempts every 15 minutes.
CRLs contain the following fields:
- Version: The current version number defined in RFC 5280 is V2. The integer value is 0x1.
- Signature Algorithm: The name of the algorithm used to sign the CRL.
- Issuer: The X.500 distinguished name of your private CA that issued the CRL.
- Last Update: The issue date and time of this CRL.
- Next Update: The day and time by which the next CRL will be issued.
Revoked Certificates: List of revoked certificates. Each list item contains the following information.
- Serial Number: The serial number, in hexadecimal format, of the revoked certificate.
- Revocation Date: Date and time the certificate was revoked.
CRL Entry Extensions: Optional extensions for the CRL entry.
- X509v3 CRL Reason Code: Reason the certificate was revoked.
CRL Extensions: Optional extensions for the CRL.
- X509v3 Authority Key Identifier: Identifies the public key associated with the private key used to sign the certificate.
- X509v3 CRL Number:: Decimal sequence number for the CRL.
- Signature Algorithm: Algorithm used by your private CA to sign the CRL.
- Signature Value: Signature computed over the CRL.
Certificate revocation lists created by Amazon Web Services Private CA are DER-encoded. You can use the following OpenSSL command to list a CRL.
openssl crl -inform DER -text -in crl_path -noout
For more information, see Planning a certificate revocation list (CRL) in the Amazon Web Services Private Certificate Authority User Guide
See: newCrlConfiguration smart constructor.
Constructors
| CrlConfiguration' | |
Fields
| |
Instances
Arguments
| :: Bool | |
| -> CrlConfiguration |
Create a value of CrlConfiguration 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:customCname:CrlConfiguration', crlConfiguration_customCname - Name inserted into the certificate CRL Distribution Points extension
that enables the use of an alias for the CRL distribution point. Use
this value if you don't want the name of your S3 bucket to be public.
The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as "http://" or "https://".
$sel:expirationInDays:CrlConfiguration', crlConfiguration_expirationInDays - Validity period of the CRL in days.
$sel:s3BucketName:CrlConfiguration', crlConfiguration_s3BucketName - Name of the S3 bucket that contains the CRL. If you do not provide a
value for the CustomCname argument, the name of your S3 bucket is
placed into the CRL Distribution Points extension of the issued
certificate. You can change the name of your bucket by calling the
UpdateCertificateAuthority
operation. You must specify a
bucket policy
that allows Amazon Web Services Private CA to write the CRL to your
bucket.
The S3BucketName parameter must conform to the
S3 bucket naming rules.
$sel:s3ObjectAcl:CrlConfiguration', crlConfiguration_s3ObjectAcl - Determines whether the CRL will be publicly readable or privately held
in the CRL Amazon S3 bucket. If you choose PUBLIC_READ, the CRL will be
accessible over the public internet. If you choose
BUCKET_OWNER_FULL_CONTROL, only the owner of the CRL S3 bucket can
access the CRL, and your PKI clients may need an alternative method of
access.
If no value is specified, the default is PUBLIC_READ.
Note: This default can cause CA creation to fail in some
circumstances. If you have have enabled the Block Public Access (BPA)
feature in your S3 account, then you must specify the value of this
parameter as BUCKET_OWNER_FULL_CONTROL, and not doing so results in an
error. If you have disabled BPA in S3, then you can specify either
BUCKET_OWNER_FULL_CONTROL or PUBLIC_READ as the value.
For more information, see Blocking public access to the S3 bucket.
$sel:enabled:CrlConfiguration', crlConfiguration_enabled - Boolean value that specifies whether certificate revocation lists (CRLs)
are enabled. You can use this value to enable certificate revocation for
a new CA when you call the
CreateCertificateAuthority
action or for an existing CA when you call the
UpdateCertificateAuthority
action.
crlConfiguration_customCname :: Lens' CrlConfiguration (Maybe Text) Source #
Name inserted into the certificate CRL Distribution Points extension that enables the use of an alias for the CRL distribution point. Use this value if you don't want the name of your S3 bucket to be public.
The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as "http://" or "https://".
crlConfiguration_expirationInDays :: Lens' CrlConfiguration (Maybe Natural) Source #
Validity period of the CRL in days.
crlConfiguration_s3BucketName :: Lens' CrlConfiguration (Maybe Text) Source #
Name of the S3 bucket that contains the CRL. If you do not provide a value for the CustomCname argument, the name of your S3 bucket is placed into the CRL Distribution Points extension of the issued certificate. You can change the name of your bucket by calling the UpdateCertificateAuthority operation. You must specify a bucket policy that allows Amazon Web Services Private CA to write the CRL to your bucket.
The S3BucketName parameter must conform to the
S3 bucket naming rules.
crlConfiguration_s3ObjectAcl :: Lens' CrlConfiguration (Maybe S3ObjectAcl) Source #
Determines whether the CRL will be publicly readable or privately held in the CRL Amazon S3 bucket. If you choose PUBLIC_READ, the CRL will be accessible over the public internet. If you choose BUCKET_OWNER_FULL_CONTROL, only the owner of the CRL S3 bucket can access the CRL, and your PKI clients may need an alternative method of access.
If no value is specified, the default is PUBLIC_READ.
Note: This default can cause CA creation to fail in some
circumstances. If you have have enabled the Block Public Access (BPA)
feature in your S3 account, then you must specify the value of this
parameter as BUCKET_OWNER_FULL_CONTROL, and not doing so results in an
error. If you have disabled BPA in S3, then you can specify either
BUCKET_OWNER_FULL_CONTROL or PUBLIC_READ as the value.
For more information, see Blocking public access to the S3 bucket.
crlConfiguration_enabled :: Lens' CrlConfiguration Bool Source #
Boolean value that specifies whether certificate revocation lists (CRLs) are enabled. You can use this value to enable certificate revocation for a new CA when you call the CreateCertificateAuthority action or for an existing CA when you call the UpdateCertificateAuthority action.
CsrExtensions
data CsrExtensions Source #
Describes the certificate extensions to be added to the certificate signing request (CSR).
See: newCsrExtensions smart constructor.
Constructors
| CsrExtensions' | |
Fields
| |
Instances
newCsrExtensions :: CsrExtensions Source #
Create a value of CsrExtensions 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:keyUsage:CsrExtensions', csrExtensions_keyUsage - Indicates the purpose of the certificate and of the key contained in the
certificate.
$sel:subjectInformationAccess:CsrExtensions', csrExtensions_subjectInformationAccess - For CA certificates, provides a path to additional information
pertaining to the CA, such as revocation and policy. For more
information, see
Subject Information Access
in RFC 5280.
csrExtensions_keyUsage :: Lens' CsrExtensions (Maybe KeyUsage) Source #
Indicates the purpose of the certificate and of the key contained in the certificate.
csrExtensions_subjectInformationAccess :: Lens' CsrExtensions (Maybe [AccessDescription]) Source #
For CA certificates, provides a path to additional information pertaining to the CA, such as revocation and policy. For more information, see Subject Information Access in RFC 5280.
CustomAttribute
data CustomAttribute Source #
Defines the X.500 relative distinguished name (RDN).
See: newCustomAttribute smart constructor.
Constructors
| CustomAttribute' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CustomAttribute |
Create a value of CustomAttribute 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:objectIdentifier:CustomAttribute', customAttribute_objectIdentifier - Specifies the object identifier (OID) of the attribute type of the
relative distinguished name (RDN).
$sel:value:CustomAttribute', customAttribute_value - Specifies the attribute value of relative distinguished name (RDN).
customAttribute_objectIdentifier :: Lens' CustomAttribute Text Source #
Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).
customAttribute_value :: Lens' CustomAttribute Text Source #
Specifies the attribute value of relative distinguished name (RDN).
CustomExtension
data CustomExtension Source #
Specifies the X.509 extension information for a certificate.
Extensions present in CustomExtensions follow the ApiPassthrough
template rules.
See: newCustomExtension smart constructor.
Constructors
| CustomExtension' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CustomExtension |
Create a value of CustomExtension 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:critical:CustomExtension', customExtension_critical - Specifies the critical flag of the X.509 extension.
$sel:objectIdentifier:CustomExtension', customExtension_objectIdentifier - Specifies the object identifier (OID) of the X.509 extension. For more
information, see the
Global OID reference database.
$sel:value:CustomExtension', customExtension_value - Specifies the base64-encoded value of the X.509 extension.
customExtension_critical :: Lens' CustomExtension (Maybe Bool) Source #
Specifies the critical flag of the X.509 extension.
customExtension_objectIdentifier :: Lens' CustomExtension Text Source #
Specifies the object identifier (OID) of the X.509 extension. For more information, see the Global OID reference database.
customExtension_value :: Lens' CustomExtension Text Source #
Specifies the base64-encoded value of the X.509 extension.
EdiPartyName
data EdiPartyName Source #
Describes an Electronic Data Interchange (EDI) entity as described in as defined in Subject Alternative Name in RFC 5280.
See: newEdiPartyName smart constructor.
Constructors
| EdiPartyName' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> EdiPartyName |
Create a value of EdiPartyName 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:nameAssigner:EdiPartyName', ediPartyName_nameAssigner - Specifies the name assigner.
$sel:partyName:EdiPartyName', ediPartyName_partyName - Specifies the party name.
ediPartyName_nameAssigner :: Lens' EdiPartyName (Maybe Text) Source #
Specifies the name assigner.
ediPartyName_partyName :: Lens' EdiPartyName Text Source #
Specifies the party name.
ExtendedKeyUsage
data ExtendedKeyUsage Source #
Specifies additional purposes for which the certified public key may be
used other than basic purposes indicated in the KeyUsage extension.
See: newExtendedKeyUsage smart constructor.
Constructors
| ExtendedKeyUsage' | |
Fields
| |
Instances
newExtendedKeyUsage :: ExtendedKeyUsage Source #
Create a value of ExtendedKeyUsage 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:extendedKeyUsageObjectIdentifier:ExtendedKeyUsage', extendedKeyUsage_extendedKeyUsageObjectIdentifier - Specifies a custom ExtendedKeyUsage with an object identifier (OID).
$sel:extendedKeyUsageType:ExtendedKeyUsage', extendedKeyUsage_extendedKeyUsageType - Specifies a standard ExtendedKeyUsage as defined as in
RFC 5280.
extendedKeyUsage_extendedKeyUsageObjectIdentifier :: Lens' ExtendedKeyUsage (Maybe Text) Source #
Specifies a custom ExtendedKeyUsage with an object identifier (OID).
extendedKeyUsage_extendedKeyUsageType :: Lens' ExtendedKeyUsage (Maybe ExtendedKeyUsageType) Source #
Specifies a standard ExtendedKeyUsage as defined as in
RFC 5280.
Extensions
data Extensions Source #
Contains X.509 extension information for a certificate.
See: newExtensions smart constructor.
Constructors
| Extensions' | |
Fields
| |
Instances
newExtensions :: Extensions Source #
Create a value of Extensions 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:certificatePolicies:Extensions', extensions_certificatePolicies - Contains a sequence of one or more policy information terms, each of
which consists of an object identifier (OID) and optional qualifiers.
For more information, see NIST's definition of
Object Identifier (OID).
In an end-entity certificate, these terms indicate the policy under which the certificate was issued and the purposes for which it may be used. In a CA certificate, these terms limit the set of policies for certification paths that include this certificate.
$sel:customExtensions:Extensions', extensions_customExtensions - Contains a sequence of one or more X.509 extensions, each of which
consists of an object identifier (OID), a base64-encoded value, and the
critical flag. For more information, see the
Global OID reference database.
$sel:extendedKeyUsage:Extensions', extensions_extendedKeyUsage - Specifies additional purposes for which the certified public key may be
used other than basic purposes indicated in the KeyUsage extension.
$sel:keyUsage:Extensions', extensions_keyUsage - Undocumented member.
$sel:subjectAlternativeNames:Extensions', extensions_subjectAlternativeNames - The subject alternative name extension allows identities to be bound to
the subject of the certificate. These identities may be included in
addition to or in place of the identity in the subject field of the
certificate.
extensions_certificatePolicies :: Lens' Extensions (Maybe (NonEmpty PolicyInformation)) Source #
Contains a sequence of one or more policy information terms, each of which consists of an object identifier (OID) and optional qualifiers. For more information, see NIST's definition of Object Identifier (OID).
In an end-entity certificate, these terms indicate the policy under which the certificate was issued and the purposes for which it may be used. In a CA certificate, these terms limit the set of policies for certification paths that include this certificate.
extensions_customExtensions :: Lens' Extensions (Maybe (NonEmpty CustomExtension)) Source #
Contains a sequence of one or more X.509 extensions, each of which consists of an object identifier (OID), a base64-encoded value, and the critical flag. For more information, see the Global OID reference database.
extensions_extendedKeyUsage :: Lens' Extensions (Maybe (NonEmpty ExtendedKeyUsage)) Source #
Specifies additional purposes for which the certified public key may be
used other than basic purposes indicated in the KeyUsage extension.
extensions_keyUsage :: Lens' Extensions (Maybe KeyUsage) Source #
Undocumented member.
extensions_subjectAlternativeNames :: Lens' Extensions (Maybe (NonEmpty GeneralName)) Source #
The subject alternative name extension allows identities to be bound to the subject of the certificate. These identities may be included in addition to or in place of the identity in the subject field of the certificate.
GeneralName
data GeneralName Source #
Describes an ASN.1 X.400 GeneralName as defined in
RFC 5280. Only one of
the following naming options should be provided. Providing more than one
option results in an InvalidArgsException error.
See: newGeneralName smart constructor.
Constructors
| GeneralName' | |
Fields
| |
Instances
newGeneralName :: GeneralName Source #
Create a value of GeneralName 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:directoryName:GeneralName', generalName_directoryName - Undocumented member.
$sel:dnsName:GeneralName', generalName_dnsName - Represents GeneralName as a DNS name.
$sel:ediPartyName:GeneralName', generalName_ediPartyName - Represents GeneralName as an EdiPartyName object.
$sel:ipAddress:GeneralName', generalName_ipAddress - Represents GeneralName as an IPv4 or IPv6 address.
$sel:otherName:GeneralName', generalName_otherName - Represents GeneralName using an OtherName object.
$sel:registeredId:GeneralName', generalName_registeredId - Represents GeneralName as an object identifier (OID).
$sel:rfc822Name:GeneralName', generalName_rfc822Name - Represents GeneralName as an
RFC 822 email address.
$sel:uniformResourceIdentifier:GeneralName', generalName_uniformResourceIdentifier - Represents GeneralName as a URI.
generalName_directoryName :: Lens' GeneralName (Maybe ASN1Subject) Source #
Undocumented member.
generalName_dnsName :: Lens' GeneralName (Maybe Text) Source #
Represents GeneralName as a DNS name.
generalName_ediPartyName :: Lens' GeneralName (Maybe EdiPartyName) Source #
Represents GeneralName as an EdiPartyName object.
generalName_ipAddress :: Lens' GeneralName (Maybe Text) Source #
Represents GeneralName as an IPv4 or IPv6 address.
generalName_otherName :: Lens' GeneralName (Maybe OtherName) Source #
Represents GeneralName using an OtherName object.
generalName_registeredId :: Lens' GeneralName (Maybe Text) Source #
Represents GeneralName as an object identifier (OID).
generalName_rfc822Name :: Lens' GeneralName (Maybe Text) Source #
Represents GeneralName as an
RFC 822 email address.
generalName_uniformResourceIdentifier :: Lens' GeneralName (Maybe Text) Source #
Represents GeneralName as a URI.
KeyUsage
Defines one or more purposes for which the key contained in the certificate can be used. Default value for each option is false.
See: newKeyUsage smart constructor.
Constructors
| KeyUsage' | |
Fields
| |
Instances
newKeyUsage :: KeyUsage Source #
Create a value of KeyUsage 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:cRLSign:KeyUsage', keyUsage_cRLSign - Key can be used to sign CRLs.
$sel:dataEncipherment:KeyUsage', keyUsage_dataEncipherment - Key can be used to decipher data.
$sel:decipherOnly:KeyUsage', keyUsage_decipherOnly - Key can be used only to decipher data.
$sel:digitalSignature:KeyUsage', keyUsage_digitalSignature - Key can be used for digital signing.
$sel:encipherOnly:KeyUsage', keyUsage_encipherOnly - Key can be used only to encipher data.
$sel:keyAgreement:KeyUsage', keyUsage_keyAgreement - Key can be used in a key-agreement protocol.
$sel:keyCertSign:KeyUsage', keyUsage_keyCertSign - Key can be used to sign certificates.
$sel:keyEncipherment:KeyUsage', keyUsage_keyEncipherment - Key can be used to encipher data.
$sel:nonRepudiation:KeyUsage', keyUsage_nonRepudiation - Key can be used for non-repudiation.
keyUsage_digitalSignature :: Lens' KeyUsage (Maybe Bool) Source #
Key can be used for digital signing.
keyUsage_keyAgreement :: Lens' KeyUsage (Maybe Bool) Source #
Key can be used in a key-agreement protocol.
OcspConfiguration
data OcspConfiguration Source #
Contains information to enable and configure Online Certificate Status Protocol (OCSP) for validating certificate revocation status.
When you revoke a certificate, OCSP responses may take up to 60 minutes to reflect the new status.
See: newOcspConfiguration smart constructor.
Constructors
| OcspConfiguration' | |
Fields
| |
Instances
Arguments
| :: Bool | |
| -> OcspConfiguration |
Create a value of OcspConfiguration 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:ocspCustomCname:OcspConfiguration', ocspConfiguration_ocspCustomCname - By default, Amazon Web Services Private CA injects an Amazon Web
Services domain into certificates being validated by the Online
Certificate Status Protocol (OCSP). A customer can alternatively use
this object to define a CNAME specifying a customized OCSP domain.
The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as "http://" or "https://".
For more information, see Customizing Online Certificate Status Protocol (OCSP) in the Amazon Web Services Private Certificate Authority User Guide.
$sel:enabled:OcspConfiguration', ocspConfiguration_enabled - Flag enabling use of the Online Certificate Status Protocol (OCSP) for
validating certificate revocation status.
ocspConfiguration_ocspCustomCname :: Lens' OcspConfiguration (Maybe Text) Source #
By default, Amazon Web Services Private CA injects an Amazon Web Services domain into certificates being validated by the Online Certificate Status Protocol (OCSP). A customer can alternatively use this object to define a CNAME specifying a customized OCSP domain.
The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as "http://" or "https://".
For more information, see Customizing Online Certificate Status Protocol (OCSP) in the Amazon Web Services Private Certificate Authority User Guide.
ocspConfiguration_enabled :: Lens' OcspConfiguration Bool Source #
Flag enabling use of the Online Certificate Status Protocol (OCSP) for validating certificate revocation status.
OtherName
Defines a custom ASN.1 X.400 GeneralName using an object identifier
(OID) and value. The OID must satisfy the regular expression shown
below. For more information, see NIST's definition of
Object Identifier (OID).
See: newOtherName smart constructor.
Constructors
| OtherName' | |
Instances
| FromJSON OtherName Source # | |
| ToJSON OtherName Source # | |
| Generic OtherName Source # | |
| Read OtherName Source # | |
| Show OtherName Source # | |
| NFData OtherName Source # | |
| Eq OtherName Source # | |
| Hashable OtherName Source # | |
| type Rep OtherName Source # | |
Defined in Amazonka.CertificateManagerPCA.Types.OtherName type Rep OtherName = D1 ('MetaData "OtherName" "Amazonka.CertificateManagerPCA.Types.OtherName" "amazonka-certificatemanager-pca-2.0-BrCc8DEClV63rMSVXz2XYH" 'False) (C1 ('MetaCons "OtherName'" 'PrefixI 'True) (S1 ('MetaSel ('Just "typeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of OtherName 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:typeId:OtherName', otherName_typeId - Specifies an OID.
$sel:value:OtherName', otherName_value - Specifies an OID value.
Permission
data Permission Source #
Permissions designate which private CA actions can be performed by an
Amazon Web Services service or entity. In order for ACM to automatically
renew private certificates, you must give the ACM service principal all
available permissions (IssueCertificate, GetCertificate, and
ListPermissions). Permissions can be assigned with the
CreatePermission
action, removed with the
DeletePermission
action, and listed with the
ListPermissions
action.
See: newPermission smart constructor.
Constructors
| Permission' | |
Fields
| |
Instances
newPermission :: Permission Source #
Create a value of Permission 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:actions:Permission', permission_actions - The private CA actions that can be performed by the designated Amazon
Web Services service.
$sel:certificateAuthorityArn:Permission', permission_certificateAuthorityArn - The Amazon Resource Number (ARN) of the private CA from which the
permission was issued.
$sel:createdAt:Permission', permission_createdAt - The time at which the permission was created.
$sel:policy:Permission', permission_policy - The name of the policy that is associated with the permission.
$sel:principal:Permission', permission_principal - The Amazon Web Services service or entity that holds the permission. At
this time, the only valid principal is acm.amazonaws.com.
$sel:sourceAccount:Permission', permission_sourceAccount - The ID of the account that assigned the permission.
permission_actions :: Lens' Permission (Maybe (NonEmpty ActionType)) Source #
The private CA actions that can be performed by the designated Amazon Web Services service.
permission_certificateAuthorityArn :: Lens' Permission (Maybe Text) Source #
The Amazon Resource Number (ARN) of the private CA from which the permission was issued.
permission_createdAt :: Lens' Permission (Maybe UTCTime) Source #
The time at which the permission was created.
permission_policy :: Lens' Permission (Maybe Text) Source #
The name of the policy that is associated with the permission.
permission_principal :: Lens' Permission (Maybe Text) Source #
The Amazon Web Services service or entity that holds the permission. At
this time, the only valid principal is acm.amazonaws.com.
permission_sourceAccount :: Lens' Permission (Maybe Text) Source #
The ID of the account that assigned the permission.
PolicyInformation
data PolicyInformation Source #
Defines the X.509 CertificatePolicies extension.
See: newPolicyInformation smart constructor.
Constructors
| PolicyInformation' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> PolicyInformation |
Create a value of PolicyInformation 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:policyQualifiers:PolicyInformation', policyInformation_policyQualifiers - Modifies the given CertPolicyId with a qualifier. Amazon Web Services
Private CA supports the certification practice statement (CPS)
qualifier.
$sel:certPolicyId:PolicyInformation', policyInformation_certPolicyId - Specifies the object identifier (OID) of the certificate policy under
which the certificate was issued. For more information, see NIST's
definition of
Object Identifier (OID).
policyInformation_policyQualifiers :: Lens' PolicyInformation (Maybe (NonEmpty PolicyQualifierInfo)) Source #
Modifies the given CertPolicyId with a qualifier. Amazon Web Services
Private CA supports the certification practice statement (CPS)
qualifier.
policyInformation_certPolicyId :: Lens' PolicyInformation Text Source #
Specifies the object identifier (OID) of the certificate policy under which the certificate was issued. For more information, see NIST's definition of Object Identifier (OID).
PolicyQualifierInfo
data PolicyQualifierInfo Source #
Modifies the CertPolicyId of a PolicyInformation object with a
qualifier. Amazon Web Services Private CA supports the certification
practice statement (CPS) qualifier.
See: newPolicyQualifierInfo smart constructor.
Constructors
| PolicyQualifierInfo' | |
Fields
| |
Instances
newPolicyQualifierInfo Source #
Arguments
| :: PolicyQualifierId | |
| -> Qualifier | |
| -> PolicyQualifierInfo |
Create a value of PolicyQualifierInfo 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:policyQualifierId:PolicyQualifierInfo', policyQualifierInfo_policyQualifierId - Identifies the qualifier modifying a CertPolicyId.
$sel:qualifier:PolicyQualifierInfo', policyQualifierInfo_qualifier - Defines the qualifier type. Amazon Web Services Private CA supports the
use of a URI for a CPS qualifier in this field.
policyQualifierInfo_policyQualifierId :: Lens' PolicyQualifierInfo PolicyQualifierId Source #
Identifies the qualifier modifying a CertPolicyId.
policyQualifierInfo_qualifier :: Lens' PolicyQualifierInfo Qualifier Source #
Defines the qualifier type. Amazon Web Services Private CA supports the use of a URI for a CPS qualifier in this field.
Qualifier
Defines a PolicyInformation qualifier. Amazon Web Services Private CA
supports the
certification practice statement (CPS) qualifier
defined in RFC 5280.
See: newQualifier smart constructor.
Constructors
| Qualifier' | |
Instances
| ToJSON Qualifier Source # | |
| Generic Qualifier Source # | |
| Read Qualifier Source # | |
| Show Qualifier Source # | |
| NFData Qualifier Source # | |
| Eq Qualifier Source # | |
| Hashable Qualifier Source # | |
| type Rep Qualifier Source # | |
Defined in Amazonka.CertificateManagerPCA.Types.Qualifier type Rep Qualifier = D1 ('MetaData "Qualifier" "Amazonka.CertificateManagerPCA.Types.Qualifier" "amazonka-certificatemanager-pca-2.0-BrCc8DEClV63rMSVXz2XYH" 'False) (C1 ('MetaCons "Qualifier'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cpsUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Qualifier 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:cpsUri:Qualifier', qualifier_cpsUri - Contains a pointer to a certification practice statement (CPS) published
by the CA.
qualifier_cpsUri :: Lens' Qualifier Text Source #
Contains a pointer to a certification practice statement (CPS) published by the CA.
RevocationConfiguration
data RevocationConfiguration Source #
Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions. Your private certificate authority (CA) can configure Online Certificate Status Protocol (OCSP) support and/or maintain a certificate revocation list (CRL). OCSP returns validation information about certificates as requested by clients, and a CRL contains an updated list of certificates revoked by your CA. For more information, see RevokeCertificate and Setting up a certificate revocation method in the Amazon Web Services Private Certificate Authority User Guide.
See: newRevocationConfiguration smart constructor.
Constructors
| RevocationConfiguration' | |
Fields
| |
Instances
newRevocationConfiguration :: RevocationConfiguration Source #
Create a value of RevocationConfiguration 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:crlConfiguration:RevocationConfiguration', revocationConfiguration_crlConfiguration - Configuration of the certificate revocation list (CRL), if any,
maintained by your private CA. A CRL is typically updated approximately
30 minutes after a certificate is revoked. If for any reason a CRL
update fails, Amazon Web Services Private CA makes further attempts
every 15 minutes.
$sel:ocspConfiguration:RevocationConfiguration', revocationConfiguration_ocspConfiguration - Configuration of Online Certificate Status Protocol (OCSP) support, if
any, maintained by your private CA. When you revoke a certificate, OCSP
responses may take up to 60 minutes to reflect the new status.
revocationConfiguration_crlConfiguration :: Lens' RevocationConfiguration (Maybe CrlConfiguration) Source #
Configuration of the certificate revocation list (CRL), if any, maintained by your private CA. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason a CRL update fails, Amazon Web Services Private CA makes further attempts every 15 minutes.
revocationConfiguration_ocspConfiguration :: Lens' RevocationConfiguration (Maybe OcspConfiguration) Source #
Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained by your private CA. When you revoke a certificate, OCSP responses may take up to 60 minutes to reflect the new status.
Tag
Tags are labels that you can use to identify and organize your private CAs. Each tag consists of a key and an optional value. You can associate up to 50 tags with a private CA. To add one or more tags to a private CA, call the TagCertificateAuthority action. To remove a tag, call the UntagCertificateAuthority action.
See: newTag smart constructor.
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.CertificateManagerPCA.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.CertificateManagerPCA.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.CertificateManagerPCA.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.CertificateManagerPCA.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.CertificateManagerPCA.Types.Tag" "amazonka-certificatemanager-pca-2.0-BrCc8DEClV63rMSVXz2XYH" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag 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:value:Tag', tag_value - Value of the tag.
$sel:key:Tag', tag_key - Key (name) of the tag.
Validity
Validity specifies the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the validity of a certificate starts or expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280.
Amazon Web Services Private CA API consumes the Validity data type
differently in two distinct parameters of the IssueCertificate action.
The required parameter IssueCertificate:Validity specifies the end
of a certificate's validity period. The optional parameter
IssueCertificate:ValidityNotBefore specifies a customized starting
time for the validity period.
See: newValidity smart constructor.
Constructors
| Validity' | |
Fields
| |
Instances
| ToJSON Validity Source # | |
| Generic Validity Source # | |
| Read Validity Source # | |
| Show Validity Source # | |
| NFData Validity Source # | |
| Eq Validity Source # | |
| Hashable Validity Source # | |
| type Rep Validity Source # | |
Defined in Amazonka.CertificateManagerPCA.Types.Validity type Rep Validity = D1 ('MetaData "Validity" "Amazonka.CertificateManagerPCA.Types.Validity" "amazonka-certificatemanager-pca-2.0-BrCc8DEClV63rMSVXz2XYH" 'False) (C1 ('MetaCons "Validity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ValidityPeriodType))) | |
Create a value of Validity 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:value:Validity', validity_value - A long integer interpreted according to the value of Type, below.
$sel:type':Validity', validity_type - Determines how Amazon Web Services Private CA interprets the Value
parameter, an integer. Supported validity types include those listed
below. Type definitions with values include a sample input value and the
resulting output.
END_DATE: The specific date and time when the certificate will expire,
expressed using UTCTime (YYMMDDHHMMSS) or GeneralizedTime
(YYYYMMDDHHMMSS) format. When UTCTime is used, if the year field (YY) is
greater than or equal to 50, the year is interpreted as 19YY. If the
year field is less than 50, the year is interpreted as 20YY.
- Sample input value: 491231235959 (UTCTime format)
- Output expiration date/time: 12/31/2049 23:59:59
ABSOLUTE: The specific date and time when the validity of a
certificate will start or expire, expressed in seconds since the Unix
Epoch.
- Sample input value: 2524608000
- Output expiration date/time: 01/01/2050 00:00:00
DAYS, MONTHS, YEARS: The relative time from the moment of issuance
until the certificate will expire, expressed in days, months, or years.
Example if DAYS, issued on 10/12/2020 at 12:34:54 UTC:
- Sample input value: 90
- Output expiration date: 01/10/2020 12:34:54 UTC
The minimum validity duration for a certificate using relative time
(DAYS) is one day. The minimum validity for a certificate using
absolute time (ABSOLUTE or END_DATE) is one second.
validity_value :: Lens' Validity Natural Source #
A long integer interpreted according to the value of Type, below.
validity_type :: Lens' Validity ValidityPeriodType Source #
Determines how Amazon Web Services Private CA interprets the Value
parameter, an integer. Supported validity types include those listed
below. Type definitions with values include a sample input value and the
resulting output.
END_DATE: The specific date and time when the certificate will expire,
expressed using UTCTime (YYMMDDHHMMSS) or GeneralizedTime
(YYYYMMDDHHMMSS) format. When UTCTime is used, if the year field (YY) is
greater than or equal to 50, the year is interpreted as 19YY. If the
year field is less than 50, the year is interpreted as 20YY.
- Sample input value: 491231235959 (UTCTime format)
- Output expiration date/time: 12/31/2049 23:59:59
ABSOLUTE: The specific date and time when the validity of a
certificate will start or expire, expressed in seconds since the Unix
Epoch.
- Sample input value: 2524608000
- Output expiration date/time: 01/01/2050 00:00:00
DAYS, MONTHS, YEARS: The relative time from the moment of issuance
until the certificate will expire, expressed in days, months, or years.
Example if DAYS, issued on 10/12/2020 at 12:34:54 UTC:
- Sample input value: 90
- Output expiration date: 01/10/2020 12:34:54 UTC
The minimum validity duration for a certificate using relative time
(DAYS) is one day. The minimum validity for a certificate using
absolute time (ABSOLUTE or END_DATE) is one second.