Package-level declarations

Types

Link copied to clipboard
data class CertificateApiPassthrough(val extensions: CertificateExtensions? = null, val subject: CertificateSubject? = null)

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, AWS Private CA applies order of operation rules to determine what information is used.

Link copied to clipboard

Structure that contains X.509 AccessDescription information.

Link copied to clipboard
data class CertificateAuthorityAccessMethod(val accessMethodType: String? = null, val customObjectIdentifier: String? = null)

Structure that contains X.509 AccessMethod information. Assign one and ONLY one field.

Link copied to clipboard
data class CertificateAuthorityCrlConfiguration(val crlDistributionPointExtensionConfiguration: CertificateAuthorityCrlDistributionPointExtensionConfiguration? = null, val customCname: String? = null, val enabled: Boolean, val expirationInDays: Int? = null, val s3BucketName: String? = null, val s3ObjectAcl: String? = null)

Your certificate authority can create and maintain a certificate revocation list (CRL). A CRL contains information about certificates that have been revoked.

Configures the default behavior of the CRL Distribution Point extension for certificates issued by your certificate authority

Link copied to clipboard
data class CertificateAuthorityCsrExtensions(val keyUsage: CertificateAuthorityKeyUsage? = null, val subjectInformationAccess: List<CertificateAuthorityAccessDescription>? = null)

Structure that contains CSR pass though extensions information.

Link copied to clipboard
data class CertificateAuthorityCustomAttribute(val objectIdentifier: String, val value: String)

Structure that contains X.500 attribute type and value.

Link copied to clipboard
data class CertificateAuthorityEdiPartyName(val nameAssigner: String? = null, val partyName: String)

Structure that contains X.509 EdiPartyName information.

Link copied to clipboard
data class CertificateAuthorityGeneralName(val directoryName: CertificateAuthoritySubject? = null, val dnsName: String? = null, val ediPartyName: CertificateAuthorityEdiPartyName? = null, val ipAddress: String? = null, val otherName: CertificateAuthorityOtherName? = null, val registeredId: String? = null, val rfc822Name: String? = null, val uniformResourceIdentifier: String? = null)

Structure that contains X.509 GeneralName information. Assign one and ONLY one field.

Link copied to clipboard
data class CertificateAuthorityKeyUsage(val crlSign: Boolean? = null, val dataEncipherment: Boolean? = null, val decipherOnly: Boolean? = null, val digitalSignature: Boolean? = null, val encipherOnly: Boolean? = null, val keyAgreement: Boolean? = null, val keyCertSign: Boolean? = null, val keyEncipherment: Boolean? = null, val nonRepudiation: Boolean? = null)

Structure that contains X.509 KeyUsage information.

Link copied to clipboard
data class CertificateAuthorityOcspConfiguration(val enabled: Boolean, val ocspCustomCname: String? = null)

Helps to configure online certificate status protocol (OCSP) responder for your certificate authority

Link copied to clipboard
data class CertificateAuthorityOtherName(val typeId: String, val value: String)

Structure that contains X.509 OtherName information.

Certificate Authority revocation information.

Link copied to clipboard
data class CertificateAuthoritySubject(val commonName: String? = null, val country: String? = null, val customAttributes: List<CertificateAuthorityCustomAttribute>? = null, val distinguishedNameQualifier: String? = null, val generationQualifier: String? = null, val givenName: String? = null, val initials: String? = null, val locality: String? = null, val organization: String? = null, val organizationalUnit: String? = null, val pseudonym: String? = null, val serialNumber: String? = null, val state: String? = null, val surname: String? = null, val title: String? = null)

Structure that contains X.500 distinguished name information for your CA.

Link copied to clipboard
data class CertificateCustomAttribute(val objectIdentifier: String, val value: String)

Defines the X.500 relative distinguished name (RDN).

Link copied to clipboard
data class CertificateCustomExtension(val critical: Boolean? = null, val objectIdentifier: String, val value: String)

Specifies the X.509 extension information for a certificate. Extensions present in `CustomExtensions` follow the `ApiPassthrough` template rules.

Link copied to clipboard
data class CertificateEdiPartyName(val nameAssigner: String, val partyName: String)

Describes an Electronic Data Interchange (EDI) entity as described in as defined in Subject Alternative Name in RFC 5280.

Link copied to clipboard
data class CertificateExtendedKeyUsage(val extendedKeyUsageObjectIdentifier: String? = null, val extendedKeyUsageType: String? = null)

Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the `KeyUsage` extension.

Link copied to clipboard
data class CertificateExtensions(val certificatePolicies: List<CertificatePolicyInformation>? = null, val customExtensions: List<CertificateCustomExtension>? = null, val extendedKeyUsage: List<CertificateExtendedKeyUsage>? = null, val keyUsage: CertificateKeyUsage? = null, val subjectAlternativeNames: List<CertificateGeneralName>? = null)

Contains X.509 extension information for a certificate.

Link copied to clipboard
data class CertificateGeneralName(val directoryName: CertificateSubject? = null, val dnsName: String? = null, val ediPartyName: CertificateEdiPartyName? = null, val ipAddress: String? = null, val otherName: CertificateOtherName? = null, val registeredId: String? = null, val rfc822Name: String? = null, val uniformResourceIdentifier: String? = null)

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.

Link copied to clipboard
data class CertificateKeyUsage(val crlSign: Boolean? = null, val dataEncipherment: Boolean? = null, val decipherOnly: Boolean? = null, val digitalSignature: Boolean? = null, val encipherOnly: Boolean? = null, val keyAgreement: Boolean? = null, val keyCertSign: Boolean? = null, val keyEncipherment: Boolean? = null, val nonRepudiation: Boolean? = null)

Defines one or more purposes for which the key contained in the certificate can be used. Default value for each option is false.

Link copied to clipboard
data class CertificateOtherName(val typeId: String, val value: String)

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).

Link copied to clipboard
data class CertificatePolicyInformation(val certPolicyId: String, val policyQualifiers: List<CertificatePolicyQualifierInfo>? = null)

Defines the X.509 `CertificatePolicies` extension.

Link copied to clipboard
data class CertificatePolicyQualifierInfo(val policyQualifierId: String, val qualifier: CertificateQualifier)

Modifies the `CertPolicyId` of a `PolicyInformation` object with a qualifier. AWS Private CA supports the certification practice statement (CPS) qualifier.

Link copied to clipboard
data class CertificateQualifier(val cpsUri: String)

Defines a `PolicyInformation` qualifier. AWS Private CA supports the certification practice statement (CPS) qualifier defined in RFC 5280.

Link copied to clipboard
data class CertificateSubject(val commonName: String? = null, val country: String? = null, val customAttributes: List<CertificateCustomAttribute>? = null, val distinguishedNameQualifier: String? = null, val generationQualifier: String? = null, val givenName: String? = null, val initials: String? = null, val locality: String? = null, val organization: String? = null, val organizationalUnit: String? = null, val pseudonym: String? = null, val serialNumber: String? = null, val state: String? = null, val surname: String? = null, val title: String? = null)

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.

Link copied to clipboard
data class CertificateValidity(val type: String, val value: Double)

Length of time for which the certificate issued by your private certificate authority (CA), or by the private CA itself, is valid in days, months, or years. You can issue a certificate by calling the `IssueCertificate` operation.

Link copied to clipboard
data class GetCertificateAuthorityActivationResult(val completeCertificateChain: String? = null, val status: String? = null)
Link copied to clipboard
data class GetCertificateAuthorityResult(val arn: String? = null, val certificateSigningRequest: String? = null)
Link copied to clipboard
data class GetCertificateResult(val arn: String? = null, val certificate: String? = null)