Amazonka.CloudFormation.Types.StackEvent

Documentation

data StackEvent

The StackEvent data type.

See: newStackEvent smart constructor.

Constructors

StackEvent'

Fields

• clientRequestToken :: Maybe Text

  The token passed to the operation that generated this event.

  All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

  In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

• hookFailureMode :: Maybe HookFailureMode

  Specify the hook failure mode for non-compliant resources in the followings ways.

  • FAIL Stops provisioning resources.
  • WARN Allows provisioning to continue with a warning message.
• hookInvocationPoint :: Maybe HookInvocationPoint

  Invocation points are points in provisioning logic where hooks are initiated.

• hookStatus :: Maybe HookStatus

  Provides the status of the change set hook.

• hookStatusReason :: Maybe Text

  Provides the reason for the hook status.

• hookType :: Maybe Text

  The name of the hook.

• logicalResourceId :: Maybe Text

  The logical name of the resource specified in the template.

• physicalResourceId :: Maybe Text

  The name or unique identifier associated with the physical instance of the resource.

• resourceProperties :: Maybe Text

  BLOB of the properties used to create the resource.

• resourceStatus :: Maybe ResourceStatus

  Current status of the resource.

• resourceStatusReason :: Maybe Text

  Success/failure message associated with the resource.

• resourceType :: Maybe Text

  Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.)

• stackId :: Text

  The unique ID name of the instance of the stack.

• eventId :: Text

  The unique ID of this event.

• stackName :: Text

  The name associated with a stack.

• timestamp :: ISO8601

  Time the status was updated.

Instances

FromXML StackEvent

Defined in Amazonka.CloudFormation.Types.StackEvent

Methods

parseXML :: [Node] -> Either String StackEvent

Generic StackEvent

Defined in Amazonka.CloudFormation.Types.StackEvent

Associated Types

type Rep StackEvent :: Type -> Type

Methods

from :: StackEvent -> Rep StackEvent x

to :: Rep StackEvent x -> StackEvent

Read StackEvent

Defined in Amazonka.CloudFormation.Types.StackEvent

Methods

readsPrec :: Int -> ReadS StackEvent

readList :: ReadS [StackEvent]

readPrec :: ReadPrec StackEvent

readListPrec :: ReadPrec [StackEvent]

Show StackEvent

Defined in Amazonka.CloudFormation.Types.StackEvent

Methods

showsPrec :: Int -> StackEvent -> ShowS

show :: StackEvent -> String

showList :: [StackEvent] -> ShowS

NFData StackEvent

Defined in Amazonka.CloudFormation.Types.StackEvent

Methods

rnf :: StackEvent -> ()

Eq StackEvent

Defined in Amazonka.CloudFormation.Types.StackEvent

Methods

(==) :: StackEvent -> StackEvent -> Bool

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

Hashable StackEvent

Defined in Amazonka.CloudFormation.Types.StackEvent

Methods

hashWithSalt :: Int -> StackEvent -> Int

hash :: StackEvent -> Int

type Rep StackEvent

Defined in Amazonka.CloudFormation.Types.StackEvent

type Rep StackEvent = D1 ('MetaData "StackEvent" "Amazonka.CloudFormation.Types.StackEvent" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "StackEvent'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "hookFailureMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HookFailureMode))) :*: (S1 ('MetaSel ('Just "hookInvocationPoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HookInvocationPoint)) :*: S1 ('MetaSel ('Just "hookStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HookStatus)))) :*: ((S1 ('MetaSel ('Just "hookStatusReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "hookType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "logicalResourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "physicalResourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "resourceProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resourceStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceStatus))) :*: (S1 ('MetaSel ('Just "resourceStatusReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "stackId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "eventId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "stackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601))))))

newStackEvent

Arguments

:: Text

$sel:stackId:StackEvent'

-> Text

$sel:eventId:StackEvent'

-> Text

$sel:stackName:StackEvent'

-> UTCTime

$sel:timestamp:StackEvent'

-> StackEvent

Create a value of StackEvent 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:

$sel:clientRequestToken:StackEvent', stackEvent_clientRequestToken - The token passed to the operation that generated this event.

All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

$sel:hookFailureMode:StackEvent', stackEvent_hookFailureMode - Specify the hook failure mode for non-compliant resources in the followings ways.

• FAIL Stops provisioning resources.
• WARN Allows provisioning to continue with a warning message.

$sel:hookInvocationPoint:StackEvent', stackEvent_hookInvocationPoint - Invocation points are points in provisioning logic where hooks are initiated.

$sel:hookStatus:StackEvent', stackEvent_hookStatus - Provides the status of the change set hook.

$sel:hookStatusReason:StackEvent', stackEvent_hookStatusReason - Provides the reason for the hook status.

$sel:hookType:StackEvent', stackEvent_hookType - The name of the hook.

$sel:logicalResourceId:StackEvent', stackEvent_logicalResourceId - The logical name of the resource specified in the template.

$sel:physicalResourceId:StackEvent', stackEvent_physicalResourceId - The name or unique identifier associated with the physical instance of the resource.

$sel:resourceProperties:StackEvent', stackEvent_resourceProperties - BLOB of the properties used to create the resource.

$sel:resourceStatus:StackEvent', stackEvent_resourceStatus - Current status of the resource.

$sel:resourceStatusReason:StackEvent', stackEvent_resourceStatusReason - Success/failure message associated with the resource.

$sel:resourceType:StackEvent', stackEvent_resourceType - Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.)

$sel:stackId:StackEvent', stackEvent_stackId - The unique ID name of the instance of the stack.

$sel:eventId:StackEvent', stackEvent_eventId - The unique ID of this event.

$sel:stackName:StackEvent', stackEvent_stackName - The name associated with a stack.

$sel:timestamp:StackEvent', stackEvent_timestamp - Time the status was updated.

stackEvent_clientRequestToken :: Lens' StackEvent (Maybe Text)

The token passed to the operation that generated this event.

All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

stackEvent_hookFailureMode :: Lens' StackEvent (Maybe HookFailureMode)

Specify the hook failure mode for non-compliant resources in the followings ways.

• FAIL Stops provisioning resources.
• WARN Allows provisioning to continue with a warning message.

stackEvent_hookInvocationPoint :: Lens' StackEvent (Maybe HookInvocationPoint)

Invocation points are points in provisioning logic where hooks are initiated.

stackEvent_hookStatus :: Lens' StackEvent (Maybe HookStatus)

Provides the status of the change set hook.

stackEvent_hookStatusReason :: Lens' StackEvent (Maybe Text)

Provides the reason for the hook status.

stackEvent_hookType :: Lens' StackEvent (Maybe Text)

The name of the hook.

stackEvent_logicalResourceId :: Lens' StackEvent (Maybe Text)

The logical name of the resource specified in the template.

stackEvent_physicalResourceId :: Lens' StackEvent (Maybe Text)

The name or unique identifier associated with the physical instance of the resource.

stackEvent_resourceProperties :: Lens' StackEvent (Maybe Text)

BLOB of the properties used to create the resource.

stackEvent_resourceStatus :: Lens' StackEvent (Maybe ResourceStatus)

Current status of the resource.

stackEvent_resourceStatusReason :: Lens' StackEvent (Maybe Text)

Success/failure message associated with the resource.

stackEvent_resourceType :: Lens' StackEvent (Maybe Text)

Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.)

stackEvent_stackId :: Lens' StackEvent Text

The unique ID name of the instance of the stack.

stackEvent_eventId :: Lens' StackEvent Text

The unique ID of this event.

stackEvent_stackName :: Lens' StackEvent Text

The name associated with a stack.

stackEvent_timestamp :: Lens' StackEvent UTCTime

Time the status was updated.