Interface Compliance.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Compliance.Builder,
,Compliance> SdkBuilder<Compliance.Builder,
,Compliance> SdkPojo
- Enclosing class:
Compliance
-
Method Summary
Modifier and TypeMethodDescriptionassociatedStandards
(Collection<AssociatedStandard> associatedStandards) The enabled security standards in which a security control is currently enabled.associatedStandards
(Consumer<AssociatedStandard.Builder>... associatedStandards) The enabled security standards in which a security control is currently enabled.associatedStandards
(AssociatedStandard... associatedStandards) The enabled security standards in which a security control is currently enabled.relatedRequirements
(String... relatedRequirements) For a control, the industry or regulatory framework requirements that are related to the control.relatedRequirements
(Collection<String> relatedRequirements) For a control, the industry or regulatory framework requirements that are related to the control.securityControlId
(String securityControlId) The unique identifier of a control across standards.securityControlParameters
(Collection<SecurityControlParameter> securityControlParameters) An object that includes security control parameter names and values.securityControlParameters
(Consumer<SecurityControlParameter.Builder>... securityControlParameters) An object that includes security control parameter names and values.securityControlParameters
(SecurityControlParameter... securityControlParameters) An object that includes security control parameter names and values.The result of a standards check.status
(ComplianceStatus status) The result of a standards check.statusReasons
(Collection<StatusReason> statusReasons) For findings generated from controls, a list of reasons behind the value ofStatus
.statusReasons
(Consumer<StatusReason.Builder>... statusReasons) For findings generated from controls, a list of reasons behind the value ofStatus
.statusReasons
(StatusReason... statusReasons) For findings generated from controls, a list of reasons behind the value ofStatus
.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 Details
-
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 wasNOT_APPLICABLE
. If the Config evaluation result wasNOT_APPLICABLE
, then after 3 days, Security Hub automatically archives the finding.
-
- 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 wasNOT_APPLICABLE
. If the Config evaluation result wasNOT_APPLICABLE
, then after 3 days, Security Hub automatically archives the finding.
-
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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 wasNOT_APPLICABLE
. If the Config evaluation result wasNOT_APPLICABLE
, then after 3 days, Security Hub automatically archives the finding.
-
- 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 wasNOT_APPLICABLE
. If the Config evaluation result wasNOT_APPLICABLE
, then after 3 days, Security Hub automatically archives the finding.
-
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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 ofStatus
. 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
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 ofStatus
. 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
For findings generated from controls, a list of reasons behind the value of
This is a convenience method that creates an instance of theStatus
. For the list of status reason codes and their meanings, see Standards-related information in the ASFF in the Security Hub User Guide.StatusReason.Builder
avoiding the need to create one manually viaStatusReason.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostatusReasons(List<StatusReason>)
.- Parameters:
statusReasons
- a consumer that will call methods onStatusReason.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
The enabled security standards in which a security control is currently enabled.
This is a convenience method that creates an instance of theAssociatedStandard.Builder
avoiding the need to create one manually viaAssociatedStandard.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toassociatedStandards(List<AssociatedStandard>)
.- Parameters:
associatedStandards
- a consumer that will call methods onAssociatedStandard.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 theSecurityControlParameter.Builder
avoiding the need to create one manually viaSecurityControlParameter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosecurityControlParameters(List<SecurityControlParameter>)
.- Parameters:
securityControlParameters
- a consumer that will call methods onSecurityControlParameter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-