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 Details

    • status

      Compliance.Builder status(String status)

      Typically summarizes the result of a control check.

      For Security Hub controls, 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 - Typically summarizes the result of a control check.

      For Security Hub controls, 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:

    • status

      Compliance.Builder status(ComplianceStatus status)

      Typically summarizes the result of a control check.

      For Security Hub controls, 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 - Typically summarizes the result of a control check.

      For Security Hub controls, 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:

    • relatedRequirements

      Compliance.Builder relatedRequirements(Collection<String> relatedRequirements)

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

      Array Members: Maximum number of 32 items.

      Parameters:
      relatedRequirements - Typically provides the industry or regulatory framework requirements that are related to a 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)

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

      Array Members: Maximum number of 32 items.

      Parameters:
      relatedRequirements - Typically provides the industry or regulatory framework requirements that are related to a 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)

      Typically used to provide a list of reasons for the value of Status.

      Parameters:
      statusReasons - Typically used to provide a list of reasons for the value of Status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • statusReasons

      Compliance.Builder statusReasons(StatusReason... statusReasons)

      Typically used to provide a list of reasons for the value of Status.

      Parameters:
      statusReasons - Typically used to provide a list of reasons for the value of Status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • statusReasons

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

      Typically used to provide a list of reasons for the value of Status.

      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<StatusReason>).

      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:

    • securityControlId

      Compliance.Builder securityControlId(String securityControlId)

      Typically provides the unique identifier of a control across standards. For Security Hub controls, this field consists of an Amazon Web Services service and a unique number, such as APIGateway.5.

      Parameters:
      securityControlId - Typically provides the unique identifier of a control across standards. For Security Hub controls, this field consists of an Amazon Web Services service and a unique 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)

      Typically provides an array of enabled security standards in which a security control is currently enabled.

      Parameters:
      associatedStandards - Typically provides an array of 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)

      Typically provides an array of enabled security standards in which a security control is currently enabled.

      Parameters:
      associatedStandards - Typically provides an array of 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)

      Typically provides an array of 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<AssociatedStandard>).

      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:

    • securityControlParameters

      Compliance.Builder securityControlParameters(Collection<SecurityControlParameter> securityControlParameters)

      Typically an object that includes security control parameter names and values.

      Parameters:
      securityControlParameters - Typically 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)

      Typically an object that includes security control parameter names and values.

      Parameters:
      securityControlParameters - Typically 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)

      Typically 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<SecurityControlParameter>).

      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: