software.amazon.awssdk.services.acmpca.model

Class RevokeCertificateRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<RevokeCertificateRequest.Builder,RevokeCertificateRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RevokeCertificateRequest.Builder

Method Summary

Modifier and Type	Method and Description
static RevokeCertificateRequest.Builder	builder()
String	certificateAuthorityArn() Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked.
String	certificateSerial() Serial number of the certificate to be revoked.
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()
RevocationReason	revocationReason() Specifies why you revoked the certificate.
String	revocationReasonAsString() Specifies why you revoked the certificate.
List<SdkField<?>>	sdkFields()
static Class<? extends RevokeCertificateRequest.Builder>	serializableBuilderClass()
RevokeCertificateRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

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

Returns:

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

certificateSerial

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

Returns:

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.

revocationReason

public RevocationReason revocationReason()

Specifies why you revoked the certificate.

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

Returns:

Specifies why you revoked the certificate.

See Also:

RevocationReason

revocationReasonAsString

public String revocationReasonAsString()

Specifies why you revoked the certificate.

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

Returns:

Specifies why you revoked the certificate.

See Also:

RevocationReason

toBuilder

public RevokeCertificateRequest.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<RevokeCertificateRequest.Builder,RevokeCertificateRequest>

Specified by:

toBuilder in class AcmPcaRequest

Returns:

a builder for type T

builder

public static RevokeCertificateRequest.Builder builder()

serializableBuilderClass

public static Class<? extends RevokeCertificateRequest.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.