Class ChangeSetHook

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

Specifies the resource, the hook, and the hook version to be invoked.

See Also:

  • Method Details

    • invocationPoint

      public final HookInvocationPoint invocationPoint()

      Specifies the points in provisioning logic where a hook is invoked.

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

      Returns:
      Specifies the points in provisioning logic where a hook is invoked.
      See Also:

    • invocationPointAsString

      public final String invocationPointAsString()

      Specifies the points in provisioning logic where a hook is invoked.

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

      Returns:
      Specifies the points in provisioning logic where a hook is invoked.
      See Also:

    • failureMode

      public final HookFailureMode failureMode()

      Specify the hook failure mode for non-compliant resources in the followings ways.

      • FAIL Stops provisioning resources.

      • WARN Allows provisioning to continue with a warning message.

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

      Returns:
      Specify the hook failure mode for non-compliant resources in the followings ways.

      • FAIL Stops provisioning resources.

      • WARN Allows provisioning to continue with a warning message.

      See Also:

    • failureModeAsString

      public final String failureModeAsString()

      Specify the hook failure mode for non-compliant resources in the followings ways.

      • FAIL Stops provisioning resources.

      • WARN Allows provisioning to continue with a warning message.

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

      Returns:
      Specify the hook failure mode for non-compliant resources in the followings ways.

      • FAIL Stops provisioning resources.

      • WARN Allows provisioning to continue with a warning message.

      See Also:

    • typeName

      public final String typeName()

      The unique name for your hook. Specifies a three-part namespace for your hook, with a recommended pattern of Organization::Service::Hook.

      The following organization namespaces are reserved and can't be used in your hook type names:

      • Alexa

      • AMZN

      • Amazon

      • ASK

      • AWS

      • Custom

      • Dev

      Returns:
      The unique name for your hook. Specifies a three-part namespace for your hook, with a recommended pattern of Organization::Service::Hook.

      The following organization namespaces are reserved and can't be used in your hook type names:

      • Alexa

      • AMZN

      • Amazon

      • ASK

      • AWS

      • Custom

      • Dev

    • typeVersionId

      public final String typeVersionId()

      The version ID of the type specified.

      Returns:
      The version ID of the type specified.

    • typeConfigurationVersionId

      public final String typeConfigurationVersionId()

      The version ID of the type configuration.

      Returns:
      The version ID of the type configuration.

    • targetDetails

      public final ChangeSetHookTargetDetails targetDetails()

      Specifies details about the target that the hook will run against.

      Returns:
      Specifies details about the target that the hook will run against.

    • toBuilder

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

    • builder

      public static ChangeSetHook.Builder builder()

    • serializableBuilderClass

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