Class: Aws::CloudFormation::Types::Annotation

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

Overview

The Annotation data type.

A GetHookResult call returns detailed information and remediation guidance from Control Tower, Guard, Lambda, or custom Hooks for a Hook invocation result.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#annotation_name ⇒ String

An identifier for the evaluation logic that was used when invoking the Hook. For Control Tower, this is the control ID. For Guard, this is the rule ID. For Lambda and custom Hooks, this is a user-defined identifier.

Returns:

  • (String) 


277
278
279
280
281
282
283
284
285
286
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 277

class Annotation < Struct.new(
  :annotation_name,
  :status,
  :status_message,
  :remediation_message,
  :remediation_link,
  :severity_level)
  SENSITIVE = []
  include Aws::Structure
end

#remediation_link ⇒ String

A URL that you can access for additional remediation guidance.

Returns:

  • (String) 


277
278
279
280
281
282
283
284
285
286
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 277

class Annotation < Struct.new(
  :annotation_name,
  :status,
  :status_message,
  :remediation_message,
  :remediation_link,
  :severity_level)
  SENSITIVE = []
  include Aws::Structure
end

#remediation_message ⇒ String

Suggests what to change if your Hook returns a FAILED status. For example, "Block public access to the bucket".

Returns:

  • (String) 


277
278
279
280
281
282
283
284
285
286
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 277

class Annotation < Struct.new(
  :annotation_name,
  :status,
  :status_message,
  :remediation_message,
  :remediation_link,
  :severity_level)
  SENSITIVE = []
  include Aws::Structure
end

#severity_level ⇒ String

The relative risk associated with any violations of this type.

Returns:

  • (String) 


277
278
279
280
281
282
283
284
285
286
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 277

class Annotation < Struct.new(
  :annotation_name,
  :status,
  :status_message,
  :remediation_message,
  :remediation_link,
  :severity_level)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the Hook invocation from the downstream service.

Returns:

  • (String) 


277
278
279
280
281
282
283
284
285
286
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 277

class Annotation < Struct.new(
  :annotation_name,
  :status,
  :status_message,
  :remediation_message,
  :remediation_link,
  :severity_level)
  SENSITIVE = []
  include Aws::Structure
end

#status_message ⇒ String

The explanation for the specific status assigned to this Hook invocation. For example, "Bucket does not block public access".

Returns:

  • (String) 


277
278
279
280
281
282
283
284
285
286
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 277

class Annotation < Struct.new(
  :annotation_name,
  :status,
  :status_message,
  :remediation_message,
  :remediation_link,
  :severity_level)
  SENSITIVE = []
  include Aws::Structure
end