Interface CreateRuleRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateRuleRequest.Builder,CreateRuleRequest>, NetworkSecurityManagerRequest.Builder, SdkBuilder<CreateRuleRequest.Builder,CreateRuleRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateRuleRequest
@Mutable @NotThreadSafe public static interface CreateRuleRequest.Builder extends NetworkSecurityManagerRequest.Builder, SdkPojo, CopyableBuilder<CreateRuleRequest.Builder,CreateRuleRequest>

  • Method Details

    • clientToken

      CreateRuleRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.

      Parameters:
      clientToken - A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ruleName

      CreateRuleRequest.Builder ruleName(String ruleName)

      The name of the rule.

      Parameters:
      ruleName - The name of the rule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • firewallType

      CreateRuleRequest.Builder firewallType(String firewallType)

      The firewall type associated with the resource.

      Parameters:
      firewallType - The firewall type associated with the resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • firewallType

      CreateRuleRequest.Builder firewallType(RuleFirewallType firewallType)

      The firewall type associated with the resource.

      Parameters:
      firewallType - The firewall type associated with the resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ruleType

      CreateRuleRequest.Builder ruleType(String ruleType)

      The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.

      Parameters:
      ruleType - The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ruleType

      CreateRuleRequest.Builder ruleType(RuleType ruleType)

      The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.

      Parameters:
      ruleType - The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ruleDescription

      CreateRuleRequest.Builder ruleDescription(String ruleDescription)

      A description of the rule.

      Parameters:
      ruleDescription - A description of the rule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configuration

      CreateRuleRequest.Builder configuration(Document configuration)

      The firewall configuration for the rule, as a JSON document. The structure depends on the rule's firewall type and rule type. For an AWS WAF INSPECTION rule, provide an AWS WAF rule group. For an AWS WAF CONFIGURATION rule, provide a single web ACL setting, such as DefaultAction or VisibilityConfig; use wafConfigDataType to declare which setting the document contains. For the schema of each setting and complete examples, see Writing rule configurations in the AWS Network Security Manager Developer Guide.

      Parameters:
      configuration - The firewall configuration for the rule, as a JSON document. The structure depends on the rule's firewall type and rule type. For an AWS WAF INSPECTION rule, provide an AWS WAF rule group. For an AWS WAF CONFIGURATION rule, provide a single web ACL setting, such as DefaultAction or VisibilityConfig; use wafConfigDataType to declare which setting the document contains. For the schema of each setting and complete examples, see Writing rule configurations in the AWS Network Security Manager Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isPublished

      CreateRuleRequest.Builder isPublished(Boolean isPublished)

      Specifies whether to publish the resource. When true, the resource is saved in published ( ACTIVE) state. When false, it is saved as a draft (DRAFT). Default: true.

      Parameters:
      isPublished - Specifies whether to publish the resource. When true, the resource is saved in published (ACTIVE) state. When false, it is saved as a draft (DRAFT). Default: true.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateRuleRequest.Builder tags(Map<String,String> tags)

      The tags to add to the resource when it is created.

      Parameters:
      tags - The tags to add to the resource when it is created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateRuleRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateRuleRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.