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

Interface SecurityControlDefinition.Builder

    • Method Detail

      • securityControlId

        SecurityControlDefinition.Builder securityControlId​(String securityControlId)

        The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Services 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 Services 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.

      • title

        SecurityControlDefinition.Builder title​(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.

      • description

        SecurityControlDefinition.Builder description​(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.

      • remediationUrl

        SecurityControlDefinition.Builder remediationUrl​(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.

      • currentRegionAvailability

        SecurityControlDefinition.Builder currentRegionAvailability​(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, RegionAvailabilityStatus

      • customizablePropertiesWithStrings

        SecurityControlDefinition.Builder customizablePropertiesWithStrings​(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.

      • customizablePropertiesWithStrings

        SecurityControlDefinition.Builder customizablePropertiesWithStrings​(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.

      • customizableProperties

        SecurityControlDefinition.Builder customizableProperties​(Collection<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.

      • customizableProperties

        SecurityControlDefinition.Builder customizableProperties​(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.

      • parameterDefinitions

        SecurityControlDefinition.Builder parameterDefinitions​(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.