com.amazonaws.services.cloudformation.model

Class SignalResourceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudformation.model.SignalResourceRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class SignalResourceRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the SignalResource operation.

Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.

See Also:

AmazonCloudFormation.signalResource(SignalResourceRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SignalResourceRequest()

Method Summary

Methods

Modifier and Type	Method and Description
SignalResourceRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getLogicalResourceId() The logical ID of the resource that you want to signal.
String	getStackName() The stack name or unique stack ID that includes the resource that you want to signal.
String	getStatus() The status of the signal, which is either success or failure.
String	getUniqueId() A unique ID of the signal.
int	hashCode()
void	setLogicalResourceId(String logicalResourceId) The logical ID of the resource that you want to signal.
void	setStackName(String stackName) The stack name or unique stack ID that includes the resource that you want to signal.
void	setStatus(ResourceSignalStatus status) The status of the signal, which is either success or failure.
void	setStatus(String status) The status of the signal, which is either success or failure.
void	setUniqueId(String uniqueId) A unique ID of the signal.
String	toString() Returns a string representation of this object; useful for testing and debugging.
SignalResourceRequest	withLogicalResourceId(String logicalResourceId) The logical ID of the resource that you want to signal.
SignalResourceRequest	withStackName(String stackName) The stack name or unique stack ID that includes the resource that you want to signal.
SignalResourceRequest	withStatus(ResourceSignalStatus status) The status of the signal, which is either success or failure.
SignalResourceRequest	withStatus(String status) The status of the signal, which is either success or failure.
SignalResourceRequest	withUniqueId(String uniqueId) A unique ID of the signal.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SignalResourceRequest

public SignalResourceRequest()

Method Detail

getStackName

public String getStackName()

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

Constraints:
Length: 1 -
Pattern: ([a-zA-Z][-a-zA-Z0-9]*)|(arn:\b(aws|aws-us-gov|aws-cn)\b:[-a-zA-Z0-9:/._+]*)

Returns:

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

setStackName

public void setStackName(String stackName)

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

Constraints:
Length: 1 -
Pattern: ([a-zA-Z][-a-zA-Z0-9]*)|(arn:\b(aws|aws-us-gov|aws-cn)\b:[-a-zA-Z0-9:/._+]*)

Parameters:

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

withStackName

public SignalResourceRequest withStackName(String stackName)

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

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

Constraints:
Length: 1 -
Pattern: ([a-zA-Z][-a-zA-Z0-9]*)|(arn:\b(aws|aws-us-gov|aws-cn)\b:[-a-zA-Z0-9:/._+]*)

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getLogicalResourceId

public String getLogicalResourceId()

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.

setLogicalResourceId

public void setLogicalResourceId(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.

Parameters:

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.

withLogicalResourceId

public SignalResourceRequest withLogicalResourceId(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 a reference to this object so that method calls can be chained together.

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

getUniqueId

public String getUniqueId()

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.

Constraints:
Length: 1 - 64

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.

setUniqueId

public void setUniqueId(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.

Constraints:
Length: 1 - 64

Parameters:

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.

withUniqueId

public SignalResourceRequest withUniqueId(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 reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 64

Parameters:

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 reference to this updated object so that method calls can be chained together.

getStatus

public String getStatus()

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.

Constraints:
Allowed Values: SUCCESS, FAILURE

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

setStatus

public void setStatus(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.

Constraints:
Allowed Values: SUCCESS, FAILURE

Parameters:

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.

See Also:

ResourceSignalStatus

withStatus

public SignalResourceRequest withStatus(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 a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: SUCCESS, FAILURE

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

See Also:

ResourceSignalStatus

setStatus

public void setStatus(ResourceSignalStatus 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.

Constraints:
Allowed Values: SUCCESS, FAILURE

Parameters:

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.

See Also:

ResourceSignalStatus

withStatus

public SignalResourceRequest withStatus(ResourceSignalStatus 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 a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: SUCCESS, FAILURE

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

See Also:

ResourceSignalStatus

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public SignalResourceRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()