Class CertificateSettings

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

The type of SSL/TLS certificate to use for your custom domain. If a certificate type isn't specified, Amplify uses the default AMPLIFY_MANAGED certificate.

See Also:

  • Method Details

    • type

      public final CertificateType type()

      The certificate type.

      Specify AMPLIFY_MANAGED to use the default certificate that Amplify provisions for you.

      Specify CUSTOM to use your own certificate that you have already added to Certificate Manager in your Amazon Web Services account. Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see Importing certificates into Certificate Manager in the ACM User guide.

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

      Returns:
      The certificate type.

      Specify AMPLIFY_MANAGED to use the default certificate that Amplify provisions for you.

      Specify CUSTOM to use your own certificate that you have already added to Certificate Manager in your Amazon Web Services account. Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see Importing certificates into Certificate Manager in the ACM User guide.

      See Also:

    • typeAsString

      public final String typeAsString()

      The certificate type.

      Specify AMPLIFY_MANAGED to use the default certificate that Amplify provisions for you.

      Specify CUSTOM to use your own certificate that you have already added to Certificate Manager in your Amazon Web Services account. Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see Importing certificates into Certificate Manager in the ACM User guide.

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

      Returns:
      The certificate type.

      Specify AMPLIFY_MANAGED to use the default certificate that Amplify provisions for you.

      Specify CUSTOM to use your own certificate that you have already added to Certificate Manager in your Amazon Web Services account. Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see Importing certificates into Certificate Manager in the ACM User guide.

      See Also:

    • customCertificateArn

      public final String customCertificateArn()

      The Amazon resource name (ARN) for the custom certificate that you have already added to Certificate Manager in your Amazon Web Services account.

      This field is required only when the certificate type is CUSTOM.

      Returns:
      The Amazon resource name (ARN) for the custom certificate that you have already added to Certificate Manager in your Amazon Web Services account.

      This field is required only when the certificate type is CUSTOM.

    • toBuilder

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

    • builder

      public static CertificateSettings.Builder builder()

    • serializableBuilderClass

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