Package software.amazon.awssdk.services.securityhub.model

Class SecurityControl

java.lang.Object

software.amazon.awssdk.services.securityhub.model.SecurityControl

All Implemented Interfaces:

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

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

A security control in Security Hub describes a security best practice related to a specific resource.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SecurityControl.Builder

Method Summary

Modifier and Type	Method	Description
static SecurityControl.Builder	builder()
String	description()	The description of a security control across standards.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	remediationUrl()	A link to Security Hub documentation that explains how to remediate a failed finding for a security control.
List<SdkField<?>>	sdkFields()
String	securityControlArn()	The Amazon Resource Name (ARN) for a security control across standards, such as arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1.
String	securityControlId()	The unique identifier of a security control across standards.
ControlStatus	securityControlStatus()	The enablement status of a security control in a specific standard.
String	securityControlStatusAsString()	The enablement status of a security control in a specific standard.
static Class<? extends SecurityControl.Builder>	serializableBuilderClass()
SeverityRating	severityRating()	The severity of a security control.
String	severityRatingAsString()	The severity of a security control.
String	title()	The title of a security control.
SecurityControl.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

securityControlId

public final String securityControlId()

The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Service name and a number, such as APIGateway.3.

Returns:

The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Service name and a number, such as APIGateway.3.

securityControlArn

public final String securityControlArn()

The Amazon Resource Name (ARN) for a security control across standards, such as arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1. This parameter doesn't mention a specific standard.

Returns:

The Amazon Resource Name (ARN) for a security control across standards, such as arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1. This parameter doesn't mention a specific standard.

title

public final String title()

The title of a security control.

Returns:

The title of a security control.

description

public final String description()

The description of a security control across standards. This typically summarizes how Security Hub evaluates the control and the conditions under which it produces a failed finding. This parameter doesn't reference a specific standard.

Returns:

The description of a security control across standards. This typically summarizes how Security Hub evaluates the control and the conditions under which it produces a failed finding. This parameter doesn't reference a specific standard.

remediationUrl

public final String remediationUrl()

A link to Security Hub documentation that explains how to remediate a failed finding for a security control.

Returns:

A link to Security Hub documentation that explains how to remediate a failed finding for a security control.

severityRating

public final SeverityRating severityRating()

The severity of a security control. For more information about how Security Hub determines control severity, see Assigning severity to control findings in the Security Hub User Guide.

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

Returns:

The severity of a security control. For more information about how Security Hub determines control severity, see Assigning severity to control findings in the Security Hub User Guide.

See Also:

SeverityRating

severityRatingAsString

public final String severityRatingAsString()

The severity of a security control. For more information about how Security Hub determines control severity, see Assigning severity to control findings in the Security Hub User Guide.

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

Returns:

The severity of a security control. For more information about how Security Hub determines control severity, see Assigning severity to control findings in the Security Hub User Guide.

See Also:

SeverityRating

securityControlStatus

public final ControlStatus securityControlStatus()

The enablement status of a security control in a specific standard.

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

Returns:

The enablement status of a security control in a specific standard.

See Also:

ControlStatus

securityControlStatusAsString

public final String securityControlStatusAsString()

The enablement status of a security control in a specific standard.

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

Returns:

The enablement status of a security control in a specific standard.

See Also:

ControlStatus

toBuilder

public SecurityControl.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SecurityControl.Builder,SecurityControl>

builder

public static SecurityControl.Builder builder()

serializableBuilderClass

public static Class<? extends SecurityControl.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