#[non_exhaustive]pub struct CreateFirewallRuleInput {Show 14 fields
pub creator_request_id: Option<String>,
pub firewall_rule_group_id: Option<String>,
pub firewall_domain_list_id: Option<String>,
pub priority: Option<i32>,
pub action: Option<Action>,
pub block_response: Option<BlockResponse>,
pub block_override_domain: Option<String>,
pub block_override_dns_type: Option<BlockOverrideDnsType>,
pub block_override_ttl: Option<i32>,
pub name: Option<String>,
pub firewall_domain_redirection_action: Option<FirewallDomainRedirectionAction>,
pub qtype: Option<String>,
pub dns_threat_protection: Option<DnsThreatProtection>,
pub confidence_threshold: Option<ConfidenceThreshold>,
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.creator_request_id: Option<String>
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.
firewall_rule_group_id: Option<String>
The unique identifier of the firewall rule group where you want to create the rule.
firewall_domain_list_id: Option<String>
The ID of the domain list that you want to use in the rule. Can't be used together with DnsThreatProtecton
.
priority: Option<i32>
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.
action: Option<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 Cloud Watch. -
BLOCK
- Disallow the request. This option requires additional details in the rule'sBlockResponse
.
block_response: Option<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'sBlockOverride*
settings.
This setting is required if the rule action setting is BLOCK
.
block_override_domain: Option<String>
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
.
block_override_dns_type: Option<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
.
block_override_ttl: Option<i32>
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
.
name: Option<String>
A name that lets you identify the rule in the rule group.
firewall_domain_redirection_action: Option<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.
qtype: Option<String>
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-65334, for example, TYPE28. For more information, see List of DNS record types.
dns_threat_protection: Option<DnsThreatProtection>
Use to create a DNS Firewall Advanced rule.
confidence_threshold: Option<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.
Implementations§
Source§impl CreateFirewallRuleInput
impl CreateFirewallRuleInput
Sourcepub fn creator_request_id(&self) -> Option<&str>
pub fn creator_request_id(&self) -> Option<&str>
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.
Sourcepub fn firewall_rule_group_id(&self) -> Option<&str>
pub fn firewall_rule_group_id(&self) -> Option<&str>
The unique identifier of the firewall rule group where you want to create the rule.
Sourcepub fn firewall_domain_list_id(&self) -> Option<&str>
pub fn firewall_domain_list_id(&self) -> Option<&str>
The ID of the domain list that you want to use in the rule. Can't be used together with DnsThreatProtecton
.
Sourcepub fn priority(&self) -> Option<i32>
pub fn priority(&self) -> Option<i32>
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.
Sourcepub fn action(&self) -> Option<&Action>
pub fn action(&self) -> Option<&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 Cloud Watch. -
BLOCK
- Disallow the request. This option requires additional details in the rule'sBlockResponse
.
Sourcepub fn block_response(&self) -> Option<&BlockResponse>
pub fn block_response(&self) -> Option<&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'sBlockOverride*
settings.
This setting is required if the rule action setting is BLOCK
.
Sourcepub fn block_override_domain(&self) -> Option<&str>
pub fn block_override_domain(&self) -> Option<&str>
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
.
Sourcepub fn block_override_dns_type(&self) -> Option<&BlockOverrideDnsType>
pub fn block_override_dns_type(&self) -> Option<&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
.
Sourcepub fn block_override_ttl(&self) -> Option<i32>
pub fn block_override_ttl(&self) -> Option<i32>
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
.
Sourcepub fn firewall_domain_redirection_action(
&self,
) -> Option<&FirewallDomainRedirectionAction>
pub fn firewall_domain_redirection_action( &self, ) -> Option<&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.
Sourcepub fn qtype(&self) -> Option<&str>
pub fn qtype(&self) -> Option<&str>
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-65334, for example, TYPE28. For more information, see List of DNS record types.
Sourcepub fn dns_threat_protection(&self) -> Option<&DnsThreatProtection>
pub fn dns_threat_protection(&self) -> Option<&DnsThreatProtection>
Use to create a DNS Firewall Advanced rule.
Sourcepub fn confidence_threshold(&self) -> Option<&ConfidenceThreshold>
pub fn confidence_threshold(&self) -> Option<&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.
Source§impl CreateFirewallRuleInput
impl CreateFirewallRuleInput
Sourcepub fn builder() -> CreateFirewallRuleInputBuilder
pub fn builder() -> CreateFirewallRuleInputBuilder
Creates a new builder-style object to manufacture CreateFirewallRuleInput
.
Trait Implementations§
Source§impl Clone for CreateFirewallRuleInput
impl Clone for CreateFirewallRuleInput
Source§fn clone(&self) -> CreateFirewallRuleInput
fn clone(&self) -> CreateFirewallRuleInput
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CreateFirewallRuleInput
impl Debug for CreateFirewallRuleInput
Source§impl PartialEq for CreateFirewallRuleInput
impl PartialEq for CreateFirewallRuleInput
Source§fn eq(&self, other: &CreateFirewallRuleInput) -> bool
fn eq(&self, other: &CreateFirewallRuleInput) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for CreateFirewallRuleInput
Auto Trait Implementations§
impl Freeze for CreateFirewallRuleInput
impl RefUnwindSafe for CreateFirewallRuleInput
impl Send for CreateFirewallRuleInput
impl Sync for CreateFirewallRuleInput
impl Unpin for CreateFirewallRuleInput
impl UnwindSafe for CreateFirewallRuleInput
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);