Class: Aws::CloudControlApi::Types::HookProgressEvent

Inherits:

Struct

• Object
• Struct
• Aws::CloudControlApi::Types::HookProgressEvent

Includes:

Structure

Defined in:

lib/aws-sdk-cloudcontrolapi/types.rb

Overview

Represents the current status of applicable Hooks for a resource operation request. It contains list of Hook invocation information for the resource specified in the request since the same target can invoke multiple Hooks. For more information, see [Managing resource operation requests with Amazon Web Services Cloud Control API ][1].

[1]: docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #failure_mode ⇒ String

  The failure mode of the invocation.

• #hook_event_time ⇒ Time

  The time that the Hook invocation request initiated.

• #hook_status ⇒ String

  The status of the Hook invocation.

• #hook_status_message ⇒ String

  The message explaining the current Hook status.

• #hook_type_arn ⇒ String

  The ARN of the Hook being invoked.

• #hook_type_name ⇒ String

  The type name of the Hook being invoked.

• #hook_type_version_id ⇒ String

  The type version of the Hook being invoked.

• #invocation_point ⇒ String

  States whether the Hook is invoked before or after resource provisioning.

Instance Attribute Details

#failure_mode ⇒ String

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

• ‘FAIL`: This will fail the Hook invocation and the request associated with it.

• ‘WARN`: This will fail the Hook invocation, but not the request associated with it.

Returns:

• (String)

# File 'lib/aws-sdk-cloudcontrolapi/types.rb', line 555

class HookProgressEvent < Struct.new(
  :hook_type_name,
  :hook_type_version_id,
  :hook_type_arn,
  :invocation_point,
  :hook_status,
  :hook_event_time,
  :hook_status_message,
  :failure_mode)
  SENSITIVE = []
  include Aws::Structure
end

#hook_event_time ⇒ Time

The time that the Hook invocation request initiated.

Returns:

• (Time)

# File 'lib/aws-sdk-cloudcontrolapi/types.rb', line 555

class HookProgressEvent < Struct.new(
  :hook_type_name,
  :hook_type_version_id,
  :hook_type_arn,
  :invocation_point,
  :hook_status,
  :hook_event_time,
  :hook_status_message,
  :failure_mode)
  SENSITIVE = []
  include Aws::Structure
end

#hook_status ⇒ String

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

• ‘HOOK_PENDING`: The Hook was added to the invocation plan, but not yet invoked.

• ‘HOOK_IN_PROGRESS`: The Hook was invoked, but hasn’t completed.

• ‘HOOK_COMPLETE_SUCCEEDED`: The Hook invocation is complete with a successful result.

• ‘HOOK_COMPLETE_FAILED`: The Hook invocation is complete with a failed result.

• ‘HOOK_FAILED`: The Hook invocation didn’t complete successfully.

Returns:

• (String)

# File 'lib/aws-sdk-cloudcontrolapi/types.rb', line 555

class HookProgressEvent < Struct.new(
  :hook_type_name,
  :hook_type_version_id,
  :hook_type_arn,
  :invocation_point,
  :hook_status,
  :hook_event_time,
  :hook_status_message,
  :failure_mode)
  SENSITIVE = []
  include Aws::Structure
end

#hook_status_message ⇒ String

The message explaining the current Hook status.

Returns:

• (String)

# File 'lib/aws-sdk-cloudcontrolapi/types.rb', line 555

class HookProgressEvent < Struct.new(
  :hook_type_name,
  :hook_type_version_id,
  :hook_type_arn,
  :invocation_point,
  :hook_status,
  :hook_event_time,
  :hook_status_message,
  :failure_mode)
  SENSITIVE = []
  include Aws::Structure
end

#hook_type_arn ⇒ String

The ARN of the Hook being invoked.

Returns:

• (String)

# File 'lib/aws-sdk-cloudcontrolapi/types.rb', line 555

class HookProgressEvent < Struct.new(
  :hook_type_name,
  :hook_type_version_id,
  :hook_type_arn,
  :invocation_point,
  :hook_status,
  :hook_event_time,
  :hook_status_message,
  :failure_mode)
  SENSITIVE = []
  include Aws::Structure
end

#hook_type_name ⇒ String

The type name of the Hook being invoked.

Returns:

• (String)

# File 'lib/aws-sdk-cloudcontrolapi/types.rb', line 555

class HookProgressEvent < Struct.new(
  :hook_type_name,
  :hook_type_version_id,
  :hook_type_arn,
  :invocation_point,
  :hook_status,
  :hook_event_time,
  :hook_status_message,
  :failure_mode)
  SENSITIVE = []
  include Aws::Structure
end

#hook_type_version_id ⇒ String

The type version of the Hook being invoked.

Returns:

• (String)

# File 'lib/aws-sdk-cloudcontrolapi/types.rb', line 555

class HookProgressEvent < Struct.new(
  :hook_type_name,
  :hook_type_version_id,
  :hook_type_arn,
  :invocation_point,
  :hook_status,
  :hook_event_time,
  :hook_status_message,
  :failure_mode)
  SENSITIVE = []
  include Aws::Structure
end

#invocation_point ⇒ String

States whether the Hook is invoked before or after resource provisioning.

Returns:

• (String)

# File 'lib/aws-sdk-cloudcontrolapi/types.rb', line 555

class HookProgressEvent < Struct.new(
  :hook_type_name,
  :hook_type_version_id,
  :hook_type_arn,
  :invocation_point,
  :hook_status,
  :hook_event_time,
  :hook_status_message,
  :failure_mode)
  SENSITIVE = []
  include Aws::Structure
end