class
Amazonite::CloudFormation::Annotation
- Amazonite::CloudFormation::Annotation
- Reference
- Object
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.
Defined in:
cloudformation/annotation.crConstructors
- .from_xml(node : XML::Node) : self
- .new(annotation_name : String | Nil = nil, status : AnnotationStatus | Nil = nil, status_message : String | Nil = nil, remediation_message : String | Nil = nil, remediation_link : String | Nil = nil, severity_level : AnnotationSeverityLevel | Nil = nil)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#annotation_name : String | Nil
An identifier for the evaluation logic that was used when invoking the Hook.
-
#annotation_name=(annotation_name : String | Nil)
An identifier for the evaluation logic that was used when invoking the Hook.
-
#hash(hasher)
See
Object#hash(hasher) -
#remediation_link : String | Nil
A URL that you can access for additional remediation guidance.
-
#remediation_link=(remediation_link : String | Nil)
A URL that you can access for additional remediation guidance.
-
#remediation_message : String | Nil
Suggests what to change if your Hook returns a
FAILEDstatus. -
#remediation_message=(remediation_message : String | Nil)
Suggests what to change if your Hook returns a
FAILEDstatus. -
#severity_level : AnnotationSeverityLevel | Nil
The relative risk associated with any violations of this type.
-
#severity_level=(severity_level : AnnotationSeverityLevel | Nil)
The relative risk associated with any violations of this type.
-
#status : AnnotationStatus | Nil
The status of the Hook invocation from the downstream service.
-
#status=(status : AnnotationStatus | Nil)
The status of the Hook invocation from the downstream service.
-
#status_message : String | Nil
The explanation for the specific status assigned to this Hook invocation.
-
#status_message=(status_message : String | Nil)
The explanation for the specific status assigned to this Hook invocation.
- #to_query_params(prefix : String) : Array(Tuple(String, String))
- #validate! : Nil
Constructor Detail
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
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.
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.
A URL that you can access for additional remediation guidance.
A URL that you can access for additional remediation guidance.
Suggests what to change if your Hook returns a FAILED status. For example, "Block public
access to the bucket".
Suggests what to change if your Hook returns a FAILED status. For example, "Block public
access to the bucket".
The relative risk associated with any violations of this type.
The relative risk associated with any violations of this type.
The status of the Hook invocation from the downstream service.
The status of the Hook invocation from the downstream service.
The explanation for the specific status assigned to this Hook invocation. For example, "Bucket does not block public access".
The explanation for the specific status assigned to this Hook invocation. For example, "Bucket does not block public access".