Interface FirewallRule.Builder

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

  • Method Details

    • firewallRuleGroupId

      FirewallRule.Builder firewallRuleGroupId(String firewallRuleGroupId)

      The unique identifier of the Firewall rule group of the rule.

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

    • firewallDomainListId

      FirewallRule.Builder firewallDomainListId(String firewallDomainListId)

      The ID of the domain list that's used in the rule.

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

    • firewallThreatProtectionId

      FirewallRule.Builder firewallThreatProtectionId(String firewallThreatProtectionId)

      ID of the DNS Firewall Advanced rule.

      Parameters:
      firewallThreatProtectionId - ID of the DNS Firewall Advanced rule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      FirewallRule.Builder name(String name)

      The name of the rule.

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

    • priority

      FirewallRule.Builder priority(Integer priority)

      The priority of the rule in the rule group. This value must be unique within the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.

      Parameters:
      priority - The priority of the rule in the rule group. This value must be unique within 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

      FirewallRule.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 to go through but send an alert to the logs.

      • BLOCK - Disallow the request. If this is specified, additional handling details are provided in the rule's BlockResponse setting.

      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 to go through but send an alert to the logs.

      • BLOCK - Disallow the request. If this is specified, additional handling details are provided in the rule's BlockResponse setting.

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

    • action

      FirewallRule.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 to go through but send an alert to the logs.

      • BLOCK - Disallow the request. If this is specified, additional handling details are provided in the rule's BlockResponse setting.

      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 to go through but send an alert to the logs.

      • BLOCK - Disallow the request. If this is specified, additional handling details are provided in the rule's BlockResponse setting.

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

    • blockResponse

      FirewallRule.Builder blockResponse(String blockResponse)

      The way that you want DNS Firewall to block the request. Used for 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 for 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

      FirewallRule.Builder blockResponse(BlockResponse blockResponse)

      The way that you want DNS Firewall to block the request. Used for 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 for 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

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

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

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

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

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

    • creatorRequestId

      FirewallRule.Builder creatorRequestId(String creatorRequestId)

      A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of executing the operation twice. This can be any unique string, for example, a timestamp.

      Parameters:
      creatorRequestId - A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of executing the operation twice. This can be any unique string, for example, a timestamp.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creationTime

      FirewallRule.Builder creationTime(String creationTime)

      The date and time that the rule was created, in Unix time format and Coordinated Universal Time (UTC).

      Parameters:
      creationTime - The date and time that the rule was created, in Unix time format and Coordinated Universal Time (UTC).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modificationTime

      FirewallRule.Builder modificationTime(String modificationTime)

      The date and time that the rule was last modified, in Unix time format and Coordinated Universal Time (UTC).

      Parameters:
      modificationTime - The date and time that the rule was last modified, in Unix time format and Coordinated Universal Time (UTC).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • firewallDomainRedirectionAction

      FirewallRule.Builder firewallDomainRedirectionAction(String firewallDomainRedirectionAction)

      How you want the 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 domain in the redirection list to the domain list.

      Parameters:
      firewallDomainRedirectionAction - How you want the 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 domain 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

      FirewallRule.Builder firewallDomainRedirectionAction(FirewallDomainRedirectionAction firewallDomainRedirectionAction)

      How you want the 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 domain in the redirection list to the domain list.

      Parameters:
      firewallDomainRedirectionAction - How you want the 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 domain 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

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

      FirewallRule.Builder dnsThreatProtection(String dnsThreatProtection)

      The type of the DNS Firewall Advanced rule. 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.

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

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

      FirewallRule.Builder dnsThreatProtection(DnsThreatProtection dnsThreatProtection)

      The type of the DNS Firewall Advanced rule. 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.

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

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

      FirewallRule.Builder confidenceThreshold(String confidenceThreshold)

      The confidence threshold for DNS Firewall Advanced. You must provide this value when you create 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 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

      FirewallRule.Builder confidenceThreshold(ConfidenceThreshold confidenceThreshold)

      The confidence threshold for DNS Firewall Advanced. You must provide this value when you create 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 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

      FirewallRule.Builder firewallRuleType(FirewallRuleType firewallRuleType)

      The rule type configuration for the firewall rule. This is a tagged union — exactly one of its members will be populated. Possible members are:

      • FirewallAdvancedContentCategory — an AWS-managed content category (for example, VIOLENCE_AND_HATE_SPEECH).

      • FirewallAdvancedThreatCategory — an AWS-managed advanced threat category (for example, PHISHING).

      • DnsThreatProtection — a built-in DNS Firewall Advanced threat detector (DGA, DNS_TUNNELING, or DICTIONARY_DGA).

      • PartnerThreatProtection — a third-party threat feed delivered through AWS Marketplace.

      To enumerate the values supported in your account, call ListFirewallRuleTypes.

      Parameters:
      firewallRuleType - The rule type configuration for the firewall rule. This is a tagged union — exactly one of its members will be populated. Possible members are:

      • FirewallAdvancedContentCategory — an AWS-managed content category (for example, VIOLENCE_AND_HATE_SPEECH).

      • FirewallAdvancedThreatCategory — an AWS-managed advanced threat category (for example, PHISHING).

      • DnsThreatProtection — a built-in DNS Firewall Advanced threat detector (DGA, DNS_TUNNELING, or DICTIONARY_DGA).

      • PartnerThreatProtection — a third-party threat feed delivered through AWS Marketplace.

      To enumerate the values supported in your account, call ListFirewallRuleTypes.

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

    • firewallRuleType

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

      The rule type configuration for the firewall rule. This is a tagged union — exactly one of its members will be populated. Possible members are:

      • FirewallAdvancedContentCategory — an AWS-managed content category (for example, VIOLENCE_AND_HATE_SPEECH).

      • FirewallAdvancedThreatCategory — an AWS-managed advanced threat category (for example, PHISHING).

      • DnsThreatProtection — a built-in DNS Firewall Advanced threat detector (DGA, DNS_TUNNELING, or DICTIONARY_DGA).

      • PartnerThreatProtection — a third-party threat feed delivered through AWS Marketplace.

      To enumerate the values supported in your account, call ListFirewallRuleTypes.

      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:

    • status

      FirewallRule.Builder status(String status)

      The lifecycle state of the firewall rule. Possible values:

      • CREATING — DNS Firewall is provisioning the rule. Rules created with the PartnerThreatProtection rule type begin in this state while DNS Firewall verifies the calling account's AWS Marketplace entitlement.

      • COMPLETE — The rule is provisioned and enforcing matches.

      • CREATION_FAILED — Provisioning failed. StatusMessage contains a human-readable reason. A rule in this state is immutable: UpdateFirewallRule rejects the request, and the rule must be removed with DeleteFirewallRule.

      For rules that do not require asynchronous provisioning, this field may be absent.

      Parameters:
      status - The lifecycle state of the firewall rule. Possible values:

      • CREATING — DNS Firewall is provisioning the rule. Rules created with the PartnerThreatProtection rule type begin in this state while DNS Firewall verifies the calling account's AWS Marketplace entitlement.

      • COMPLETE — The rule is provisioned and enforcing matches.

      • CREATION_FAILED — Provisioning failed. StatusMessage contains a human-readable reason. A rule in this state is immutable: UpdateFirewallRule rejects the request, and the rule must be removed with DeleteFirewallRule.

      For rules that do not require asynchronous provisioning, this field may be absent.

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

    • statusMessage

      FirewallRule.Builder statusMessage(String statusMessage)

      An additional message about the rule's lifecycle state. Populated when Status is CREATION_FAILED to describe why provisioning failed.

      Parameters:
      statusMessage - An additional message about the rule's lifecycle state. Populated when Status is CREATION_FAILED to describe why provisioning failed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.