Class: Aws::CloudFormation::Types::GetHookResultOutput

Inherits:

Struct

• Object
• Struct
• Aws::CloudFormation::Types::GetHookResultOutput

Includes:

Structure

Defined in:

lib/aws-sdk-cloudformation/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #annotations ⇒ Array<Types::Annotation>

  A list of objects with additional information and guidance that can help you resolve a failed Hook invocation.

• #failure_mode ⇒ String

  The failure mode of the invocation.

• #hook_result_id ⇒ String

  The unique identifier of the Hook result.

• #hook_status_reason ⇒ String

  A message that provides additional details about the Hook invocation 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.

• #original_type_name ⇒ String

  The original public type name of the Hook when an alias is used.

• #status ⇒ String

  The status of the Hook invocation.

• #target ⇒ Types::HookTarget

  Information about the target of the Hook invocation.

• #type_arn ⇒ String

  The Amazon Resource Name (ARN) of the Hook.

• #type_configuration_version_id ⇒ String

  The version identifier of the Hook configuration data that was used during invocation.

• #type_name ⇒ String

  The name of the Hook that was invoked.

• #type_version_id ⇒ String

  The version identifier of the Hook that was invoked.

Instance Attribute Details

#annotations ⇒ Array<Types::Annotation>

A list of objects with additional information and guidance that can help you resolve a failed Hook invocation.

Returns:

• (Array<Types::Annotation>)

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

class GetHookResultOutput < Struct.new(
  :hook_result_id,
  :invocation_point,
  :failure_mode,
  :type_name,
  :original_type_name,
  :type_version_id,
  :type_configuration_version_id,
  :type_arn,
  :status,
  :hook_status_reason,
  :invoked_at,
  :target,
  :annotations)
  SENSITIVE = []
  include Aws::Structure
end

#failure_mode ⇒ String

The failure mode of the invocation.

Returns:

• (String)

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

class GetHookResultOutput < Struct.new(
  :hook_result_id,
  :invocation_point,
  :failure_mode,
  :type_name,
  :original_type_name,
  :type_version_id,
  :type_configuration_version_id,
  :type_arn,
  :status,
  :hook_status_reason,
  :invoked_at,
  :target,
  :annotations)
  SENSITIVE = []
  include Aws::Structure
end

#hook_result_id ⇒ String

The unique identifier of the Hook result.

Returns:

• (String)

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

class GetHookResultOutput < Struct.new(
  :hook_result_id,
  :invocation_point,
  :failure_mode,
  :type_name,
  :original_type_name,
  :type_version_id,
  :type_configuration_version_id,
  :type_arn,
  :status,
  :hook_status_reason,
  :invoked_at,
  :target,
  :annotations)
  SENSITIVE = []
  include Aws::Structure
end

#hook_status_reason ⇒ String

A message that provides additional details about the Hook invocation status.

Returns:

• (String)

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

class GetHookResultOutput < Struct.new(
  :hook_result_id,
  :invocation_point,
  :failure_mode,
  :type_name,
  :original_type_name,
  :type_version_id,
  :type_configuration_version_id,
  :type_arn,
  :status,
  :hook_status_reason,
  :invoked_at,
  :target,
  :annotations)
  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 4625

class GetHookResultOutput < Struct.new(
  :hook_result_id,
  :invocation_point,
  :failure_mode,
  :type_name,
  :original_type_name,
  :type_version_id,
  :type_configuration_version_id,
  :type_arn,
  :status,
  :hook_status_reason,
  :invoked_at,
  :target,
  :annotations)
  SENSITIVE = []
  include Aws::Structure
end

#invoked_at ⇒ Time

The timestamp when the Hook was invoked.

Returns:

• (Time)

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

class GetHookResultOutput < Struct.new(
  :hook_result_id,
  :invocation_point,
  :failure_mode,
  :type_name,
  :original_type_name,
  :type_version_id,
  :type_configuration_version_id,
  :type_arn,
  :status,
  :hook_status_reason,
  :invoked_at,
  :target,
  :annotations)
  SENSITIVE = []
  include Aws::Structure
end

#original_type_name ⇒ String

The original public type name of the Hook when an alias is used.

For example, if you activate AWS::Hooks::GuardHook with alias MyCompany::Custom::GuardHook, then TypeName will be MyCompany::Custom::GuardHook and OriginalTypeName will be AWS::Hooks::GuardHook.

Returns:

• (String)

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

class GetHookResultOutput < Struct.new(
  :hook_result_id,
  :invocation_point,
  :failure_mode,
  :type_name,
  :original_type_name,
  :type_version_id,
  :type_configuration_version_id,
  :type_arn,
  :status,
  :hook_status_reason,
  :invoked_at,
  :target,
  :annotations)
  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 4625

class GetHookResultOutput < Struct.new(
  :hook_result_id,
  :invocation_point,
  :failure_mode,
  :type_name,
  :original_type_name,
  :type_version_id,
  :type_configuration_version_id,
  :type_arn,
  :status,
  :hook_status_reason,
  :invoked_at,
  :target,
  :annotations)
  SENSITIVE = []
  include Aws::Structure
end

#target ⇒ Types::HookTarget

Information about the target of the Hook invocation.

Returns:

• (Types::HookTarget)

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

class GetHookResultOutput < Struct.new(
  :hook_result_id,
  :invocation_point,
  :failure_mode,
  :type_name,
  :original_type_name,
  :type_version_id,
  :type_configuration_version_id,
  :type_arn,
  :status,
  :hook_status_reason,
  :invoked_at,
  :target,
  :annotations)
  SENSITIVE = []
  include Aws::Structure
end

#type_arn ⇒ String

The Amazon Resource Name (ARN) of the Hook.

Returns:

• (String)

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

class GetHookResultOutput < Struct.new(
  :hook_result_id,
  :invocation_point,
  :failure_mode,
  :type_name,
  :original_type_name,
  :type_version_id,
  :type_configuration_version_id,
  :type_arn,
  :status,
  :hook_status_reason,
  :invoked_at,
  :target,
  :annotations)
  SENSITIVE = []
  include Aws::Structure
end

#type_configuration_version_id ⇒ String

The version identifier of the Hook configuration data that was used during invocation.

Returns:

• (String)

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

class GetHookResultOutput < Struct.new(
  :hook_result_id,
  :invocation_point,
  :failure_mode,
  :type_name,
  :original_type_name,
  :type_version_id,
  :type_configuration_version_id,
  :type_arn,
  :status,
  :hook_status_reason,
  :invoked_at,
  :target,
  :annotations)
  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 4625

class GetHookResultOutput < Struct.new(
  :hook_result_id,
  :invocation_point,
  :failure_mode,
  :type_name,
  :original_type_name,
  :type_version_id,
  :type_configuration_version_id,
  :type_arn,
  :status,
  :hook_status_reason,
  :invoked_at,
  :target,
  :annotations)
  SENSITIVE = []
  include Aws::Structure
end

#type_version_id ⇒ String

The version identifier of the Hook that was invoked.

Returns:

• (String)

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

class GetHookResultOutput < Struct.new(
  :hook_result_id,
  :invocation_point,
  :failure_mode,
  :type_name,
  :original_type_name,
  :type_version_id,
  :type_configuration_version_id,
  :type_arn,
  :status,
  :hook_status_reason,
  :invoked_at,
  :target,
  :annotations)
  SENSITIVE = []
  include Aws::Structure
end