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

Inherits:

Struct

• Object
• Struct
• Aws::CloudFormation::Types::HookResultSummary

Includes:

Structure

Defined in:

lib/aws-sdk-cloudformation/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #failure_mode ⇒ String

  The failure mode of the invocation.

• #hook_status_reason ⇒ String

  A description of the Hook results status.

• #invocation_point ⇒ String

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

• #status ⇒ String

  The state of the Hook invocation.

• #type_configuration_version_id ⇒ String

  The version of the Hook type configuration.

• #type_name ⇒ String

  The type name of the Hook being invoked.

• #type_version_id ⇒ String

  The version of the Hook being invoked.

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)

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

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)

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

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)

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

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)

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

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)

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

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)

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

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)

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

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