Class SignalResourceRequest

    • Constructor Detail

      • SignalResourceRequest

        public SignalResourceRequest()
    • 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 class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object