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
The input for the SignalResource action.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description SignalResourceRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setStackName
public void setStackName(String stackName)
The stack name or unique stack ID that includes the resource that you want to signal.
- Parameters:
stackName
- The stack name or unique stack ID that includes the resource that you want to signal.
-
getStackName
public String getStackName()
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.
-
withStackName
public SignalResourceRequest withStackName(String stackName)
The stack name or unique stack ID that includes the resource that you want to signal.
- Parameters:
stackName
- The stack name or unique stack ID that includes the resource that you want to signal.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
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.
-
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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- 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.
-
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.
- 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.
-
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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- 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
-
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.
- 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
-
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.
- 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:
- Returns a reference to this 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.
- 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.
- 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:
- Returns a reference to this 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
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 classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-