Package software.amazon.awssdk.services.route53resolver.model

Interface CreateFirewallRuleRequest.Builder

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

  • Method Details

    • creatorRequestId

      CreateFirewallRuleRequest.Builder creatorRequestId(String creatorRequestId)

      A unique string that identifies the request and that allows you to retry failed requests without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

      Parameters:
      creatorRequestId - A unique string that identifies the request and that allows you to retry failed requests without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • firewallRuleGroupId

      CreateFirewallRuleRequest.Builder firewallRuleGroupId(String firewallRuleGroupId)

      The unique identifier of the firewall rule group where you want to create the rule.

      Parameters:
      firewallRuleGroupId - The unique identifier of the firewall rule group where you want to create the rule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • firewallDomainListId

      CreateFirewallRuleRequest.Builder firewallDomainListId(String firewallDomainListId)

      The ID of the domain list that you want to use in the rule.

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

    • priority

      CreateFirewallRuleRequest.Builder priority(Integer priority)

      The setting that determines the processing order of the rule in the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.

      You must specify a unique priority for each rule in a rule group. To make it easier to insert rules later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for the rules in a rule group at any time.

      Parameters:
      priority - The setting that determines the processing order of the rule in the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.

      You must specify a unique priority for each rule in a rule group. To make it easier to insert rules later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for the rules in a rule group at any time.

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

    • 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 Cloud Watch.

      • 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 Cloud Watch.

      • 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(Action 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 Cloud Watch.

      • 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 Cloud Watch.

      • 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:

    • blockResponse

      CreateFirewallRuleRequest.Builder blockResponse(String blockResponse)

      The way that you want DNS Firewall to block the request, used with the rule action setting BLOCK .

      • NODATA - Respond indicating that the query was successful, but no response is available for it.

      • NXDOMAIN - Respond indicating that the domain name that's in the query doesn't exist.

      • OVERRIDE - Provide a custom override in the response. This option requires custom handling details in the rule's BlockOverride* settings.

      This setting is required if the rule action setting is BLOCK.

      Parameters:
      blockResponse - The way that you want DNS Firewall to block the request, used with the rule action setting BLOCK.

      • NODATA - Respond indicating that the query was successful, but no response is available for it.

      • NXDOMAIN - Respond indicating that the domain name that's in the query doesn't exist.

      • OVERRIDE - Provide a custom override in the response. This option requires custom handling details in the rule's BlockOverride* settings.

      This setting is required if the rule action setting is BLOCK.

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

    • blockResponse

      CreateFirewallRuleRequest.Builder blockResponse(BlockResponse blockResponse)

      The way that you want DNS Firewall to block the request, used with the rule action setting BLOCK .

      • NODATA - Respond indicating that the query was successful, but no response is available for it.

      • NXDOMAIN - Respond indicating that the domain name that's in the query doesn't exist.

      • OVERRIDE - Provide a custom override in the response. This option requires custom handling details in the rule's BlockOverride* settings.

      This setting is required if the rule action setting is BLOCK.

      Parameters:
      blockResponse - The way that you want DNS Firewall to block the request, used with the rule action setting BLOCK.

      • NODATA - Respond indicating that the query was successful, but no response is available for it.

      • NXDOMAIN - Respond indicating that the domain name that's in the query doesn't exist.

      • OVERRIDE - Provide a custom override in the response. This option requires custom handling details in the rule's BlockOverride* settings.

      This setting is required if the rule action setting is BLOCK.

      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.

    • 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(BlockOverrideDnsType 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:

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

    • name

      CreateFirewallRuleRequest.Builder name(String name)

      A name that lets you identify the rule in the rule group.

      Parameters:
      name - A name that lets you identify the rule in the rule group.
      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 you want the rule to evaluate. Allowed values are;

      • A: Returns an IPv4 address.

      • AAAA: Returns an Ipv6 address.

      • CAA: Restricts CAs that can create SSL/TLS certifications for the domain.

      • CNAME: Returns another domain name.

      • DS: Record that identifies the DNSSEC signing key of a delegated zone.

      • MX: Specifies mail servers.

      • NAPTR: Regular-expression-based rewriting of domain names.

      • NS: Authoritative name servers.

      • PTR: Maps an IP address to a domain name.

      • SOA: Start of authority record for the zone.

      • SPF: Lists the servers authorized to send emails from a domain.

      • SRV: Application specific values that identify servers.

      • TXT: Verifies email senders and application-specific values.

      Parameters:
      qtype - The DNS query type you want the rule to evaluate. Allowed values are;

      • A: Returns an IPv4 address.

      • AAAA: Returns an Ipv6 address.

      • CAA: Restricts CAs that can create SSL/TLS certifications for the domain.

      • CNAME: Returns another domain name.

      • DS: Record that identifies the DNSSEC signing key of a delegated zone.

      • MX: Specifies mail servers.

      • NAPTR: Regular-expression-based rewriting of domain names.

      • NS: Authoritative name servers.

      • PTR: Maps an IP address to a domain name.

      • SOA: Start of authority record for the zone.

      • SPF: Lists the servers authorized to send emails from a domain.

      • SRV: Application specific values that identify servers.

      • TXT: Verifies email senders and application-specific values.

      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.