Interface CreateFirewallRuleRequest.Builder

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

  • Method Details

    • action

      CreateFirewallRuleRequest.Builder action(String action)

      The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:

      • ALLOW - Permit the request to go through.

      • ALERT - Permit the request and send metrics and logs to CloudWatch.

      • BLOCK - Disallow the request. This option requires additional details in the rule's BlockResponse.

      Parameters:
      action - The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:

      • ALLOW - Permit the request to go through.

      • ALERT - Permit the request and send metrics and logs to CloudWatch.

      • BLOCK - Disallow the request. This option requires additional details in the rule's BlockResponse.

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

    • action

      CreateFirewallRuleRequest.Builder action(FirewallRuleAction action)

      The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:

      • ALLOW - Permit the request to go through.

      • ALERT - Permit the request and send metrics and logs to CloudWatch.

      • BLOCK - Disallow the request. This option requires additional details in the rule's BlockResponse.

      Parameters:
      action - The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:

      • ALLOW - Permit the request to go through.

      • ALERT - Permit the request and send metrics and logs to CloudWatch.

      • BLOCK - Disallow the request. This option requires additional details in the rule's BlockResponse.

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

    • blockOverrideDnsType

      CreateFirewallRuleRequest.Builder blockOverrideDnsType(String blockOverrideDnsType)

      The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

      This setting is required if the BlockResponse setting is OVERRIDE.

      Parameters:
      blockOverrideDnsType - The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

      This setting is required if the BlockResponse setting is OVERRIDE.

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

    • blockOverrideDnsType

      CreateFirewallRuleRequest.Builder blockOverrideDnsType(BlockOverrideDnsQueryType blockOverrideDnsType)

      The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

      This setting is required if the BlockResponse setting is OVERRIDE.

      Parameters:
      blockOverrideDnsType - The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

      This setting is required if the BlockResponse setting is OVERRIDE.

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

    • blockOverrideDomain

      CreateFirewallRuleRequest.Builder blockOverrideDomain(String blockOverrideDomain)

      The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

      This setting is required if the BlockResponse setting is OVERRIDE.

      Parameters:
      blockOverrideDomain - The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

      This setting is required if the BlockResponse setting is OVERRIDE.

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

    • blockOverrideTtl

      CreateFirewallRuleRequest.Builder blockOverrideTtl(Integer blockOverrideTtl)

      The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

      This setting is required if the BlockResponse setting is OVERRIDE.

      Parameters:
      blockOverrideTtl - The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

      This setting is required if the BlockResponse setting is OVERRIDE.

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

    • blockResponse

      CreateFirewallRuleRequest.Builder blockResponse(String blockResponse)

      The response to return when the action is BLOCK. Valid values are NXDOMAIN (domain does not exist), NODATA (domain exists but no records), or OVERRIDE (return custom response).

      Parameters:
      blockResponse - The response to return when the action is BLOCK. Valid values are NXDOMAIN (domain does not exist), NODATA (domain exists but no records), or OVERRIDE (return custom response).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • blockResponse

      CreateFirewallRuleRequest.Builder blockResponse(FirewallBlockResponse blockResponse)

      The response to return when the action is BLOCK. Valid values are NXDOMAIN (domain does not exist), NODATA (domain exists but no records), or OVERRIDE (return custom response).

      Parameters:
      blockResponse - The response to return when the action is BLOCK. Valid values are NXDOMAIN (domain does not exist), NODATA (domain exists but no records), or OVERRIDE (return custom response).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientToken

      CreateFirewallRuleRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier to ensure idempotency. This means that making the same request multiple times with the same clientToken has the same result every time.

      Parameters:
      clientToken - A unique, case-sensitive identifier to ensure idempotency. This means that making the same request multiple times with the same clientToken has the same result every time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • confidenceThreshold

      CreateFirewallRuleRequest.Builder confidenceThreshold(String confidenceThreshold)

      The confidence threshold for advanced threat detection. Valid values are HIGH, MEDIUM, or LOW, indicating the accuracy level required for threat detection.

      Parameters:
      confidenceThreshold - The confidence threshold for advanced threat detection. Valid values are HIGH, MEDIUM, or LOW, indicating the accuracy level required for threat detection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • confidenceThreshold

      CreateFirewallRuleRequest.Builder confidenceThreshold(ConfidenceThreshold confidenceThreshold)

      The confidence threshold for advanced threat detection. Valid values are HIGH, MEDIUM, or LOW, indicating the accuracy level required for threat detection.

      Parameters:
      confidenceThreshold - The confidence threshold for advanced threat detection. Valid values are HIGH, MEDIUM, or LOW, indicating the accuracy level required for threat detection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • description

      CreateFirewallRuleRequest.Builder description(String description)

      An optional description for the firewall rule.

      Parameters:
      description - An optional description for the firewall rule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dnsAdvancedProtection

      CreateFirewallRuleRequest.Builder dnsAdvancedProtection(String dnsAdvancedProtection)

      Whether to enable advanced DNS threat protection for this rule. Advanced protection can detect and block DNS tunneling and Domain Generation Algorithm (DGA) threats.

      Parameters:
      dnsAdvancedProtection - Whether to enable advanced DNS threat protection for this rule. Advanced protection can detect and block DNS tunneling and Domain Generation Algorithm (DGA) threats.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dnsAdvancedProtection

      CreateFirewallRuleRequest.Builder dnsAdvancedProtection(DnsAdvancedProtection dnsAdvancedProtection)

      Whether to enable advanced DNS threat protection for this rule. Advanced protection can detect and block DNS tunneling and Domain Generation Algorithm (DGA) threats.

      Parameters:
      dnsAdvancedProtection - Whether to enable advanced DNS threat protection for this rule. Advanced protection can detect and block DNS tunneling and Domain Generation Algorithm (DGA) threats.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • firewallDomainListId

      CreateFirewallRuleRequest.Builder firewallDomainListId(String firewallDomainListId)

      The ID of the firewall domain list to use in this rule.

      Parameters:
      firewallDomainListId - The ID of the firewall domain list to use in this rule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      CreateFirewallRuleRequest.Builder name(String name)

      A descriptive name for the firewall rule.

      Parameters:
      name - A descriptive name for the firewall rule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • priority

      CreateFirewallRuleRequest.Builder priority(Long priority)

      The priority of this rule. Rules are evaluated in priority order, with lower numbers having higher priority. When a DNS query matches multiple rules, the rule with the highest priority (lowest number) is applied.

      Parameters:
      priority - The priority of this rule. Rules are evaluated in priority order, with lower numbers having higher priority. When a DNS query matches multiple rules, the rule with the highest priority (lowest number) is applied.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dnsViewId

      CreateFirewallRuleRequest.Builder dnsViewId(String dnsViewId)

      The ID of the DNS view to associate with this firewall rule.

      Parameters:
      dnsViewId - The ID of the DNS view to associate with this firewall rule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • qType

      CreateFirewallRuleRequest.Builder qType(String qType)

      The DNS query type to match for this rule. Examples include A (IPv4 address), AAAA (IPv6 address), MX (mail exchange), or TXT (text record).

      Parameters:
      qType - The DNS query type to match for this rule. Examples include A (IPv4 address), AAAA (IPv6 address), MX (mail exchange), or TXT (text record).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateFirewallRuleRequest.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

      CreateFirewallRuleRequest.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.