Package software.amazon.awssdk.services.wafv2.model

Interface ManagedRuleSetSummary.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ManagedRuleSetSummary.Builder,ManagedRuleSetSummary>, SdkBuilder<ManagedRuleSetSummary.Builder,ManagedRuleSetSummary>, SdkPojo
Enclosing class:
ManagedRuleSetSummary
public static interface ManagedRuleSetSummary.Builder extends SdkPojo, CopyableBuilder<ManagedRuleSetSummary.Builder,ManagedRuleSetSummary>

  • Method Details

    • name

      ManagedRuleSetSummary.Builder name(String name)

      The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

      This name is assigned to the corresponding managed rule group, which your customers can access and use.

      Parameters:
      name - The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

      This name is assigned to the corresponding managed rule group, which your customers can access and use.

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

    • id

      ManagedRuleSetSummary.Builder id(String id)

      A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

      Parameters:
      id - A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      ManagedRuleSetSummary.Builder description(String description)

      A description of the set that helps with identification.

      Parameters:
      description - A description of the set that helps with identification.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lockToken

      ManagedRuleSetSummary.Builder lockToken(String lockToken)

      A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

      Parameters:
      lockToken - A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • arn

      ManagedRuleSetSummary.Builder arn(String arn)

      The Amazon Resource Name (ARN) of the entity.

      Parameters:
      arn - The Amazon Resource Name (ARN) of the entity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • labelNamespace

      ManagedRuleSetSummary.Builder labelNamespace(String labelNamespace)

      The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.

      • The syntax for the label namespace prefix for a managed rule group is the following:

        awswaf:managed:<vendor>:<rule group name>:

      • When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

        <label namespace>:<label from rule>

      Parameters:
      labelNamespace - The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.

      • The syntax for the label namespace prefix for a managed rule group is the following:

        awswaf:managed:<vendor>:<rule group name>:

      • When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

        <label namespace>:<label from rule>

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