String country
Two-digit code that specifies the country in which the certificate subject located.
String organization
Legal name of the organization with which the certificate subject is affiliated.
String organizationalUnit
A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.
String distinguishedNameQualifier
Disambiguating information for the certificate subject.
String state
State in which the subject of the certificate is located.
String commonName
Fully qualified domain name (FQDN) associated with the certificate subject.
String serialNumber
The certificate serial number.
String locality
The locality (such as a city or town) in which the certificate subject is located.
String title
A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.
String 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.
String givenName
First name.
String 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.
String 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.
String generationQualifier
Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.
String arn
Amazon Resource Name (ARN) for your private certificate authority (CA). The format is
12345678-1234-1234-1234-123456789012 .
Date createdAt
Date and time at which your private CA was created.
Date lastStateChangeAt
Date and time at which your private CA was last updated.
String type
Type of your private CA.
String serial
Serial number of your private CA.
String status
Status of your private CA.
Date notBefore
Date and time before which your private CA certificate is not valid.
Date notAfter
Date and time after which your private CA certificate is not valid.
String failureReason
Reason the request to create your private CA failed.
CertificateAuthorityConfiguration certificateAuthorityConfiguration
Your private CA configuration.
RevocationConfiguration revocationConfiguration
Information about the certificate revocation list (CRL) created and maintained by your private CA.
Date restorableUntil
The period during which a deleted CA can be restored. For more information, see the
PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest operation.
String keyAlgorithm
Type of the public key algorithm and size, in bits, of the key pair that your key pair creates when it issues a certificate.
String signingAlgorithm
Name of the algorithm your private CA uses to sign certificate requests.
ASN1Subject subject
Structure that contains X.500 distinguished name information for your private CA.
String certificateAuthorityArn
Amazon Resource Name (ARN) of the CA to be audited. This is of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
.
String s3BucketName
Name of the S3 bucket that will contain the audit report.
String auditReportResponseFormat
Format in which to create the report. This can be either JSON or CSV.
CertificateAuthorityConfiguration certificateAuthorityConfiguration
Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject information.
RevocationConfiguration revocationConfiguration
Contains a Boolean value that you can use to enable a certification revocation list (CRL) for the CA, the name of the S3 bucket to which ACM PCA will write the CRL, and an optional CNAME alias that you can use to hide the name of your bucket in the CRL Distribution Points extension of your CA certificate. For more information, see the CrlConfiguration structure.
String certificateAuthorityType
The type of the certificate authority. Currently, this must be SUBORDINATE.
String idempotencyToken
Alphanumeric string that can be used to distinguish between calls to CreateCertificateAuthority. Idempotency tokens time out after five minutes. Therefore, if you call CreateCertificateAuthority multiple times with the same idempotency token within a five minute period, ACM PCA recognizes that you are requesting only one certificate. As a result, ACM PCA issues only one. If you change the idempotency token for each call, however, ACM PCA recognizes that you are requesting multiple certificates.
String certificateAuthorityArn
If successful, the Amazon Resource Name (ARN) of the certificate authority (CA). This is of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
.
Boolean 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 operation or for an existing CA when you call the UpdateCertificateAuthority operation.
Integer expirationInDays
Number of days until a certificate expires.
String 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.
String 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 ACM PCA to write the CRL to your bucket.
String certificateAuthorityArn
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must have the following form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
.
Integer permanentDeletionTimeInDays
The number of days to make a CA restorable after it has been deleted. This can be anywhere from 7 to 30 days, with 30 being the default.
String certificateAuthorityArn
The Amazon Resource Name (ARN) of the private CA. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
.
String auditReportId
The report ID returned by calling the CreateCertificateAuthorityAuditReport operation.
String auditReportStatus
Specifies whether report creation is in progress, has succeeded, or has failed.
String s3BucketName
Name of the S3 bucket that contains the report.
String s3Key
S3 key that uniquely identifies the report file in your S3 bucket.
Date createdAt
The date and time at which the report was created.
String certificateAuthorityArn
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
.
CertificateAuthority certificateAuthority
A CertificateAuthority structure that contains information about your private CA.
String certificateAuthorityArn
The Amazon Resource Name (ARN) of your private CA. This is of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
.
String certificate
Base64-encoded certificate authority (CA) certificate.
String certificateChain
Base64-encoded certificate chain that includes any intermediate certificates and chains up to root on-premises certificate that you used to sign your private CA certificate. The chain does not include your private CA certificate.
String certificateAuthorityArn
The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority operation. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
String csr
The base64 PEM-encoded certificate signing request (CSR) for your private CA certificate.
String certificateAuthorityArn
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
.
String certificateArn
The ARN of the issued certificate. The ARN contains the certificate serial number and must be in the following form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245
String certificateAuthorityArn
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
ByteBuffer certificate
The PEM-encoded certificate for your private CA. This must be signed by using your on-premises CA.
ByteBuffer certificateChain
A PEM-encoded file that contains all of your certificates, other than the certificate you're importing, chaining up to your root CA. Your on-premises root certificate is the last in the chain, and each certificate in the chain signs the one preceding.
String certificateAuthorityArn
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
ByteBuffer csr
The certificate signing request (CSR) for the certificate you want to issue. You can use the following OpenSSL command to create the CSR and a 2048 bit RSA private key.
openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr
If you have a configuration file, you can use the following OpenSSL command. The usr_cert block in
the configuration file contains your X509 version 3 extensions.
openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 -days -365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr
String signingAlgorithm
The name of the algorithm that will be used to sign the certificate to be issued.
Validity validity
The type of the validity period.
String idempotencyToken
Custom string that can be used to distinguish between calls to the IssueCertificate operation. Idempotency tokens time out after one hour. Therefore, if you call IssueCertificate multiple times with the same idempotency token within 5 minutes, ACM PCA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, PCA recognizes that you are requesting multiple certificates.
String certificateArn
The Amazon Resource Name (ARN) of the issued certificate and the certificate serial number. This is of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245
String nextToken
Use this parameter when paginating results in a subsequent request after you receive a response with truncated
results. Set it to the value of the NextToken parameter from the response you just received.
Integer maxResults
Use this parameter when paginating results to specify the maximum number of items to return in the response on
each page. If additional items exist beyond the number you specify, the NextToken element is sent in
the response. Use this NextToken value in a subsequent request to retrieve additional items.
String certificateAuthorityArn
The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority operation. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
String nextToken
Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received.
Integer maxResults
Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.
String certificateAuthorityArn
The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority operation. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
CrlConfiguration crlConfiguration
Configuration of the certificate revocation list (CRL), if any, maintained by your private CA.
String certificateAuthorityArn
Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
String certificateSerial
Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling GetCertificate with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The GetCertificate operation retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number.
openssl x509 -in file_path -text -noout
You can also copy the serial number from the console or use the DescribeCertificate operation in the AWS Certificate Manager API Reference.
String revocationReason
Specifies why you revoked the certificate.
String certificateAuthorityArn
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
List<E> tags
List of tags to be associated with the CA.
String certificateAuthorityArn
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
List<E> tags
List of tags to be removed from the CA.
String certificateAuthorityArn
Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
RevocationConfiguration revocationConfiguration
Revocation information for your private CA.
String status
Status of your private CA.
Copyright © 2018. All rights reserved.