Class: Aws::CloudFormation::Types::HookResultSummary

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

Overview

Describes a Hook invocation, its status, and the reason for its status.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#failure_mode ⇒ String

The failure mode of the invocation. The following are potential modes:

  • FAIL: If the hook invocation returns a failure, then the requested target operation should fail.

  • WARN: If the hook invocation returns a failure, then the requested target operation should warn.

Returns:

  • (String) 


4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4609

class HookResultSummary < Struct.new(
  :invocation_point,
  :failure_mode,
  :type_name,
  :type_version_id,
  :type_configuration_version_id,
  :status,
  :hook_status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#hook_status_reason ⇒ String

A description of the Hook results status. For example, if the Hook result is in a FAILED state, this may contain additional information for the FAILED state.

Returns:

  • (String) 


4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4609

class HookResultSummary < Struct.new(
  :invocation_point,
  :failure_mode,
  :type_name,
  :type_version_id,
  :type_configuration_version_id,
  :status,
  :hook_status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#invocation_point ⇒ String

The exact point in the provisioning logic where the Hook runs.

Returns:

  • (String) 


4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4609

class HookResultSummary < Struct.new(
  :invocation_point,
  :failure_mode,
  :type_name,
  :type_version_id,
  :type_configuration_version_id,
  :status,
  :hook_status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The state of the Hook invocation.

Returns:

  • (String) 


4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4609

class HookResultSummary < Struct.new(
  :invocation_point,
  :failure_mode,
  :type_name,
  :type_version_id,
  :type_configuration_version_id,
  :status,
  :hook_status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#type_configuration_version_id ⇒ String

The version of the Hook type configuration.

Returns:

  • (String) 


4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4609

class HookResultSummary < Struct.new(
  :invocation_point,
  :failure_mode,
  :type_name,
  :type_version_id,
  :type_configuration_version_id,
  :status,
  :hook_status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#type_name ⇒ String

The type name of the Hook being invoked.

Returns:

  • (String) 


4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4609

class HookResultSummary < Struct.new(
  :invocation_point,
  :failure_mode,
  :type_name,
  :type_version_id,
  :type_configuration_version_id,
  :status,
  :hook_status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#type_version_id ⇒ String

The version of the Hook being invoked.

Returns:

  • (String) 


4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4609

class HookResultSummary < Struct.new(
  :invocation_point,
  :failure_mode,
  :type_name,
  :type_version_id,
  :type_configuration_version_id,
  :status,
  :hook_status_reason)
  SENSITIVE = []
  include Aws::Structure
end