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

Class SignalResourceRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest
software.amazon.awssdk.services.cloudformation.model.SignalResourceRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<SignalResourceRequest.Builder,SignalResourceRequest>
@Generated("software.amazon.awssdk:codegen") public final class SignalResourceRequest extends CloudFormationRequest implements ToCopyableBuilder<SignalResourceRequest.Builder,SignalResourceRequest>

The input for the SignalResource action.

  • Method Details

    • stackName

      public final 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 final 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 final 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 final ResourceSignalStatus status()

      The status of the signal, which is either success or failure. A failure signal causes 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().

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

    • statusAsString

      public final String statusAsString()

      The status of the signal, which is either success or failure. A failure signal causes 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().

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

    • toBuilder

      public SignalResourceRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<SignalResourceRequest.Builder,SignalResourceRequest>
      Specified by:
      toBuilder in class CloudFormationRequest

    • builder

      public static SignalResourceRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo