Class: Aws::CloudFormation::Types::StackEvent

Inherits:

Struct

Object
Struct
Aws::CloudFormation::Types::StackEvent

show all

Defined in:: gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb

Overview

The StackEvent data type.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#client_request_token ⇒ String
The token passed to the operation that generated this event.
#detailed_status ⇒ String
An optional field that contains information about the detailed status of the stack event.
#event_id ⇒ String
The unique identifier of this event.
#hook_failure_mode ⇒ String
Specify the Hook failure mode for non-compliant resources in the followings ways.
#hook_invocation_id ⇒ String
The unique identifier of the Hook invocation.
#hook_invocation_point ⇒ String
The specific point in the provisioning process where the Hook is invoked.
#hook_status ⇒ String
Provides the status of the change set Hook.
#hook_status_reason ⇒ String
Provides the reason for the Hook status.
#hook_type ⇒ String
The name of the Hook.
#logical_resource_id ⇒ String
The logical name of the resource specified in the template.
#physical_resource_id ⇒ String
The name or unique identifier associated with the physical instance of the resource.
#resource_properties ⇒ String
BLOB of the properties used to create the resource.
#resource_status ⇒ String
Current status of the resource.
#resource_status_reason ⇒ String
Success/failure message associated with the resource.
#resource_type ⇒ String
Type of resource.
#stack_id ⇒ String
The unique ID name of the instance of the stack.
#stack_name ⇒ String
The name associated with a stack.
#timestamp ⇒ Time
Time the status was updated.

Instance Attribute Details

#client_request_token ⇒ `String`

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.

Returns:

(String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 8601

class StackEvent < Struct.new(
  :stack_id,
  :event_id,
  :stack_name,
  :logical_resource_id,
  :physical_resource_id,
  :resource_type,
  :timestamp,
  :resource_status,
  :resource_status_reason,
  :resource_properties,
  :client_request_token,
  :hook_type,
  :hook_status,
  :hook_status_reason,
  :hook_invocation_point,
  :hook_invocation_id,
  :hook_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

#detailed_status ⇒ `String`

An optional field that contains information about the detailed status of the stack event.

CONFIGURATION_COMPLETE - all of the resources in the stack have reached that event. For more information, see Understand CloudFormation stack creation events in the CloudFormation User Guide.

^ ^

VALIDATION_FAILED - template validation failed because of invalid properties in the template. The ResourceStatusReason field shows what properties are defined incorrectly.

Returns:

(String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 8601

class StackEvent < Struct.new(
  :stack_id,
  :event_id,
  :stack_name,
  :logical_resource_id,
  :physical_resource_id,
  :resource_type,
  :timestamp,
  :resource_status,
  :resource_status_reason,
  :resource_properties,
  :client_request_token,
  :hook_type,
  :hook_status,
  :hook_status_reason,
  :hook_invocation_point,
  :hook_invocation_id,
  :hook_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

#event_id ⇒ `String`

The unique identifier of this event.

Returns:

(String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 8601

class StackEvent < Struct.new(
  :stack_id,
  :event_id,
  :stack_name,
  :logical_resource_id,
  :physical_resource_id,
  :resource_type,
  :timestamp,
  :resource_status,
  :resource_status_reason,
  :resource_properties,
  :client_request_token,
  :hook_type,
  :hook_status,
  :hook_status_reason,
  :hook_invocation_point,
  :hook_invocation_id,
  :hook_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

#hook_failure_mode ⇒ `String`

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.

Returns:

(String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 8601

class StackEvent < Struct.new(
  :stack_id,
  :event_id,
  :stack_name,
  :logical_resource_id,
  :physical_resource_id,
  :resource_type,
  :timestamp,
  :resource_status,
  :resource_status_reason,
  :resource_properties,
  :client_request_token,
  :hook_type,
  :hook_status,
  :hook_status_reason,
  :hook_invocation_point,
  :hook_invocation_id,
  :hook_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

#hook_invocation_id ⇒ `String`

The unique identifier of the Hook invocation.

Returns:

(String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 8601

class StackEvent < Struct.new(
  :stack_id,
  :event_id,
  :stack_name,
  :logical_resource_id,
  :physical_resource_id,
  :resource_type,
  :timestamp,
  :resource_status,
  :resource_status_reason,
  :resource_properties,
  :client_request_token,
  :hook_type,
  :hook_status,
  :hook_status_reason,
  :hook_invocation_point,
  :hook_invocation_id,
  :hook_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

#hook_invocation_point ⇒ `String`

The specific point in the provisioning process where the Hook is invoked.

Returns:

(String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 8601

class StackEvent < Struct.new(
  :stack_id,
  :event_id,
  :stack_name,
  :logical_resource_id,
  :physical_resource_id,
  :resource_type,
  :timestamp,
  :resource_status,
  :resource_status_reason,
  :resource_properties,
  :client_request_token,
  :hook_type,
  :hook_status,
  :hook_status_reason,
  :hook_invocation_point,
  :hook_invocation_id,
  :hook_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

#hook_status ⇒ `String`

Provides the status of the change set Hook.

Returns:

(String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 8601

class StackEvent < Struct.new(
  :stack_id,
  :event_id,
  :stack_name,
  :logical_resource_id,
  :physical_resource_id,
  :resource_type,
  :timestamp,
  :resource_status,
  :resource_status_reason,
  :resource_properties,
  :client_request_token,
  :hook_type,
  :hook_status,
  :hook_status_reason,
  :hook_invocation_point,
  :hook_invocation_id,
  :hook_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

#hook_status_reason ⇒ `String`

Provides the reason for the Hook status.

Returns:

(String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 8601

class StackEvent < Struct.new(
  :stack_id,
  :event_id,
  :stack_name,
  :logical_resource_id,
  :physical_resource_id,
  :resource_type,
  :timestamp,
  :resource_status,
  :resource_status_reason,
  :resource_properties,
  :client_request_token,
  :hook_type,
  :hook_status,
  :hook_status_reason,
  :hook_invocation_point,
  :hook_invocation_id,
  :hook_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

#hook_type ⇒ `String`

The name of the Hook.

Returns:

(String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 8601

class StackEvent < Struct.new(
  :stack_id,
  :event_id,
  :stack_name,
  :logical_resource_id,
  :physical_resource_id,
  :resource_type,
  :timestamp,
  :resource_status,
  :resource_status_reason,
  :resource_properties,
  :client_request_token,
  :hook_type,
  :hook_status,
  :hook_status_reason,
  :hook_invocation_point,
  :hook_invocation_id,
  :hook_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

#logical_resource_id ⇒ `String`

The logical name of the resource specified in the template.

Returns:

(String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 8601

class StackEvent < Struct.new(
  :stack_id,
  :event_id,
  :stack_name,
  :logical_resource_id,
  :physical_resource_id,
  :resource_type,
  :timestamp,
  :resource_status,
  :resource_status_reason,
  :resource_properties,
  :client_request_token,
  :hook_type,
  :hook_status,
  :hook_status_reason,
  :hook_invocation_point,
  :hook_invocation_id,
  :hook_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

#physical_resource_id ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 8601

class StackEvent < Struct.new(
  :stack_id,
  :event_id,
  :stack_name,
  :logical_resource_id,
  :physical_resource_id,
  :resource_type,
  :timestamp,
  :resource_status,
  :resource_status_reason,
  :resource_properties,
  :client_request_token,
  :hook_type,
  :hook_status,
  :hook_status_reason,
  :hook_invocation_point,
  :hook_invocation_id,
  :hook_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

#resource_properties ⇒ `String`

BLOB of the properties used to create the resource.

Returns:

(String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 8601

class StackEvent < Struct.new(
  :stack_id,
  :event_id,
  :stack_name,
  :logical_resource_id,
  :physical_resource_id,
  :resource_type,
  :timestamp,
  :resource_status,
  :resource_status_reason,
  :resource_properties,
  :client_request_token,
  :hook_type,
  :hook_status,
  :hook_status_reason,
  :hook_invocation_point,
  :hook_invocation_id,
  :hook_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

#resource_status ⇒ `String`

Current status of the resource.

Returns:

(String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 8601

class StackEvent < Struct.new(
  :stack_id,
  :event_id,
  :stack_name,
  :logical_resource_id,
  :physical_resource_id,
  :resource_type,
  :timestamp,
  :resource_status,
  :resource_status_reason,
  :resource_properties,
  :client_request_token,
  :hook_type,
  :hook_status,
  :hook_status_reason,
  :hook_invocation_point,
  :hook_invocation_id,
  :hook_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

#resource_status_reason ⇒ `String`

Success/failure message associated with the resource.

Returns:

(String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 8601

class StackEvent < Struct.new(
  :stack_id,
  :event_id,
  :stack_name,
  :logical_resource_id,
  :physical_resource_id,
  :resource_type,
  :timestamp,
  :resource_status,
  :resource_status_reason,
  :resource_properties,
  :client_request_token,
  :hook_type,
  :hook_status,
  :hook_status_reason,
  :hook_invocation_point,
  :hook_invocation_id,
  :hook_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ `String`

Type of resource. For more information, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

Returns:

(String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 8601

class StackEvent < Struct.new(
  :stack_id,
  :event_id,
  :stack_name,
  :logical_resource_id,
  :physical_resource_id,
  :resource_type,
  :timestamp,
  :resource_status,
  :resource_status_reason,
  :resource_properties,
  :client_request_token,
  :hook_type,
  :hook_status,
  :hook_status_reason,
  :hook_invocation_point,
  :hook_invocation_id,
  :hook_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

#stack_id ⇒ `String`

The unique ID name of the instance of the stack.

Returns:

(String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 8601

class StackEvent < Struct.new(
  :stack_id,
  :event_id,
  :stack_name,
  :logical_resource_id,
  :physical_resource_id,
  :resource_type,
  :timestamp,
  :resource_status,
  :resource_status_reason,
  :resource_properties,
  :client_request_token,
  :hook_type,
  :hook_status,
  :hook_status_reason,
  :hook_invocation_point,
  :hook_invocation_id,
  :hook_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

#stack_name ⇒ `String`

The name associated with a stack.

Returns:

(String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 8601

class StackEvent < Struct.new(
  :stack_id,
  :event_id,
  :stack_name,
  :logical_resource_id,
  :physical_resource_id,
  :resource_type,
  :timestamp,
  :resource_status,
  :resource_status_reason,
  :resource_properties,
  :client_request_token,
  :hook_type,
  :hook_status,
  :hook_status_reason,
  :hook_invocation_point,
  :hook_invocation_id,
  :hook_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

#timestamp ⇒ `Time`

Time the status was updated.

Returns:

(Time)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 8601

class StackEvent < Struct.new(
  :stack_id,
  :event_id,
  :stack_name,
  :logical_resource_id,
  :physical_resource_id,
  :resource_type,
  :timestamp,
  :resource_status,
  :resource_status_reason,
  :resource_properties,
  :client_request_token,
  :hook_type,
  :hook_status,
  :hook_status_reason,
  :hook_invocation_point,
  :hook_invocation_id,
  :hook_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::CloudFormation::Types::StackEvent

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_token ⇒ String

#detailed_status ⇒ String

#event_id ⇒ String

#hook_failure_mode ⇒ String

#hook_invocation_id ⇒ String

#hook_invocation_point ⇒ String

#hook_status ⇒ String

#hook_status_reason ⇒ String

#hook_type ⇒ String

#logical_resource_id ⇒ String

#physical_resource_id ⇒ String

#resource_properties ⇒ String

#resource_status ⇒ String

#resource_status_reason ⇒ String

#resource_type ⇒ String

#stack_id ⇒ String

#stack_name ⇒ String

#timestamp ⇒ Time

#client_request_token ⇒ `String`

#detailed_status ⇒ `String`

#event_id ⇒ `String`

#hook_failure_mode ⇒ `String`

#hook_invocation_id ⇒ `String`

#hook_invocation_point ⇒ `String`

#hook_status ⇒ `String`

#hook_status_reason ⇒ `String`

#hook_type ⇒ `String`

#logical_resource_id ⇒ `String`

#physical_resource_id ⇒ `String`

#resource_properties ⇒ `String`

#resource_status ⇒ `String`

#resource_status_reason ⇒ `String`

#resource_type ⇒ `String`

#stack_id ⇒ `String`

#stack_name ⇒ `String`

#timestamp ⇒ `Time`