Class SignalResourceRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
The input for the SignalResource action.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The logical ID of the resource that you want to signal.The stack name or unique stack ID that includes the resource that you want to signal.The status of the signal, which is either success or failure.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
The status of the signal, which is either success or failure.void
setUniqueId
(String uniqueId) A unique ID of the signal.toString()
Returns a string representation of this object; useful for testing and debugging.withLogicalResourceId
(String logicalResourceId) The logical ID of the resource that you want to signal.withStackName
(String stackName) The stack name or unique stack ID that includes the resource that you want to signal.withStatus
(ResourceSignalStatus status) The status of the signal, which is either success or failure.withStatus
(String status) The status of the signal, which is either success or failure.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
-
Constructor Details
-
SignalResourceRequest
public SignalResourceRequest()
-
-
Method Details
-
setStackName
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
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
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
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
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
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
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
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
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
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:
-
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:
-
withStatus
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:
-
setStatus
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:
-
withStatus
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:
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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:
-