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

Interface Compliance.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Compliance.Builder,Compliance>, SdkBuilder<Compliance.Builder,Compliance>, SdkPojo

Enclosing class:

Compliance

public static interface Compliance.Builder
extends SdkPojo, CopyableBuilder<Compliance.Builder,Compliance>

Method Summary

Modifier and Type	Method	Description
Compliance.Builder	associatedStandards(Collection<AssociatedStandard> associatedStandards)	The enabled security standards in which a security control is currently enabled.
Compliance.Builder	associatedStandards(Consumer<AssociatedStandard.Builder>... associatedStandards)	The enabled security standards in which a security control is currently enabled.
Compliance.Builder	associatedStandards(AssociatedStandard... associatedStandards)	The enabled security standards in which a security control is currently enabled.
Compliance.Builder	relatedRequirements(String... relatedRequirements)	For a control, the industry or regulatory framework requirements that are related to the control.
Compliance.Builder	relatedRequirements(Collection<String> relatedRequirements)	For a control, the industry or regulatory framework requirements that are related to the control.
Compliance.Builder	securityControlId(String securityControlId)	The unique identifier of a control across standards.
Compliance.Builder	securityControlParameters(Collection<SecurityControlParameter> securityControlParameters)	An object that includes security control parameter names and values.
Compliance.Builder	securityControlParameters(Consumer<SecurityControlParameter.Builder>... securityControlParameters)	An object that includes security control parameter names and values.
Compliance.Builder	securityControlParameters(SecurityControlParameter... securityControlParameters)	An object that includes security control parameter names and values.
Compliance.Builder	status(String status)	The result of a standards check.
Compliance.Builder	status(ComplianceStatus status)	The result of a standards check.
Compliance.Builder	statusReasons(Collection<StatusReason> statusReasons)	For findings generated from controls, a list of reasons behind the value of Status.
Compliance.Builder	statusReasons(Consumer<StatusReason.Builder>... statusReasons)	For findings generated from controls, a list of reasons behind the value of Status.
Compliance.Builder	statusReasons(StatusReason... statusReasons)	For findings generated from controls, a list of reasons behind the value of Status.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

status

Compliance.Builder status(String status)

The result of a standards check.

The valid values for Status are as follows.

• • PASSED - Standards check passed for all evaluated resources.

  • WARNING - Some information is missing or this check is not supported for your configuration.

  • FAILED - Standards check failed for at least one evaluated resource.

  • NOT_AVAILABLE - Check could not be performed due to a service outage, API error, or because the result of the Config evaluation was NOT_APPLICABLE. If the Config evaluation result was NOT_APPLICABLE for a Security Hub control, Security Hub automatically archives the finding after 3 days.

Parameters:

status - The result of a standards check.

The valid values for Status are as follows.

• • PASSED - Standards check passed for all evaluated resources.

  • WARNING - Some information is missing or this check is not supported for your configuration.

  • FAILED - Standards check failed for at least one evaluated resource.

  • NOT_AVAILABLE - Check could not be performed due to a service outage, API error, or because the result of the Config evaluation was NOT_APPLICABLE. If the Config evaluation result was NOT_APPLICABLE for a Security Hub control, Security Hub automatically archives the finding after 3 days.

Returns:

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

See Also:

ComplianceStatus, ComplianceStatus

status

Compliance.Builder status(ComplianceStatus status)

The result of a standards check.

The valid values for Status are as follows.

• • PASSED - Standards check passed for all evaluated resources.

  • WARNING - Some information is missing or this check is not supported for your configuration.

  • FAILED - Standards check failed for at least one evaluated resource.

  • NOT_AVAILABLE - Check could not be performed due to a service outage, API error, or because the result of the Config evaluation was NOT_APPLICABLE. If the Config evaluation result was NOT_APPLICABLE for a Security Hub control, Security Hub automatically archives the finding after 3 days.

Parameters:

status - The result of a standards check.

The valid values for Status are as follows.

• • PASSED - Standards check passed for all evaluated resources.

  • WARNING - Some information is missing or this check is not supported for your configuration.

  • FAILED - Standards check failed for at least one evaluated resource.

  • NOT_AVAILABLE - Check could not be performed due to a service outage, API error, or because the result of the Config evaluation was NOT_APPLICABLE. If the Config evaluation result was NOT_APPLICABLE for a Security Hub control, Security Hub automatically archives the finding after 3 days.

Returns:

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

See Also:

ComplianceStatus, ComplianceStatus

relatedRequirements

Compliance.Builder relatedRequirements(Collection<String> relatedRequirements)

For a control, the industry or regulatory framework requirements that are related to the control. The check for that control is aligned with these requirements.

Array Members: Maximum number of 32 items.

Parameters:

relatedRequirements - For a control, the industry or regulatory framework requirements that are related to the control. The check for that control is aligned with these requirements.

Array Members: Maximum number of 32 items.

Returns:

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

relatedRequirements

Compliance.Builder relatedRequirements(String... relatedRequirements)

For a control, the industry or regulatory framework requirements that are related to the control. The check for that control is aligned with these requirements.

Array Members: Maximum number of 32 items.

Parameters:

relatedRequirements - For a control, the industry or regulatory framework requirements that are related to the control. The check for that control is aligned with these requirements.

Array Members: Maximum number of 32 items.

Returns:

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

statusReasons

Compliance.Builder statusReasons(Collection<StatusReason> statusReasons)

For findings generated from controls, a list of reasons behind the value of Status. For the list of status reason codes and their meanings, see Standards-related information in the ASFF in the Security Hub User Guide.

Parameters:

statusReasons - For findings generated from controls, a list of reasons behind the value of Status. For the list of status reason codes and their meanings, see Standards-related information in the ASFF in the Security Hub User Guide.

Returns:

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

statusReasons

Compliance.Builder statusReasons(StatusReason... statusReasons)

For findings generated from controls, a list of reasons behind the value of Status. For the list of status reason codes and their meanings, see Standards-related information in the ASFF in the Security Hub User Guide.

Parameters:

statusReasons - For findings generated from controls, a list of reasons behind the value of Status. For the list of status reason codes and their meanings, see Standards-related information in the ASFF in the Security Hub User Guide.

Returns:

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

statusReasons

Compliance.Builder statusReasons(Consumer<StatusReason.Builder>... statusReasons)

For findings generated from controls, a list of reasons behind the value of Status. For the list of status reason codes and their meanings, see Standards-related information in the ASFF in the Security Hub User Guide.

This is a convenience method that creates an instance of the StatusReason.Builder avoiding the need to create one manually via StatusReason.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #statusReasons(List).

Parameters:

statusReasons - a consumer that will call methods on StatusReason.Builder

Returns:

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

See Also:

#statusReasons(java.util.Collection)

securityControlId

Compliance.Builder securityControlId(String securityControlId)

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

Parameters:

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

Returns:

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

associatedStandards

Compliance.Builder associatedStandards(Collection<AssociatedStandard> associatedStandards)

The enabled security standards in which a security control is currently enabled.

Parameters:

associatedStandards - The enabled security standards in which a security control is currently enabled.

Returns:

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

associatedStandards

Compliance.Builder associatedStandards(AssociatedStandard... associatedStandards)

The enabled security standards in which a security control is currently enabled.

Parameters:

associatedStandards - The enabled security standards in which a security control is currently enabled.

Returns:

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

associatedStandards

Compliance.Builder associatedStandards(Consumer<AssociatedStandard.Builder>... associatedStandards)

The enabled security standards in which a security control is currently enabled.

This is a convenience method that creates an instance of the AssociatedStandard.Builder avoiding the need to create one manually via AssociatedStandard.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #associatedStandards(List).

Parameters:

associatedStandards - a consumer that will call methods on AssociatedStandard.Builder

Returns:

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

See Also:

#associatedStandards(java.util.Collection)

securityControlParameters

Compliance.Builder securityControlParameters(Collection<SecurityControlParameter> securityControlParameters)

An object that includes security control parameter names and values.

Parameters:

securityControlParameters - An object that includes security control parameter names and values.

Returns:

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

securityControlParameters

Compliance.Builder securityControlParameters(SecurityControlParameter... securityControlParameters)

An object that includes security control parameter names and values.

Parameters:

securityControlParameters - An object that includes security control parameter names and values.

Returns:

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

securityControlParameters

Compliance.Builder securityControlParameters(Consumer<SecurityControlParameter.Builder>... securityControlParameters)

An object that includes security control parameter names and values.

This is a convenience method that creates an instance of the SecurityControlParameter.Builder avoiding the need to create one manually via SecurityControlParameter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #securityControlParameters(List).

Parameters:

securityControlParameters - a consumer that will call methods on SecurityControlParameter.Builder

Returns:

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

See Also:

#securityControlParameters(java.util.Collection)