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("software.amazon.awssdk:codegen") public final class UpdateCertificateAuthorityRequest extends AcmPcaRequest implements ToCopyableBuilder<UpdateCertificateAuthorityRequest.Builder,UpdateCertificateAuthorityRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceUpdateCertificateAuthorityRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static UpdateCertificateAuthorityRequest.Builderbuilder()StringcertificateAuthorityArn()Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()RevocationConfigurationrevocationConfiguration()Contains information to enable support for Online Certificate Status Protocol (OCSP), certificate revocation list (CRL), both protocols, or neither.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends UpdateCertificateAuthorityRequest.Builder>serializableBuilderClass()CertificateAuthorityStatusstatus()Status of your private CA.StringstatusAsString()Status of your private CA.UpdateCertificateAuthorityRequest.BuildertoBuilder()StringtoString()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 support for Online Certificate Status Protocol (OCSP), certificate revocation list (CRL), both protocols, or neither. If you don't supply this parameter, 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=Falseparameter, and will fail if other parameters such asCustomCnameorExpirationInDaysare included. -
In a CRL configuration, the
S3BucketNameparameter 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://".
If you update the
S3BucketNameof CrlConfiguration, you can break revocation for existing certificates. In other words, if you call UpdateCertificateAuthority to update the CRL configuration's S3 bucket name, Amazon Web Services Private CA only writes CRLs to the new S3 bucket. Certificates issued prior to this point will have the old S3 bucket name in your CRL Distribution Point (CDP) extension, essentially breaking revocation. If you must update the S3 bucket, you'll need to reissue old certificates to keep the revocation working. Alternatively, you can use a CustomCname in your CRL configuration if you might need to change the S3 bucket name in the future.- Returns:
- Contains information to enable support for Online Certificate Status Protocol (OCSP), certificate
revocation list (CRL), both protocols, or neither. If you don't supply this parameter, 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=Falseparameter, and will fail if other parameters such asCustomCnameorExpirationInDaysare included. -
In a CRL configuration, the
S3BucketNameparameter 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://".
If you update the
S3BucketNameof CrlConfiguration, you can break revocation for existing certificates. In other words, if you call UpdateCertificateAuthority to update the CRL configuration's S3 bucket name, Amazon Web Services Private CA only writes CRLs to the new S3 bucket. Certificates issued prior to this point will have the old S3 bucket name in your CRL Distribution Point (CDP) extension, essentially breaking revocation. If you must update the S3 bucket, you'll need to reissue old certificates to keep the revocation working. Alternatively, you can use a CustomCname in your CRL configuration if you might need to change the S3 bucket name in the future. -
-
-
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,
statuswill returnCertificateAuthorityStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- 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,
statuswill returnCertificateAuthorityStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- Status of your private CA.
- See Also:
CertificateAuthorityStatus
-
toBuilder
public UpdateCertificateAuthorityRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<UpdateCertificateAuthorityRequest.Builder,UpdateCertificateAuthorityRequest>- Specified by:
toBuilderin classAcmPcaRequest
-
builder
public static UpdateCertificateAuthorityRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends UpdateCertificateAuthorityRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-