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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudformation/types.rb

Overview

The StackEvent data type.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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) 


7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 7922

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_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

#detailed_status ⇒ String

An optional field containing 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 [CloudFormation stack deployment] 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.

^

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html

Returns:

  • (String) 


7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 7922

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_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

#event_id ⇒ String

The unique ID of this event.

Returns:

  • (String) 


7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 7922

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_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) 


7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 7922

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_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

#hook_invocation_point ⇒ String

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

Returns:

  • (String) 


7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 7922

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_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

#hook_status ⇒ String

Provides the status of the change set hook.

Returns:

  • (String) 


7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 7922

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_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

#hook_status_reason ⇒ String

Provides the reason for the hook status.

Returns:

  • (String) 


7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 7922

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_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

#hook_type ⇒ String

The name of the hook.

Returns:

  • (String) 


7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 7922

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_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) 


7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 7922

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_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) 


7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 7922

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_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

#resource_properties ⇒ String

BLOB of the properties used to create the resource.

Returns:

  • (String) 


7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 7922

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_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

#resource_status ⇒ String

Current status of the resource.

Returns:

  • (String) 


7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 7922

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_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

#resource_status_reason ⇒ String

Success/failure message associated with the resource.

Returns:

  • (String) 


7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 7922

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_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ String

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

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html

Returns:

  • (String) 


7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 7922

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_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

#stack_id ⇒ String

The unique ID name of the instance of the stack.

Returns:

  • (String) 


7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 7922

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_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

#stack_name ⇒ String

The name associated with a stack.

Returns:

  • (String) 


7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 7922

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_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end

#timestamp ⇒ Time

Time the status was updated.

Returns:

  • (Time) 


7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 7922

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_failure_mode,
  :detailed_status)
  SENSITIVE = []
  include Aws::Structure
end