Amazonka.CloudFormation.SignalResource

Sends a signal to the specified resource with a success or failure status. You can use the SignalResource operation in conjunction with a creation policy or update policy. CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource operation is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.

Creating a Request

data SignalResource

The input for the SignalResource action.

See: newSignalResource smart constructor.

Constructors

SignalResource'

Fields

• stackName :: Text

  The stack name or unique stack ID that includes the resource that you want to signal.

• logicalResourceId :: Text

  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 :: Text

  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 :: ResourceSignalStatus

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

Instances

ToHeaders SignalResource

Defined in Amazonka.CloudFormation.SignalResource

Methods

toHeaders :: SignalResource -> [Header]

ToPath SignalResource

Defined in Amazonka.CloudFormation.SignalResource

Methods

toPath :: SignalResource -> ByteString

ToQuery SignalResource

Defined in Amazonka.CloudFormation.SignalResource

Methods

toQuery :: SignalResource -> QueryString

AWSRequest SignalResource

Defined in Amazonka.CloudFormation.SignalResource

Associated Types

type AWSResponse SignalResource

Methods

request :: (Service -> Service) -> SignalResource -> Request SignalResource

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SignalResource -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SignalResource)))

Generic SignalResource

Defined in Amazonka.CloudFormation.SignalResource

Associated Types

type Rep SignalResource :: Type -> Type

Methods

from :: SignalResource -> Rep SignalResource x

to :: Rep SignalResource x -> SignalResource

Read SignalResource

Defined in Amazonka.CloudFormation.SignalResource

Methods

readsPrec :: Int -> ReadS SignalResource

readList :: ReadS [SignalResource]

readPrec :: ReadPrec SignalResource

readListPrec :: ReadPrec [SignalResource]

Show SignalResource

Defined in Amazonka.CloudFormation.SignalResource

Methods

showsPrec :: Int -> SignalResource -> ShowS

show :: SignalResource -> String

showList :: [SignalResource] -> ShowS

NFData SignalResource

Defined in Amazonka.CloudFormation.SignalResource

Methods

rnf :: SignalResource -> ()

Eq SignalResource

Defined in Amazonka.CloudFormation.SignalResource

Methods

(==) :: SignalResource -> SignalResource -> Bool

(/=) :: SignalResource -> SignalResource -> Bool

Hashable SignalResource

Defined in Amazonka.CloudFormation.SignalResource

Methods

hashWithSalt :: Int -> SignalResource -> Int

hash :: SignalResource -> Int

type AWSResponse SignalResource

Defined in Amazonka.CloudFormation.SignalResource

type AWSResponse SignalResource = SignalResourceResponse

type Rep SignalResource

Defined in Amazonka.CloudFormation.SignalResource

type Rep SignalResource = D1 ('MetaData "SignalResource" "Amazonka.CloudFormation.SignalResource" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "SignalResource'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "stackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "logicalResourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "uniqueId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ResourceSignalStatus))))

newSignalResource

Arguments

:: Text

SignalResource

-> Text

SignalResource

-> Text

$sel:uniqueId:SignalResource'

-> ResourceSignalStatus

SignalResource

-> SignalResource

Create a value of SignalResource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

SignalResource, signalResource_stackName - The stack name or unique stack ID that includes the resource that you want to signal.

SignalResource, signalResource_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.

$sel:uniqueId:SignalResource', signalResource_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.

SignalResource, signalResource_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.

Request Lenses

signalResource_stackName :: Lens' SignalResource Text

The stack name or unique stack ID that includes the resource that you want to signal.

signalResource_logicalResourceId :: Lens' SignalResource Text

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.

signalResource_uniqueId :: Lens' SignalResource Text

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.

signalResource_status :: Lens' SignalResource ResourceSignalStatus

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

Destructuring the Response

data SignalResourceResponse

See: newSignalResourceResponse smart constructor.

Constructors

SignalResourceResponse'

Instances

Generic SignalResourceResponse

Defined in Amazonka.CloudFormation.SignalResource

Associated Types

type Rep SignalResourceResponse :: Type -> Type

Methods

from :: SignalResourceResponse -> Rep SignalResourceResponse x

to :: Rep SignalResourceResponse x -> SignalResourceResponse

Read SignalResourceResponse

Defined in Amazonka.CloudFormation.SignalResource

Methods

readsPrec :: Int -> ReadS SignalResourceResponse

readList :: ReadS [SignalResourceResponse]

readPrec :: ReadPrec SignalResourceResponse

readListPrec :: ReadPrec [SignalResourceResponse]

Show SignalResourceResponse

Defined in Amazonka.CloudFormation.SignalResource

Methods

showsPrec :: Int -> SignalResourceResponse -> ShowS

show :: SignalResourceResponse -> String

showList :: [SignalResourceResponse] -> ShowS

NFData SignalResourceResponse

Defined in Amazonka.CloudFormation.SignalResource

Methods

rnf :: SignalResourceResponse -> ()

Eq SignalResourceResponse

Defined in Amazonka.CloudFormation.SignalResource

Methods

(==) :: SignalResourceResponse -> SignalResourceResponse -> Bool

(/=) :: SignalResourceResponse -> SignalResourceResponse -> Bool

type Rep SignalResourceResponse

Defined in Amazonka.CloudFormation.SignalResource

type Rep SignalResourceResponse = D1 ('MetaData "SignalResourceResponse" "Amazonka.CloudFormation.SignalResource" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "SignalResourceResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newSignalResourceResponse :: SignalResourceResponse

Create a value of SignalResourceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.