Package software.amazon.awssdk.services.cloudformation.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ChangeSetHook.Builder

Method Summary

Modifier and Type	Method	Description
static ChangeSetHook.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
HookFailureMode	failureMode()	Specify the hook failure mode for non-compliant resources in the followings ways.
String	failureModeAsString()	Specify the hook failure mode for non-compliant resources in the followings ways.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
HookInvocationPoint	invocationPoint()	Specifies the points in provisioning logic where a hook is invoked.
String	invocationPointAsString()	Specifies the points in provisioning logic where a hook is invoked.
List<SdkField<?>>	sdkFields()
static Class<? extends ChangeSetHook.Builder>	serializableBuilderClass()
ChangeSetHookTargetDetails	targetDetails()	Specifies details about the target that the hook will run against.
ChangeSetHook.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	typeConfigurationVersionId()	The version ID of the type configuration.
String	typeName()	The unique name for your hook.
String	typeVersionId()	The version ID of the type specified.

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

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:

HookInvocationPoint

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:

HookInvocationPoint

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:

HookFailureMode

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:

HookFailureMode

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

Specified by:

toBuilder in interface ToCopyableBuilder<ChangeSetHook.Builder,ChangeSetHook>

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)

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo