Package software.amazon.awscdk.services.route53resolver

Interface CfnFirewallRuleGroup.FirewallRuleProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFirewallRuleGroup.FirewallRuleProperty.Jsii$Proxy

Enclosing class:

CfnFirewallRuleGroup

@Stability(Stable)
public static interface CfnFirewallRuleGroup.FirewallRuleProperty
extends software.amazon.jsii.JsiiSerializable

A single firewall rule in a rule group.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.route53resolver.*;
 FirewallRuleProperty firewallRuleProperty = FirewallRuleProperty.builder()
         .action("action")
         .firewallDomainListId("firewallDomainListId")
         .priority(123)
         // the properties below are optional
         .blockOverrideDnsType("blockOverrideDnsType")
         .blockOverrideDomain("blockOverrideDomain")
         .blockOverrideTtl(123)
         .blockResponse("blockResponse")
         .qtype("qtype")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-firewallrulegroup-firewallrule.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFirewallRuleGroup.FirewallRuleProperty.Builder	A builder for CfnFirewallRuleGroup.FirewallRuleProperty
static final class	CfnFirewallRuleGroup.FirewallRuleProperty.Jsii$Proxy	An implementation for CfnFirewallRuleGroup.FirewallRuleProperty

Method Summary

Modifier and Type	Method	Description
static CfnFirewallRuleGroup.FirewallRuleProperty.Builder	builder()
String	getAction()	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.
default String	getBlockOverrideDnsType()	The DNS record's type.
default String	getBlockOverrideDomain()	The custom DNS record to send back in response to the query.
default Number	getBlockOverrideTtl()	The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record.
default String	getBlockResponse()	The way that you want DNS Firewall to block the request.
String	getFirewallDomainListId()	The ID of the domain list that's used in the rule.
Number	getPriority()	The priority of the rule in the rule group.
default String	getQtype()	The DNS query type you want the rule to evaluate.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAction

@Stability(Stable)
@NotNull
String getAction()

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 to go through but send an alert to the logs.
• BLOCK - Disallow the request. If this is specified,then BlockResponse must also be specified.

if BlockResponse is OVERRIDE , then all of the following OVERRIDE attributes must be specified:

• BlockOverrideDnsType
• BlockOverrideDomain
• BlockOverrideTtl

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-firewallrulegroup-firewallrule.html#cfn-route53resolver-firewallrulegroup-firewallrule-action

getFirewallDomainListId

@Stability(Stable)
@NotNull
String getFirewallDomainListId()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-firewallrulegroup-firewallrule.html#cfn-route53resolver-firewallrulegroup-firewallrule-firewalldomainlistid

getPriority

@Stability(Stable)
@NotNull
Number getPriority()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-firewallrulegroup-firewallrule.html#cfn-route53resolver-firewallrulegroup-firewallrule-priority

getBlockOverrideDnsType

@Stability(Stable)
@Nullable
default String getBlockOverrideDnsType()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-firewallrulegroup-firewallrule.html#cfn-route53resolver-firewallrulegroup-firewallrule-blockoverridednstype

getBlockOverrideDomain

@Stability(Stable)
@Nullable
default String getBlockOverrideDomain()

The custom DNS record to send back in response to the query.

Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-firewallrulegroup-firewallrule.html#cfn-route53resolver-firewallrulegroup-firewallrule-blockoverridedomain

getBlockOverrideTtl

@Stability(Stable)
@Nullable
default Number getBlockOverrideTtl()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-firewallrulegroup-firewallrule.html#cfn-route53resolver-firewallrulegroup-firewallrule-blockoverridettl

getBlockResponse

@Stability(Stable)
@Nullable
default String getBlockResponse()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-firewallrulegroup-firewallrule.html#cfn-route53resolver-firewallrulegroup-firewallrule-blockresponse

getQtype

@Stability(Stable)
@Nullable
default String getQtype()

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 TYPE NUMBER , where the NUMBER can be 1-65334, for example, TYPE28. For more information, see List of DNS record types .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-firewallrulegroup-firewallrule.html#cfn-route53resolver-firewallrulegroup-firewallrule-qtype

builder

@Stability(Stable)
static CfnFirewallRuleGroup.FirewallRuleProperty.Builder builder()

Returns:

a CfnFirewallRuleGroup.FirewallRuleProperty.Builder of CfnFirewallRuleGroup.FirewallRuleProperty