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

Interface ChangeSetHook.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ChangeSetHook.Builder,ChangeSetHook>, SdkBuilder<ChangeSetHook.Builder,ChangeSetHook>, SdkPojo

Enclosing class:

ChangeSetHook

@Mutable
@NotThreadSafe
public static interface ChangeSetHook.Builder
extends SdkPojo, CopyableBuilder<ChangeSetHook.Builder,ChangeSetHook>

Method Summary

Modifier and Type	Method	Description
ChangeSetHook.Builder	failureMode(String failureMode)	Specify the Hook failure mode for non-compliant resources in the followings ways.
ChangeSetHook.Builder	failureMode(HookFailureMode failureMode)	Specify the Hook failure mode for non-compliant resources in the followings ways.
ChangeSetHook.Builder	invocationPoint(String invocationPoint)	The specific point in the provisioning process where the Hook is invoked.
ChangeSetHook.Builder	invocationPoint(HookInvocationPoint invocationPoint)	The specific point in the provisioning process where the Hook is invoked.
default ChangeSetHook.Builder	targetDetails(Consumer<ChangeSetHookTargetDetails.Builder> targetDetails)	Specifies details about the target that the Hook will run against.
ChangeSetHook.Builder	targetDetails(ChangeSetHookTargetDetails targetDetails)	Specifies details about the target that the Hook will run against.
ChangeSetHook.Builder	typeConfigurationVersionId(String typeConfigurationVersionId)	The version ID of the type configuration.
ChangeSetHook.Builder	typeName(String typeName)	The unique name for your Hook.
ChangeSetHook.Builder	typeVersionId(String typeVersionId)	The version ID of the type specified.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

invocationPoint

ChangeSetHook.Builder invocationPoint(String invocationPoint)

The specific point in the provisioning process where the Hook is invoked.

Parameters:

invocationPoint - The specific point in the provisioning process where the Hook is invoked.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HookInvocationPoint, HookInvocationPoint

invocationPoint

ChangeSetHook.Builder invocationPoint(HookInvocationPoint invocationPoint)

The specific point in the provisioning process where the Hook is invoked.

Parameters:

invocationPoint - The specific point in the provisioning process where the Hook is invoked.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HookInvocationPoint, HookInvocationPoint

failureMode

ChangeSetHook.Builder failureMode(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HookFailureMode, HookFailureMode

failureMode

ChangeSetHook.Builder failureMode(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HookFailureMode, HookFailureMode

typeName

ChangeSetHook.Builder typeName(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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

typeVersionId

ChangeSetHook.Builder typeVersionId(String typeVersionId)

The version ID of the type specified.

Parameters:

typeVersionId - The version ID of the type specified.

Returns:

Returns a reference to this object so that method calls can be chained together.

typeConfigurationVersionId

ChangeSetHook.Builder typeConfigurationVersionId(String typeConfigurationVersionId)

The version ID of the type configuration.

Parameters:

typeConfigurationVersionId - The version ID of the type configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

targetDetails

ChangeSetHook.Builder targetDetails(ChangeSetHookTargetDetails targetDetails)

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

Parameters:

targetDetails - Specifies details about the target that the Hook will run against.

Returns:

Returns a reference to this object so that method calls can be chained together.

targetDetails

default ChangeSetHook.Builder targetDetails(Consumer<ChangeSetHookTargetDetails.Builder> targetDetails)

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

This is a convenience method that creates an instance of the ChangeSetHookTargetDetails.Builder avoiding the need to create one manually via ChangeSetHookTargetDetails.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to targetDetails(ChangeSetHookTargetDetails).

Parameters:

targetDetails - a consumer that will call methods on ChangeSetHookTargetDetails.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

targetDetails(ChangeSetHookTargetDetails)