aws_sdk_route53globalresolver/client/
get_firewall_rule.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetFirewallRule`](crate::operation::get_firewall_rule::builders::GetFirewallRuleFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`firewall_rule_id(impl Into<String>)`](crate::operation::get_firewall_rule::builders::GetFirewallRuleFluentBuilder::firewall_rule_id) / [`set_firewall_rule_id(Option<String>)`](crate::operation::get_firewall_rule::builders::GetFirewallRuleFluentBuilder::set_firewall_rule_id):<br>required: **true**<br><p>ID of the DNS Firewall rule.</p><br>
7    /// - On success, responds with [`GetFirewallRuleOutput`](crate::operation::get_firewall_rule::GetFirewallRuleOutput) with field(s):
8    ///   - [`action(FirewallRuleAction)`](crate::operation::get_firewall_rule::GetFirewallRuleOutput::action): <p>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.</p>
9    ///   - [`block_override_dns_type(Option<BlockOverrideDnsQueryType>)`](crate::operation::get_firewall_rule::GetFirewallRuleOutput::block_override_dns_type): <p>The DNS record's type. This determines the format of the record value that you provided in <code>BlockOverrideDomain</code>. Used for the rule action <code>BLOCK</code> with a <code>BlockResponse</code> setting of <code>OVERRIDE</code>.</p>
10    ///   - [`block_override_domain(Option<String>)`](crate::operation::get_firewall_rule::GetFirewallRuleOutput::block_override_domain): <p>The custom DNS record to send back in response to the query. Used for the rule action <code>BLOCK</code> with a <code>BlockResponse</code> setting of <code>OVERRIDE</code>.</p>
11    ///   - [`block_override_ttl(Option<i32>)`](crate::operation::get_firewall_rule::GetFirewallRuleOutput::block_override_ttl): <p>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 <code>BLOCK</code> with a <code>BlockResponse</code> setting of <code>OVERRIDE</code>.</p>
12    ///   - [`block_response(Option<FirewallBlockResponse>)`](crate::operation::get_firewall_rule::GetFirewallRuleOutput::block_response): <p>The way that you want DNS Firewall to block the request. Used for the rule action setting <code>BLOCK</code>.</p>
13    ///   - [`confidence_threshold(Option<ConfidenceThreshold>)`](crate::operation::get_firewall_rule::GetFirewallRuleOutput::confidence_threshold): <p>The confidence threshold for DNS Firewall Advanced. You must provide this value when you create a DNS Firewall Advanced rule.</p>
14    ///   - [`created_at(DateTime)`](crate::operation::get_firewall_rule::GetFirewallRuleOutput::created_at): <p>The time and date the DNS Firewall rule was created.</p>
15    ///   - [`description(Option<String>)`](crate::operation::get_firewall_rule::GetFirewallRuleOutput::description): <p>The description of the DNS Firewall rule.</p>
16    ///   - [`dns_advanced_protection(Option<DnsAdvancedProtection>)`](crate::operation::get_firewall_rule::GetFirewallRuleOutput::dns_advanced_protection): <p>The type of the DNS Firewall Advanced rule. Valid values are DGA and DNS_TUNNELING.</p>
17    ///   - [`firewall_domain_list_id(Option<String>)`](crate::operation::get_firewall_rule::GetFirewallRuleOutput::firewall_domain_list_id): <p>The ID of a DNS Firewall domain list.</p>
18    ///   - [`id(String)`](crate::operation::get_firewall_rule::GetFirewallRuleOutput::id): <p>ID of the DNS Firewall rule.</p>
19    ///   - [`name(String)`](crate::operation::get_firewall_rule::GetFirewallRuleOutput::name): <p>The name of the DNS Firewall rule.</p>
20    ///   - [`priority(i64)`](crate::operation::get_firewall_rule::GetFirewallRuleOutput::priority): <p>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.</p>
21    ///   - [`dns_view_id(String)`](crate::operation::get_firewall_rule::GetFirewallRuleOutput::dns_view_id): <p>The DNS view ID the DNS Firewall is associated with.</p>
22    ///   - [`query_type(Option<String>)`](crate::operation::get_firewall_rule::GetFirewallRuleOutput::query_type): <p>The DNS query type you want the rule to evaluate.</p>
23    ///   - [`status(CrResourceStatus)`](crate::operation::get_firewall_rule::GetFirewallRuleOutput::status): <p>The operational status of the DNS Firewall rule.</p>
24    ///   - [`updated_at(DateTime)`](crate::operation::get_firewall_rule::GetFirewallRuleOutput::updated_at): <p>The date and time the DNS Firewall rule was updated.</p>
25    /// - On failure, responds with [`SdkError<GetFirewallRuleError>`](crate::operation::get_firewall_rule::GetFirewallRuleError)
26    pub fn get_firewall_rule(&self) -> crate::operation::get_firewall_rule::builders::GetFirewallRuleFluentBuilder {
27        crate::operation::get_firewall_rule::builders::GetFirewallRuleFluentBuilder::new(self.handle.clone())
28    }
29}