Package 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("software.amazon.awssdk:codegen")
public final class RevokeCertificateRequest
extends AcmPcaRequest
implements ToCopyableBuilder<RevokeCertificateRequest.Builder,RevokeCertificateRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RevokeCertificateRequest.Builder

Method Summary

Modifier and Type	Method	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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
RevocationReason	revocationReason()	Specifies why you revoked the certificate.
String	revocationReasonAsString()	Specifies why you revoked the certificate.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RevokeCertificateRequest.Builder>	serializableBuilderClass()
RevokeCertificateRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

certificateAuthorityArn

public final 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 final 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 action 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 action in the 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 action 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 action in the Certificate Manager API Reference.

revocationReason

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

Specified by:

toBuilder in interface ToCopyableBuilder<RevokeCertificateRequest.Builder,RevokeCertificateRequest>

Specified by:

toBuilder in class AcmPcaRequest

builder

public static RevokeCertificateRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

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

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo