software.amazon.awssdk.services.acmpca.model

Class IssueCertificateRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.acmpca.model.AcmPcaRequest

software.amazon.awssdk.services.acmpca.model.IssueCertificateRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<IssueCertificateRequest.Builder,IssueCertificateRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class IssueCertificateRequest
extends AcmPcaRequest
implements ToCopyableBuilder<IssueCertificateRequest.Builder,IssueCertificateRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IssueCertificateRequest.Builder

Method Summary

Modifier and Type	Method and Description
static IssueCertificateRequest.Builder	builder()
String	certificateAuthorityArn() The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority.
SdkBytes	csr() The certificate signing request (CSR) for the certificate you want to issue.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	idempotencyToken() Custom string that can be used to distinguish between calls to the IssueCertificate operation.
List<SdkField<?>>	sdkFields()
static Class<? extends IssueCertificateRequest.Builder>	serializableBuilderClass()
SigningAlgorithm	signingAlgorithm() The name of the algorithm that will be used to sign the certificate to be issued.
String	signingAlgorithmAsString() The name of the algorithm that will be used to sign the certificate to be issued.
IssueCertificateRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Validity	validity() The type of the validity period.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

certificateAuthorityArn

public 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

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

csr

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

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

signingAlgorithm

public SigningAlgorithm signingAlgorithm()

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

If the service returns an enum value that is not available in the current SDK version, signingAlgorithm will return SigningAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from signingAlgorithmAsString().

Returns:

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

See Also:

SigningAlgorithm

signingAlgorithmAsString

public String signingAlgorithmAsString()

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

If the service returns an enum value that is not available in the current SDK version, signingAlgorithm will return SigningAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from signingAlgorithmAsString().

Returns:

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

See Also:

SigningAlgorithm

validity

public Validity validity()

The type of the validity period.

Returns:

The type of the validity period.

idempotencyToken

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

Returns:

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.

toBuilder

public IssueCertificateRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<IssueCertificateRequest.Builder,IssueCertificateRequest>

Specified by:

toBuilder in class AcmPcaRequest

Returns:

a builder for type T

builder

public static IssueCertificateRequest.Builder builder()

serializableBuilderClass

public static Class<? extends IssueCertificateRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.