com.amazonaws.services.securityhub.model

Class SecurityControlDefinition

java.lang.Object

com.amazonaws.services.securityhub.model.SecurityControlDefinition

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SecurityControlDefinition
extends Object
implements Serializable, Cloneable, StructuredPojo

Provides metadata for a security control, including its unique standard-agnostic identifier, title, description, severity, availability in Amazon Web Services Regions, and a link to remediation steps.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SecurityControlDefinition()

Method Summary

Modifier and Type	Method and Description
SecurityControlDefinition	addParameterDefinitionsEntry(String key, ParameterDefinition value) Add a single ParameterDefinitions entry
SecurityControlDefinition	clearParameterDefinitionsEntries() Removes all the entries added into ParameterDefinitions.
SecurityControlDefinition	clone()
boolean	equals(Object obj)
String	getCurrentRegionAvailability() Specifies whether a security control is available in the current Amazon Web Services Region.
List<String>	getCustomizableProperties() Security control properties that you can customize.
String	getDescription() The description of a security control across standards.
Map<String,ParameterDefinition>	getParameterDefinitions() An object that provides a security control parameter name, description, and the options for customizing it.
String	getRemediationUrl() A link to Security Hub documentation that explains how to remediate a failed finding for a security control.
String	getSecurityControlId() The unique identifier of a security control across standards.
String	getSeverityRating() The severity of a security control.
String	getTitle() The title of a security control.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setCurrentRegionAvailability(String currentRegionAvailability) Specifies whether a security control is available in the current Amazon Web Services Region.
void	setCustomizableProperties(Collection<String> customizableProperties) Security control properties that you can customize.
void	setDescription(String description) The description of a security control across standards.
void	setParameterDefinitions(Map<String,ParameterDefinition> parameterDefinitions) An object that provides a security control parameter name, description, and the options for customizing it.
void	setRemediationUrl(String remediationUrl) A link to Security Hub documentation that explains how to remediate a failed finding for a security control.
void	setSecurityControlId(String securityControlId) The unique identifier of a security control across standards.
void	setSeverityRating(String severityRating) The severity of a security control.
void	setTitle(String title) The title of a security control.
String	toString() Returns a string representation of this object.
SecurityControlDefinition	withCurrentRegionAvailability(RegionAvailabilityStatus currentRegionAvailability) Specifies whether a security control is available in the current Amazon Web Services Region.
SecurityControlDefinition	withCurrentRegionAvailability(String currentRegionAvailability) Specifies whether a security control is available in the current Amazon Web Services Region.
SecurityControlDefinition	withCustomizableProperties(Collection<String> customizableProperties) Security control properties that you can customize.
SecurityControlDefinition	withCustomizableProperties(SecurityControlProperty... customizableProperties) Security control properties that you can customize.
SecurityControlDefinition	withCustomizableProperties(String... customizableProperties) Security control properties that you can customize.
SecurityControlDefinition	withDescription(String description) The description of a security control across standards.
SecurityControlDefinition	withParameterDefinitions(Map<String,ParameterDefinition> parameterDefinitions) An object that provides a security control parameter name, description, and the options for customizing it.
SecurityControlDefinition	withRemediationUrl(String remediationUrl) A link to Security Hub documentation that explains how to remediate a failed finding for a security control.
SecurityControlDefinition	withSecurityControlId(String securityControlId) The unique identifier of a security control across standards.
SecurityControlDefinition	withSeverityRating(SeverityRating severityRating) The severity of a security control.
SecurityControlDefinition	withSeverityRating(String severityRating) The severity of a security control.
SecurityControlDefinition	withTitle(String title) The title of a security control.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SecurityControlDefinition

public SecurityControlDefinition()

Method Detail

setSecurityControlId

public void setSecurityControlId(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 (for example, APIGateway.3). This parameter differs from SecurityControlArn, which is a unique Amazon Resource Name (ARN) assigned to a control. The ARN references the security control ID (for example, arn:aws:securityhub:eu-central-1:123456789012:security-control/APIGateway.3).

Parameters:

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 (for example, APIGateway.3). This parameter differs from SecurityControlArn, which is a unique Amazon Resource Name (ARN) assigned to a control. The ARN references the security control ID (for example, arn:aws:securityhub:eu-central-1:123456789012:security-control/APIGateway.3).

getSecurityControlId

public String getSecurityControlId()

The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Service name and a number (for example, APIGateway.3). This parameter differs from SecurityControlArn, which is a unique Amazon Resource Name (ARN) assigned to a control. The ARN references the security control ID (for example, arn:aws:securityhub:eu-central-1:123456789012:security-control/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 (for example, APIGateway.3). This parameter differs from SecurityControlArn, which is a unique Amazon Resource Name (ARN) assigned to a control. The ARN references the security control ID (for example, arn:aws:securityhub:eu-central-1:123456789012:security-control/APIGateway.3).

withSecurityControlId

public SecurityControlDefinition withSecurityControlId(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 (for example, APIGateway.3). This parameter differs from SecurityControlArn, which is a unique Amazon Resource Name (ARN) assigned to a control. The ARN references the security control ID (for example, arn:aws:securityhub:eu-central-1:123456789012:security-control/APIGateway.3).

Parameters:

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 (for example, APIGateway.3). This parameter differs from SecurityControlArn, which is a unique Amazon Resource Name (ARN) assigned to a control. The ARN references the security control ID (for example, arn:aws:securityhub:eu-central-1:123456789012:security-control/APIGateway.3).

Returns:

Returns a reference to this object so that method calls can be chained together.

setTitle

public void setTitle(String title)

The title of a security control.

Parameters:

title - The title of a security control.

getTitle

public String getTitle()

The title of a security control.

Returns:

The title of a security control.

withTitle

public SecurityControlDefinition withTitle(String title)

The title of a security control.

Parameters:

title - The title of a security control.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(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.

Parameters:

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.

getDescription

public String getDescription()

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.

withDescription

public SecurityControlDefinition withDescription(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setRemediationUrl

public void setRemediationUrl(String remediationUrl)

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

Parameters:

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

getRemediationUrl

public String getRemediationUrl()

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.

withRemediationUrl

public SecurityControlDefinition withRemediationUrl(String remediationUrl)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setSeverityRating

public void setSeverityRating(String 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.

Parameters:

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.

See Also:

SeverityRating

getSeverityRating

public String getSeverityRating()

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.

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

withSeverityRating

public SecurityControlDefinition withSeverityRating(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SeverityRating

withSeverityRating

public SecurityControlDefinition withSeverityRating(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SeverityRating

setCurrentRegionAvailability

public void setCurrentRegionAvailability(String currentRegionAvailability)

Specifies whether a security control is available in the current Amazon Web Services Region.

Parameters:

currentRegionAvailability - Specifies whether a security control is available in the current Amazon Web Services Region.

See Also:

RegionAvailabilityStatus

getCurrentRegionAvailability

public String getCurrentRegionAvailability()

Specifies whether a security control is available in the current Amazon Web Services Region.

Returns:

Specifies whether a security control is available in the current Amazon Web Services Region.

See Also:

RegionAvailabilityStatus

withCurrentRegionAvailability

public SecurityControlDefinition withCurrentRegionAvailability(String currentRegionAvailability)

Specifies whether a security control is available in the current Amazon Web Services Region.

Parameters:

currentRegionAvailability - Specifies whether a security control is available in the current Amazon Web Services Region.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RegionAvailabilityStatus

withCurrentRegionAvailability

public SecurityControlDefinition withCurrentRegionAvailability(RegionAvailabilityStatus currentRegionAvailability)

Specifies whether a security control is available in the current Amazon Web Services Region.

Parameters:

currentRegionAvailability - Specifies whether a security control is available in the current Amazon Web Services Region.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RegionAvailabilityStatus

getCustomizableProperties

public List<String> getCustomizableProperties()

Security control properties that you can customize. Currently, only parameter customization is supported for select controls. An empty array is returned for controls that don’t support custom properties.

Returns:

Security control properties that you can customize. Currently, only parameter customization is supported for select controls. An empty array is returned for controls that don’t support custom properties.

See Also:

SecurityControlProperty

setCustomizableProperties

public void setCustomizableProperties(Collection<String> customizableProperties)

Security control properties that you can customize. Currently, only parameter customization is supported for select controls. An empty array is returned for controls that don’t support custom properties.

Parameters:

customizableProperties - Security control properties that you can customize. Currently, only parameter customization is supported for select controls. An empty array is returned for controls that don’t support custom properties.

See Also:

SecurityControlProperty

withCustomizableProperties

public SecurityControlDefinition withCustomizableProperties(String... customizableProperties)

Security control properties that you can customize. Currently, only parameter customization is supported for select controls. An empty array is returned for controls that don’t support custom properties.

NOTE: This method appends the values to the existing list (if any). Use setCustomizableProperties(java.util.Collection) or withCustomizableProperties(java.util.Collection) if you want to override the existing values.

Parameters:

customizableProperties - Security control properties that you can customize. Currently, only parameter customization is supported for select controls. An empty array is returned for controls that don’t support custom properties.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SecurityControlProperty

withCustomizableProperties

public SecurityControlDefinition withCustomizableProperties(Collection<String> customizableProperties)

Security control properties that you can customize. Currently, only parameter customization is supported for select controls. An empty array is returned for controls that don’t support custom properties.

Parameters:

customizableProperties - Security control properties that you can customize. Currently, only parameter customization is supported for select controls. An empty array is returned for controls that don’t support custom properties.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SecurityControlProperty

withCustomizableProperties

public SecurityControlDefinition withCustomizableProperties(SecurityControlProperty... customizableProperties)

Security control properties that you can customize. Currently, only parameter customization is supported for select controls. An empty array is returned for controls that don’t support custom properties.

Parameters:

customizableProperties - Security control properties that you can customize. Currently, only parameter customization is supported for select controls. An empty array is returned for controls that don’t support custom properties.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SecurityControlProperty

getParameterDefinitions

public Map<String,ParameterDefinition> getParameterDefinitions()

An object that provides a security control parameter name, description, and the options for customizing it. This object is excluded for a control that doesn't support custom parameters.

Returns:

An object that provides a security control parameter name, description, and the options for customizing it. This object is excluded for a control that doesn't support custom parameters.

setParameterDefinitions

public void setParameterDefinitions(Map<String,ParameterDefinition> parameterDefinitions)

An object that provides a security control parameter name, description, and the options for customizing it. This object is excluded for a control that doesn't support custom parameters.

Parameters:

parameterDefinitions - An object that provides a security control parameter name, description, and the options for customizing it. This object is excluded for a control that doesn't support custom parameters.

withParameterDefinitions

public SecurityControlDefinition withParameterDefinitions(Map<String,ParameterDefinition> parameterDefinitions)

An object that provides a security control parameter name, description, and the options for customizing it. This object is excluded for a control that doesn't support custom parameters.

Parameters:

parameterDefinitions - An object that provides a security control parameter name, description, and the options for customizing it. This object is excluded for a control that doesn't support custom parameters.

Returns:

Returns a reference to this object so that method calls can be chained together.

addParameterDefinitionsEntry

public SecurityControlDefinition addParameterDefinitionsEntry(String key,
                                                              ParameterDefinition value)

Add a single ParameterDefinitions entry

See Also:

withParameterDefinitions(java.util.Map<java.lang.String, com.amazonaws.services.securityhub.model.ParameterDefinition>)

clearParameterDefinitionsEntries

public SecurityControlDefinition clearParameterDefinitionsEntries()

Removes all the entries added into ParameterDefinitions.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SecurityControlDefinition clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.