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

Class SignalResourceRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.cloudformation.model.SignalResourceRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<SignalResourceRequest.Builder,SignalResourceRequest>

@Generated("software.amazon.awssdk:codegen")
public class SignalResourceRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<SignalResourceRequest.Builder,SignalResourceRequest>

The input for the SignalResource action.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SignalResourceRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static SignalResourceRequest.Builder	builder()
boolean	equals(Object obj)
int	hashCode()
String	logicalResourceId()	The logical ID of the resource that you want to signal.
static Class<? extends SignalResourceRequest.Builder>	serializableBuilderClass()
String	stackName()	The stack name or unique stack ID that includes the resource that you want to signal.
String	status()	The status of the signal, which is either success or failure.
SignalResourceRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	uniqueId()	A unique ID of the signal.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

stackName

public String stackName()

The stack name or unique stack ID that includes the resource that you want to signal.

Returns:

The stack name or unique stack ID that includes the resource that you want to signal.

logicalResourceId

public String logicalResourceId()

The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template.

Returns:

The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template.

uniqueId

public String uniqueId()

A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID.

Returns:

A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID.

status

public String status()

The status of the signal, which is either success or failure. A failure signal causes AWS CloudFormation to immediately fail the stack creation or update.

Returns:

The status of the signal, which is either success or failure. A failure signal causes AWS CloudFormation to immediately fail the stack creation or update.

See Also:

ResourceSignalStatus

toBuilder

public SignalResourceRequest.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<SignalResourceRequest.Builder,SignalResourceRequest>

Returns:

a builder for type T

builder

public static SignalResourceRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object