@Generated(value="software.amazon.awssdk:codegen") public final class SignalResourceRequest extends CloudFormationRequest implements ToCopyableBuilder<SignalResourceRequest.Builder,SignalResourceRequest>
The input for the SignalResource action.
Modifier and Type | Class and Description |
---|---|
static interface |
SignalResourceRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static SignalResourceRequest.Builder |
builder() |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
logicalResourceId()
The logical ID of the resource that you want to signal.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends SignalResourceRequest.Builder> |
serializableBuilderClass() |
String |
stackName()
The stack name or unique stack ID that includes the resource that you want to signal.
|
ResourceSignalStatus |
status()
The status of the signal, which is either success or failure.
|
String |
statusAsString()
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.
|
overrideConfiguration
copy
public String stackName()
The stack name or unique stack ID that includes the resource that you want to signal.
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.
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.
public 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.
If the service returns an enum value that is not available in the current SDK version, status
will
return ResourceSignalStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from statusAsString()
.
ResourceSignalStatus
public String statusAsString()
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.
If the service returns an enum value that is not available in the current SDK version, status
will
return ResourceSignalStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from statusAsString()
.
ResourceSignalStatus
public SignalResourceRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<SignalResourceRequest.Builder,SignalResourceRequest>
toBuilder
in class CloudFormationRequest
public static SignalResourceRequest.Builder builder()
public static Class<? extends SignalResourceRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.