Class CertificateAuthorityConfiguration

java.lang.Object
software.amazon.awssdk.services.acmpca.model.CertificateAuthorityConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CertificateAuthorityConfiguration.Builder,CertificateAuthorityConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class CertificateAuthorityConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CertificateAuthorityConfiguration.Builder,CertificateAuthorityConfiguration>

Contains configuration information for your private certificate authority (CA). This includes information about the class of public key algorithm and the key pair that your private CA creates when it issues a certificate. It also includes the signature algorithm that it uses when issuing certificates, and its X.500 distinguished name. You must specify this information when you call the CreateCertificateAuthority action.

See Also:

  • Method Details

    • keyAlgorithm

      public final KeyAlgorithm keyAlgorithm()

      Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. When you create a subordinate CA, you must use a key algorithm supported by the parent CA.

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

      Returns:
      Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. When you create a subordinate CA, you must use a key algorithm supported by the parent CA.
      See Also:

    • keyAlgorithmAsString

      public final String keyAlgorithmAsString()

      Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. When you create a subordinate CA, you must use a key algorithm supported by the parent CA.

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

      Returns:
      Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. When you create a subordinate CA, you must use a key algorithm supported by the parent CA.
      See Also:

    • signingAlgorithm

      public final SigningAlgorithm signingAlgorithm()

      Name of the algorithm your private CA uses to sign certificate requests.

      This parameter should not be confused with the SigningAlgorithm parameter used to sign certificates when they are 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:
      Name of the algorithm your private CA uses to sign certificate requests.

      This parameter should not be confused with the SigningAlgorithm parameter used to sign certificates when they are issued.

      See Also:

    • signingAlgorithmAsString

      public final String signingAlgorithmAsString()

      Name of the algorithm your private CA uses to sign certificate requests.

      This parameter should not be confused with the SigningAlgorithm parameter used to sign certificates when they are 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:
      Name of the algorithm your private CA uses to sign certificate requests.

      This parameter should not be confused with the SigningAlgorithm parameter used to sign certificates when they are issued.

      See Also:

    • subject

      public final ASN1Subject subject()

      Structure that contains X.500 distinguished name information for your private CA.

      Returns:
      Structure that contains X.500 distinguished name information for your private CA.

    • csrExtensions

      public final CsrExtensions csrExtensions()

      Specifies information to be added to the extension section of the certificate signing request (CSR).

      Returns:
      Specifies information to be added to the extension section of the certificate signing request (CSR).

    • toBuilder

      public CertificateAuthorityConfiguration.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<CertificateAuthorityConfiguration.Builder,CertificateAuthorityConfiguration>
      Returns:
      a builder for type T

    • builder

      public static CertificateAuthorityConfiguration.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

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

    • sdkFields

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.