AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Inheritance Hierarchy

System.Object
  Amazon.CloudFormation.Model.Annotation

Namespace: Amazon.CloudFormation.Model
Assembly: AWSSDK.CloudFormation.dll
Version: 3.x.y.z

Syntax

C#
public class Annotation

The Annotation type exposes the following members

Constructors

NameDescription
Public Method Annotation()

Properties

NameTypeDescription
Public Property AnnotationName System.String

Gets and sets the property AnnotationName.

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.

Public Property RemediationLink System.String

Gets and sets the property RemediationLink.

A URL that you can access for additional remediation guidance.

Public Property RemediationMessage System.String

Gets and sets the property RemediationMessage.

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

Public Property SeverityLevel Amazon.CloudFormation.AnnotationSeverityLevel

Gets and sets the property SeverityLevel.

The relative risk associated with any violations of this type.

Public Property Status Amazon.CloudFormation.AnnotationStatus

Gets and sets the property Status.

The status of the Hook invocation from the downstream service.

Public Property StatusMessage System.String

Gets and sets the property StatusMessage.

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

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5