software.amazon.awssdk.services.acmpca.model

Class UpdateCertificateAuthorityRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateCertificateAuthorityRequest.Builder,UpdateCertificateAuthorityRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateCertificateAuthorityRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateCertificateAuthorityRequest.Builder	builder()
String	certificateAuthorityArn() Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
RevocationConfiguration	revocationConfiguration() Contains information to enable Online Certificate Status Protocol (OCSP) support, to enable a certificate revocation list (CRL), to enable both, or to enable neither.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateCertificateAuthorityRequest.Builder>	serializableBuilderClass()
CertificateAuthorityStatus	status() Status of your private CA.
String	statusAsString() Status of your private CA.
UpdateCertificateAuthorityRequest.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

revocationConfiguration

public final RevocationConfiguration revocationConfiguration()

Contains information to enable Online Certificate Status Protocol (OCSP) support, to enable a certificate revocation list (CRL), to enable both, or to enable neither. If this parameter is not supplied, existing capibilites remain unchanged. For more information, see the OcspConfiguration and CrlConfiguration types.

The following requirements apply to revocation configurations.

• A configuration disabling CRLs or OCSP must contain only the Enabled=False parameter, and will fail if other parameters such as CustomCname or ExpirationInDays are included.

• In a CRL configuration, the S3BucketName parameter must conform to Amazon S3 bucket naming rules.

• A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.

• In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as "http://" or "https://".

Returns:

Contains information to enable Online Certificate Status Protocol (OCSP) support, to enable a certificate revocation list (CRL), to enable both, or to enable neither. If this parameter is not supplied, existing capibilites remain unchanged. For more information, see the OcspConfiguration and CrlConfiguration types.

The following requirements apply to revocation configurations.

• A configuration disabling CRLs or OCSP must contain only the Enabled=False parameter, and will fail if other parameters such as CustomCname or ExpirationInDays are included.

• In a CRL configuration, the S3BucketName parameter must conform to Amazon S3 bucket naming rules.

• A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.

• In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as "http://" or "https://".

status

public final CertificateAuthorityStatus status()

Status of your private CA.

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

Returns:

Status of your private CA.

See Also:

CertificateAuthorityStatus

statusAsString

public final String statusAsString()

Status of your private CA.

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

Returns:

Status of your private CA.

See Also:

CertificateAuthorityStatus

toBuilder

public UpdateCertificateAuthorityRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateCertificateAuthorityRequest.Builder,UpdateCertificateAuthorityRequest>

Specified by:

toBuilder in class AcmPcaRequest

builder

public static UpdateCertificateAuthorityRequest.Builder builder()

serializableBuilderClass

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