Package software.amazon.awssdk.services.cloudformation.model

Class Annotation

java.lang.Object

software.amazon.awssdk.services.cloudformation.model.Annotation

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Annotation.Builder,Annotation>

@Generated("software.amazon.awssdk:codegen")
public final class Annotation
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Annotation.Builder,Annotation>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Annotation.Builder

Method Summary

Modifier and Type	Method	Description
String	annotationName()	An identifier for the evaluation logic that was used when invoking the Hook.
static Annotation.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	remediationLink()	A URL that you can access for additional remediation guidance.
String	remediationMessage()	Suggests what to change if your Hook returns a FAILED status.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Annotation.Builder>	serializableBuilderClass()
AnnotationSeverityLevel	severityLevel()	The relative risk associated with any violations of this type.
String	severityLevelAsString()	The relative risk associated with any violations of this type.
AnnotationStatus	status()	The status of the Hook invocation from the downstream service.
String	statusAsString()	The status of the Hook invocation from the downstream service.
String	statusMessage()	The explanation for the specific status assigned to this Hook invocation.
Annotation.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

annotationName

public final String 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.

Returns:

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.

status

public final AnnotationStatus status()

The status of the Hook invocation from the downstream service.

If the service returns an enum value that is not available in the current SDK version, status will return AnnotationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the Hook invocation from the downstream service.

See Also:

AnnotationStatus

statusAsString

public final String statusAsString()

The status of the Hook invocation from the downstream service.

If the service returns an enum value that is not available in the current SDK version, status will return AnnotationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the Hook invocation from the downstream service.

See Also:

AnnotationStatus

statusMessage

public final String statusMessage()

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

Returns:

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

remediationMessage

public final String remediationMessage()

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

Returns:

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

remediationLink

public final String remediationLink()

A URL that you can access for additional remediation guidance.

Returns:

A URL that you can access for additional remediation guidance.

severityLevel

public final AnnotationSeverityLevel severityLevel()

The relative risk associated with any violations of this type.

If the service returns an enum value that is not available in the current SDK version, severityLevel will return AnnotationSeverityLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from severityLevelAsString().

Returns:

The relative risk associated with any violations of this type.

See Also:

AnnotationSeverityLevel

severityLevelAsString

public final String severityLevelAsString()

The relative risk associated with any violations of this type.

If the service returns an enum value that is not available in the current SDK version, severityLevel will return AnnotationSeverityLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from severityLevelAsString().

Returns:

The relative risk associated with any violations of this type.

See Also:

AnnotationSeverityLevel

toBuilder

public Annotation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Annotation.Builder,Annotation>

builder

public static Annotation.Builder builder()

serializableBuilderClass

public static Class<? extends Annotation.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo