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_execution_target ⇒ String

  The ARN of the target stack or request token of the Cloud Control API operation.

• #hook_result_id ⇒ String

  The unique identifier for this Hook invocation result.

• #hook_status_reason ⇒ String

  A description of the Hook results status.

• #invocation_point ⇒ String

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

• #invoked_at ⇒ Time

  The timestamp when the Hook was invoked.

• #status ⇒ String

  The status of the Hook invocation.

• #target_id ⇒ String

  The unique identifier of the Hook invocation target.

• #target_type ⇒ String

  The target type that the Hook was invoked against.

• #type_arn ⇒ String

  The ARN of the Hook that was invoked.

• #type_configuration_version_id ⇒ String

  The version of the Hook configuration.

• #type_name ⇒ String

  The name of the Hook that was invoked.

• #type_version_id ⇒ String

  The version of the Hook that was invoked.

Instance Attribute Details

#failure_mode ⇒ String

The failure mode of the invocation.

Returns:

• (String)

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

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

#hook_execution_target ⇒ String

The ARN of the target stack or request token of the Cloud Control API operation.

Only shown in responses when the request does not specify ‘TargetType` and `TargetId` filters.

Returns:

• (String)

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

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

#hook_result_id ⇒ String

The unique identifier for this Hook invocation result.

Returns:

• (String)

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

class HookResultSummary < Struct.new(
  :hook_result_id,
  :invocation_point,
  :failure_mode,
  :type_name,
  :type_version_id,
  :type_configuration_version_id,
  :status,
  :hook_status_reason,
  :invoked_at,
  :target_type,
  :target_id,
  :type_arn,
  :hook_execution_target)
  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 4693

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

#invocation_point ⇒ String

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

Returns:

• (String)

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

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

#invoked_at ⇒ Time

The timestamp when the Hook was invoked.

Only shown in responses when the request does not specify ‘TargetType` and `TargetId` filters.

Returns:

• (Time)

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

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

#status ⇒ String

The status of the Hook invocation. The following statuses are possible:

• ‘HOOK_IN_PROGRESS`: The Hook is currently running.

• ‘HOOK_COMPLETE_SUCCEEDED`: The Hook completed successfully.

• ‘HOOK_COMPLETE_FAILED`: The Hook completed but failed validation.

• ‘HOOK_FAILED`: The Hook encountered an error during execution.

Returns:

• (String)

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

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

#target_id ⇒ String

The unique identifier of the Hook invocation target.

Returns:

• (String)

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

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

#target_type ⇒ String

The target type that the Hook was invoked against.

Returns:

• (String)

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

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

#type_arn ⇒ String

The ARN of the Hook that was invoked.

Returns:

• (String)

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

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

#type_configuration_version_id ⇒ String

The version of the Hook configuration.

Returns:

• (String)

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

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

#type_name ⇒ String

The name of the Hook that was invoked.

Returns:

• (String)

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

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

#type_version_id ⇒ String

The version of the Hook that was invoked.

Returns:

• (String)

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

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