Interface CreateFirewallRuleEntry.Builder

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

  • Method Details

    • creatorRequestId

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

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

      CreateFirewallRuleEntry.Builder firewallDomainListId(String firewallDomainListId)

      The ID of the domain list that you want to use in the rule. This setting is mutually exclusive with DnsThreatProtection and FirewallRuleType.

      Parameters:
      firewallDomainListId - The ID of the domain list that you want to use in the rule. This setting is mutually exclusive with DnsThreatProtection and FirewallRuleType.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • priority

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

      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • action

      CreateFirewallRuleEntry.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, or a threat in a DNS Firewall Advanced rule:

      • ALLOW - Permit the request to go through. Not available for DNS Firewall Advanced rules.

      • 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, or a threat in a DNS Firewall Advanced rule:

      • ALLOW - Permit the request to go through. Not available for DNS Firewall Advanced rules.

      • 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

      CreateFirewallRuleEntry.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, or a threat in a DNS Firewall Advanced rule:

      • ALLOW - Permit the request to go through. Not available for DNS Firewall Advanced rules.

      • 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, or a threat in a DNS Firewall Advanced rule:

      • ALLOW - Permit the request to go through. Not available for DNS Firewall Advanced rules.

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

    • blockResponse

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

      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.

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

    • blockResponse

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

      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.

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

    • blockOverrideDomain

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

      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • blockOverrideDnsType

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

      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • blockOverrideDnsType

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

      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • blockOverrideTtl

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

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

    • firewallDomainRedirectionAction

      CreateFirewallRuleEntry.Builder firewallDomainRedirectionAction(String firewallDomainRedirectionAction)

      How you want the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME.

      INSPECT_REDIRECTION_DOMAIN: (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the domain list.

      TRUST_REDIRECTION_DOMAIN: Inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the redirection list to the domain list.

      Parameters:
      firewallDomainRedirectionAction - How you want the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME.

      INSPECT_REDIRECTION_DOMAIN: (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the domain list.

      TRUST_REDIRECTION_DOMAIN: Inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the redirection list to the domain list.

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

    • firewallDomainRedirectionAction

      CreateFirewallRuleEntry.Builder firewallDomainRedirectionAction(FirewallDomainRedirectionAction firewallDomainRedirectionAction)

      How you want the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME.

      INSPECT_REDIRECTION_DOMAIN: (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the domain list.

      TRUST_REDIRECTION_DOMAIN: Inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the redirection list to the domain list.

      Parameters:
      firewallDomainRedirectionAction - How you want the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME.

      INSPECT_REDIRECTION_DOMAIN: (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the domain list.

      TRUST_REDIRECTION_DOMAIN: Inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the redirection list to the domain list.

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

    • qtype

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

      • A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be 1-65534, for example, TYPE28. For more information, see List of DNS record types.

      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.

      • A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be 1-65534, for example, TYPE28. For more information, see List of DNS record types.

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

    • dnsThreatProtection

      CreateFirewallRuleEntry.Builder dnsThreatProtection(String dnsThreatProtection)

      The type of the DNS Firewall Advanced rule. This setting is mutually exclusive with FirewallDomainListId and FirewallRuleType. Valid values are:

      • DGA: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains to launch malware attacks.

      • DNS_TUNNELING: DNS tunneling detection. DNS tunneling is used by attackers to exfiltrate data from the client by using the DNS tunnel without making a network connection to the client.

      • DICT_DGA: Dictionary-based domain generation algorithms detection. Dictionary DGAs use wordlists to generate domains that appear more legitimate, making them harder to detect than traditional DGAs.

      Parameters:
      dnsThreatProtection - The type of the DNS Firewall Advanced rule. This setting is mutually exclusive with FirewallDomainListId and FirewallRuleType. Valid values are:

      • DGA: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains to launch malware attacks.

      • DNS_TUNNELING: DNS tunneling detection. DNS tunneling is used by attackers to exfiltrate data from the client by using the DNS tunnel without making a network connection to the client.

      • DICT_DGA: Dictionary-based domain generation algorithms detection. Dictionary DGAs use wordlists to generate domains that appear more legitimate, making them harder to detect than traditional DGAs.

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

    • dnsThreatProtection

      CreateFirewallRuleEntry.Builder dnsThreatProtection(DnsThreatProtection dnsThreatProtection)

      The type of the DNS Firewall Advanced rule. This setting is mutually exclusive with FirewallDomainListId and FirewallRuleType. Valid values are:

      • DGA: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains to launch malware attacks.

      • DNS_TUNNELING: DNS tunneling detection. DNS tunneling is used by attackers to exfiltrate data from the client by using the DNS tunnel without making a network connection to the client.

      • DICT_DGA: Dictionary-based domain generation algorithms detection. Dictionary DGAs use wordlists to generate domains that appear more legitimate, making them harder to detect than traditional DGAs.

      Parameters:
      dnsThreatProtection - The type of the DNS Firewall Advanced rule. This setting is mutually exclusive with FirewallDomainListId and FirewallRuleType. Valid values are:

      • DGA: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains to launch malware attacks.

      • DNS_TUNNELING: DNS tunneling detection. DNS tunneling is used by attackers to exfiltrate data from the client by using the DNS tunnel without making a network connection to the client.

      • DICT_DGA: Dictionary-based domain generation algorithms detection. Dictionary DGAs use wordlists to generate domains that appear more legitimate, making them harder to detect than traditional DGAs.

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

    • confidenceThreshold

      CreateFirewallRuleEntry.Builder confidenceThreshold(String confidenceThreshold)

      The confidence threshold for DNS Firewall Advanced. You must provide this value when you create or update a DNS Firewall Advanced rule. The confidence level values mean:

      • LOW: Provides the highest detection rate for threats, but also increases false positives.

      • MEDIUM: Provides a balance between detecting threats and false positives.

      • HIGH: Detects only the most well corroborated threats with a low rate of false positives.

      Parameters:
      confidenceThreshold - The confidence threshold for DNS Firewall Advanced. You must provide this value when you create or update a DNS Firewall Advanced rule. The confidence level values mean:

      • LOW: Provides the highest detection rate for threats, but also increases false positives.

      • MEDIUM: Provides a balance between detecting threats and false positives.

      • HIGH: Detects only the most well corroborated threats with a low rate of false positives.

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

    • confidenceThreshold

      CreateFirewallRuleEntry.Builder confidenceThreshold(ConfidenceThreshold confidenceThreshold)

      The confidence threshold for DNS Firewall Advanced. You must provide this value when you create or update a DNS Firewall Advanced rule. The confidence level values mean:

      • LOW: Provides the highest detection rate for threats, but also increases false positives.

      • MEDIUM: Provides a balance between detecting threats and false positives.

      • HIGH: Detects only the most well corroborated threats with a low rate of false positives.

      Parameters:
      confidenceThreshold - The confidence threshold for DNS Firewall Advanced. You must provide this value when you create or update a DNS Firewall Advanced rule. The confidence level values mean:

      • LOW: Provides the highest detection rate for threats, but also increases false positives.

      • MEDIUM: Provides a balance between detecting threats and false positives.

      • HIGH: Detects only the most well corroborated threats with a low rate of false positives.

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

    • firewallRuleType

      CreateFirewallRuleEntry.Builder firewallRuleType(FirewallRuleType firewallRuleType)

      The rule type configuration for the firewall rule. This setting is mutually exclusive with the top-level FirewallDomainListId and DnsThreatProtection fields.

      Parameters:
      firewallRuleType - The rule type configuration for the firewall rule. This setting is mutually exclusive with the top-level FirewallDomainListId and DnsThreatProtection fields.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • firewallRuleType

      default CreateFirewallRuleEntry.Builder firewallRuleType(Consumer<FirewallRuleType.Builder> firewallRuleType)

      The rule type configuration for the firewall rule. This setting is mutually exclusive with the top-level FirewallDomainListId and DnsThreatProtection fields.

      This is a convenience method that creates an instance of the FirewallRuleType.Builder avoiding the need to create one manually via FirewallRuleType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to firewallRuleType(FirewallRuleType).

      Parameters:
      firewallRuleType - a consumer that will call methods on FirewallRuleType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: