Network.AWS.CloudFormation.SignalResource

Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS 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 API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.

Creating a Request

signalResource

Arguments

:: Text

sigStackName

-> Text

sigLogicalResourceId

-> Text

sigUniqueId

-> ResourceSignalStatus

sigStatus

-> SignalResource

Creates a value of SignalResource with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sigStackName - The stack name or unique stack ID that includes the resource that you want to signal.
• sigLogicalResourceId - 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.
• sigUniqueId - 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.
• sigStatus - 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.

data SignalResource

The input for the SignalResource action.

See: signalResource smart constructor.

Instances

Eq SignalResource

Defined in Network.AWS.CloudFormation.SignalResource

Methods

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

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

Data SignalResource

Defined in Network.AWS.CloudFormation.SignalResource

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SignalResource -> c SignalResource

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SignalResource

toConstr :: SignalResource -> Constr

dataTypeOf :: SignalResource -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SignalResource)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SignalResource)

gmapT :: (forall b. Data b => b -> b) -> SignalResource -> SignalResource

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SignalResource -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SignalResource -> r

gmapQ :: (forall d. Data d => d -> u) -> SignalResource -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SignalResource -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SignalResource -> m SignalResource

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SignalResource -> m SignalResource

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SignalResource -> m SignalResource

Read SignalResource

Defined in Network.AWS.CloudFormation.SignalResource

Methods

readsPrec :: Int -> ReadS SignalResource

readList :: ReadS [SignalResource]

readPrec :: ReadPrec SignalResource

readListPrec :: ReadPrec [SignalResource]

Show SignalResource

Defined in Network.AWS.CloudFormation.SignalResource

Methods

showsPrec :: Int -> SignalResource -> ShowS

show :: SignalResource -> String

showList :: [SignalResource] -> ShowS

Generic SignalResource

Defined in Network.AWS.CloudFormation.SignalResource

Associated Types

type Rep SignalResource :: Type -> Type

Methods

from :: SignalResource -> Rep SignalResource x

to :: Rep SignalResource x -> SignalResource

Hashable SignalResource

Defined in Network.AWS.CloudFormation.SignalResource

Methods

hashWithSalt :: Int -> SignalResource -> Int

hash :: SignalResource -> Int

AWSRequest SignalResource

Defined in Network.AWS.CloudFormation.SignalResource

Associated Types

type Rs SignalResource :: Type

Methods

request :: SignalResource -> Request SignalResource

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy SignalResource -> ClientResponse -> m (Response SignalResource)

ToHeaders SignalResource

Defined in Network.AWS.CloudFormation.SignalResource

Methods

toHeaders :: SignalResource -> [Header]

ToPath SignalResource

Defined in Network.AWS.CloudFormation.SignalResource

Methods

toPath :: SignalResource -> ByteString

ToQuery SignalResource

Defined in Network.AWS.CloudFormation.SignalResource

Methods

toQuery :: SignalResource -> QueryString

NFData SignalResource

Defined in Network.AWS.CloudFormation.SignalResource

Methods

rnf :: SignalResource -> ()

type Rep SignalResource

Defined in Network.AWS.CloudFormation.SignalResource

type Rep SignalResource = D1 (MetaData "SignalResource" "Network.AWS.CloudFormation.SignalResource" "amazonka-cloudformation-1.6.1-9C1vgCDBA4sIHFUFfPs2gm" False) (C1 (MetaCons "SignalResource'" PrefixI True) ((S1 (MetaSel (Just "_sigStackName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_sigLogicalResourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :*: (S1 (MetaSel (Just "_sigUniqueId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_sigStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ResourceSignalStatus))))

type Rs SignalResource

Defined in Network.AWS.CloudFormation.SignalResource

type Rs SignalResource = SignalResourceResponse

Request Lenses

sigStackName :: Lens' SignalResource Text

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

sigLogicalResourceId :: 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.

sigUniqueId :: 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.

sigStatus :: Lens' SignalResource ResourceSignalStatus

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.

Destructuring the Response

signalResourceResponse :: SignalResourceResponse

Creates a value of SignalResourceResponse with the minimum fields required to make a request.

data SignalResourceResponse

See: signalResourceResponse smart constructor.

Instances

Eq SignalResourceResponse

Defined in Network.AWS.CloudFormation.SignalResource

Methods

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

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

Data SignalResourceResponse

Defined in Network.AWS.CloudFormation.SignalResource

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SignalResourceResponse -> c SignalResourceResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SignalResourceResponse

toConstr :: SignalResourceResponse -> Constr

dataTypeOf :: SignalResourceResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SignalResourceResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SignalResourceResponse)

gmapT :: (forall b. Data b => b -> b) -> SignalResourceResponse -> SignalResourceResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SignalResourceResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SignalResourceResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> SignalResourceResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SignalResourceResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SignalResourceResponse -> m SignalResourceResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SignalResourceResponse -> m SignalResourceResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SignalResourceResponse -> m SignalResourceResponse

Read SignalResourceResponse

Defined in Network.AWS.CloudFormation.SignalResource

Methods

readsPrec :: Int -> ReadS SignalResourceResponse

readList :: ReadS [SignalResourceResponse]

readPrec :: ReadPrec SignalResourceResponse

readListPrec :: ReadPrec [SignalResourceResponse]

Show SignalResourceResponse

Defined in Network.AWS.CloudFormation.SignalResource

Methods

showsPrec :: Int -> SignalResourceResponse -> ShowS

show :: SignalResourceResponse -> String

showList :: [SignalResourceResponse] -> ShowS

Generic SignalResourceResponse

Defined in Network.AWS.CloudFormation.SignalResource

Associated Types

type Rep SignalResourceResponse :: Type -> Type

Methods

from :: SignalResourceResponse -> Rep SignalResourceResponse x

to :: Rep SignalResourceResponse x -> SignalResourceResponse

NFData SignalResourceResponse

Defined in Network.AWS.CloudFormation.SignalResource

Methods

rnf :: SignalResourceResponse -> ()

type Rep SignalResourceResponse

Defined in Network.AWS.CloudFormation.SignalResource

type Rep SignalResourceResponse = D1 (MetaData "SignalResourceResponse" "Network.AWS.CloudFormation.SignalResource" "amazonka-cloudformation-1.6.1-9C1vgCDBA4sIHFUFfPs2gm" False) (C1 (MetaCons "SignalResourceResponse'" PrefixI False) (U1 :: Type -> Type))