com.amazonaws.services.acmpca.model

Class IssueCertificateRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.acmpca.model.IssueCertificateRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class IssueCertificateRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
IssueCertificateRequest()

Method Summary

Modifier and Type	Method and Description
IssueCertificateRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getCertificateAuthorityArn() The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority.
ByteBuffer	getCsr() The certificate signing request (CSR) for the certificate you want to issue.
String	getIdempotencyToken() Custom string that can be used to distinguish between calls to the IssueCertificate action.
String	getSigningAlgorithm() The name of the algorithm that will be used to sign the certificate to be issued.
String	getTemplateArn() Specifies a custom configuration template to use when issuing a certificate.
Validity	getValidity() The type of the validity period.
int	hashCode()
void	setCertificateAuthorityArn(String certificateAuthorityArn) The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority.
void	setCsr(ByteBuffer csr) The certificate signing request (CSR) for the certificate you want to issue.
void	setIdempotencyToken(String idempotencyToken) Custom string that can be used to distinguish between calls to the IssueCertificate action.
void	setSigningAlgorithm(String signingAlgorithm) The name of the algorithm that will be used to sign the certificate to be issued.
void	setTemplateArn(String templateArn) Specifies a custom configuration template to use when issuing a certificate.
void	setValidity(Validity validity) The type of the validity period.
String	toString() Returns a string representation of this object.
IssueCertificateRequest	withCertificateAuthorityArn(String certificateAuthorityArn) The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority.
IssueCertificateRequest	withCsr(ByteBuffer csr) The certificate signing request (CSR) for the certificate you want to issue.
IssueCertificateRequest	withIdempotencyToken(String idempotencyToken) Custom string that can be used to distinguish between calls to the IssueCertificate action.
IssueCertificateRequest	withSigningAlgorithm(SigningAlgorithm signingAlgorithm) The name of the algorithm that will be used to sign the certificate to be issued.
IssueCertificateRequest	withSigningAlgorithm(String signingAlgorithm) The name of the algorithm that will be used to sign the certificate to be issued.
IssueCertificateRequest	withTemplateArn(String templateArn) Specifies a custom configuration template to use when issuing a certificate.
IssueCertificateRequest	withValidity(Validity validity) The type of the validity period.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IssueCertificateRequest

public IssueCertificateRequest()

Method Detail

setCertificateAuthorityArn

public void setCertificateAuthorityArn(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

Parameters:

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

getCertificateAuthorityArn

public String getCertificateAuthorityArn()

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

Returns:

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

withCertificateAuthorityArn

public IssueCertificateRequest withCertificateAuthorityArn(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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setCsr

public void setCsr(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

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

Parameters:

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

getCsr

public ByteBuffer getCsr()

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

ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer. Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position.

Returns:

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

withCsr

public IssueCertificateRequest withCsr(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

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setSigningAlgorithm

public void setSigningAlgorithm(String signingAlgorithm)

The name of the algorithm that will be used to sign the certificate to be issued.

Parameters:

signingAlgorithm - The name of the algorithm that will be used to sign the certificate to be issued.

See Also:

SigningAlgorithm

getSigningAlgorithm

public String getSigningAlgorithm()

The name of the algorithm that will be used to sign the certificate to be issued.

Returns:

The name of the algorithm that will be used to sign the certificate to be issued.

See Also:

SigningAlgorithm

withSigningAlgorithm

public IssueCertificateRequest withSigningAlgorithm(String signingAlgorithm)

The name of the algorithm that will be used to sign the certificate to be issued.

Parameters:

signingAlgorithm - The name of the algorithm that will be used to sign the certificate to be issued.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SigningAlgorithm

withSigningAlgorithm

public IssueCertificateRequest withSigningAlgorithm(SigningAlgorithm signingAlgorithm)

The name of the algorithm that will be used to sign the certificate to be issued.

Parameters:

signingAlgorithm - The name of the algorithm that will be used to sign the certificate to be issued.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SigningAlgorithm

setTemplateArn

public void setTemplateArn(String templateArn)

Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template.

The following service-owned TemplateArn values are supported by ACM Private CA:

• arn:aws:acm-pca:::template/EndEntityCertificate/V1

• arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen0/V1

• arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen1/V1

• arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen2/V1

• arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen3/V1

• arn:aws:acm-pca:::template/RootCACertificate/V1

For more information, see Using Templates.

Parameters:

templateArn - Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template.

The following service-owned TemplateArn values are supported by ACM Private CA:

• arn:aws:acm-pca:::template/EndEntityCertificate/V1

• arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen0/V1

• arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen1/V1

• arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen2/V1

• arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen3/V1

• arn:aws:acm-pca:::template/RootCACertificate/V1

For more information, see Using Templates.

getTemplateArn

public String getTemplateArn()

Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template.

The following service-owned TemplateArn values are supported by ACM Private CA:

• arn:aws:acm-pca:::template/EndEntityCertificate/V1

• arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen0/V1

• arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen1/V1

• arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen2/V1

• arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen3/V1

• arn:aws:acm-pca:::template/RootCACertificate/V1

For more information, see Using Templates.

Returns:

Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template.

The following service-owned TemplateArn values are supported by ACM Private CA:

• arn:aws:acm-pca:::template/EndEntityCertificate/V1

• arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen0/V1

• arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen1/V1

• arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen2/V1

• arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen3/V1

• arn:aws:acm-pca:::template/RootCACertificate/V1

For more information, see Using Templates.

withTemplateArn

public IssueCertificateRequest withTemplateArn(String templateArn)

Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template.

The following service-owned TemplateArn values are supported by ACM Private CA:

• arn:aws:acm-pca:::template/EndEntityCertificate/V1

• arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen0/V1

• arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen1/V1

• arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen2/V1

• arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen3/V1

• arn:aws:acm-pca:::template/RootCACertificate/V1

For more information, see Using Templates.

Parameters:

templateArn - Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template.

The following service-owned TemplateArn values are supported by ACM Private CA:

• arn:aws:acm-pca:::template/EndEntityCertificate/V1

• arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen0/V1

• arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen1/V1

• arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen2/V1

• arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen3/V1

• arn:aws:acm-pca:::template/RootCACertificate/V1

For more information, see Using Templates.

Returns:

Returns a reference to this object so that method calls can be chained together.

setValidity

public void setValidity(Validity validity)

The type of the validity period.

Parameters:

validity - The type of the validity period.

getValidity

public Validity getValidity()

The type of the validity period.

Returns:

The type of the validity period.

withValidity

public IssueCertificateRequest withValidity(Validity validity)

The type of the validity period.

Parameters:

validity - The type of the validity period.

Returns:

Returns a reference to this object so that method calls can be chained together.

setIdempotencyToken

public void setIdempotencyToken(String idempotencyToken)

Custom string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens time out after one hour. Therefore, if you call IssueCertificate multiple times with the same idempotency token within 5 minutes, ACM Private CA 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.

Parameters:

idempotencyToken - Custom string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens time out after one hour. Therefore, if you call IssueCertificate multiple times with the same idempotency token within 5 minutes, ACM Private CA 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.

getIdempotencyToken

public String getIdempotencyToken()

Custom string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens time out after one hour. Therefore, if you call IssueCertificate multiple times with the same idempotency token within 5 minutes, ACM Private CA 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.

Returns:

Custom string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens time out after one hour. Therefore, if you call IssueCertificate multiple times with the same idempotency token within 5 minutes, ACM Private CA 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.

withIdempotencyToken

public IssueCertificateRequest withIdempotencyToken(String idempotencyToken)

Custom string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens time out after one hour. Therefore, if you call IssueCertificate multiple times with the same idempotency token within 5 minutes, ACM Private CA 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.

Parameters:

idempotencyToken - Custom string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens time out after one hour. Therefore, if you call IssueCertificate multiple times with the same idempotency token within 5 minutes, ACM Private CA 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public IssueCertificateRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()