#[non_exhaustive]pub struct CreateRuleGroupInput {
pub rule_group_name: Option<String>,
pub rule_group: Option<RuleGroup>,
pub rules: Option<String>,
pub type: Option<RuleGroupType>,
pub description: Option<String>,
pub capacity: Option<i32>,
pub tags: Option<Vec<Tag>>,
pub dry_run: bool,
pub encryption_configuration: Option<EncryptionConfiguration>,
pub source_metadata: Option<SourceMetadata>,
}
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.rule_group_name: Option<String>
The descriptive name of the rule group. You can't change the name of a rule group after you create it.
rule_group: Option<RuleGroup>
An object that defines the rule group rules.
You must provide either this rule group setting or a Rules
setting, but not both.
rules: Option<String>
A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.
You must provide either this rules setting or a populated RuleGroup
setting, but not both.
You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a RuleGroup
object that Network Firewall has populated from your string.
type: Option<RuleGroupType>
Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.
description: Option<String>
A description of the rule group.
capacity: Option<i32>
The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.
You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup
with DryRun
set to TRUE
.
You can't change or exceed this capacity when you update the rule group, so leave room for your rule group to grow.
Capacity for a stateless rule group
For a stateless rule group, the capacity required is the sum of the capacity requirements of the individual rules that you expect to have in the rule group.
To calculate the capacity requirement of a single rule, multiply the capacity requirement values of each of the rule's match settings:
-
A match setting with no criteria specified has a value of 1.
-
A match setting with
Any
specified has a value of 1. -
All other match settings have a value equal to the number of elements provided in the setting. For example, a protocol setting ["UDP"] and a source setting ["10.0.0.0/24"] each have a value of 1. A protocol setting ["UDP","TCP"] has a value of 2. A source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"] has a value of 3.
A rule with no criteria specified in any of its match settings has a capacity requirement of 1. A rule with protocol setting ["UDP","TCP"], source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"], and a single specification or no specification for each of the other match settings has a capacity requirement of 6.
Capacity for a stateful rule group
For a stateful rule group, the minimum capacity required is the number of individual rules that you expect to have in the rule group.
The key:value pairs to associate with the resource.
dry_run: bool
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
If set to TRUE
, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE
, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.
If set to FALSE
, Network Firewall makes the requested changes to your resources.
encryption_configuration: Option<EncryptionConfiguration>
A complex type that contains settings for encryption of your rule group resources.
source_metadata: Option<SourceMetadata>
A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.
Implementations
sourceimpl CreateRuleGroupInput
impl CreateRuleGroupInput
sourcepub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CreateRuleGroup, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CreateRuleGroup, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<CreateRuleGroup
>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture CreateRuleGroupInput
sourceimpl CreateRuleGroupInput
impl CreateRuleGroupInput
sourcepub fn rule_group_name(&self) -> Option<&str>
pub fn rule_group_name(&self) -> Option<&str>
The descriptive name of the rule group. You can't change the name of a rule group after you create it.
sourcepub fn rule_group(&self) -> Option<&RuleGroup>
pub fn rule_group(&self) -> Option<&RuleGroup>
An object that defines the rule group rules.
You must provide either this rule group setting or a Rules
setting, but not both.
sourcepub fn rules(&self) -> Option<&str>
pub fn rules(&self) -> Option<&str>
A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.
You must provide either this rules setting or a populated RuleGroup
setting, but not both.
You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a RuleGroup
object that Network Firewall has populated from your string.
sourcepub fn type(&self) -> Option<&RuleGroupType>
pub fn type(&self) -> Option<&RuleGroupType>
Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.
sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A description of the rule group.
sourcepub fn capacity(&self) -> Option<i32>
pub fn capacity(&self) -> Option<i32>
The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.
You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup
with DryRun
set to TRUE
.
You can't change or exceed this capacity when you update the rule group, so leave room for your rule group to grow.
Capacity for a stateless rule group
For a stateless rule group, the capacity required is the sum of the capacity requirements of the individual rules that you expect to have in the rule group.
To calculate the capacity requirement of a single rule, multiply the capacity requirement values of each of the rule's match settings:
-
A match setting with no criteria specified has a value of 1.
-
A match setting with
Any
specified has a value of 1. -
All other match settings have a value equal to the number of elements provided in the setting. For example, a protocol setting ["UDP"] and a source setting ["10.0.0.0/24"] each have a value of 1. A protocol setting ["UDP","TCP"] has a value of 2. A source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"] has a value of 3.
A rule with no criteria specified in any of its match settings has a capacity requirement of 1. A rule with protocol setting ["UDP","TCP"], source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"], and a single specification or no specification for each of the other match settings has a capacity requirement of 6.
Capacity for a stateful rule group
For a stateful rule group, the minimum capacity required is the number of individual rules that you expect to have in the rule group.
The key:value pairs to associate with the resource.
sourcepub fn dry_run(&self) -> bool
pub fn dry_run(&self) -> bool
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
If set to TRUE
, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE
, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.
If set to FALSE
, Network Firewall makes the requested changes to your resources.
sourcepub fn encryption_configuration(&self) -> Option<&EncryptionConfiguration>
pub fn encryption_configuration(&self) -> Option<&EncryptionConfiguration>
A complex type that contains settings for encryption of your rule group resources.
sourcepub fn source_metadata(&self) -> Option<&SourceMetadata>
pub fn source_metadata(&self) -> Option<&SourceMetadata>
A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.
Trait Implementations
sourceimpl Clone for CreateRuleGroupInput
impl Clone for CreateRuleGroupInput
sourcefn clone(&self) -> CreateRuleGroupInput
fn clone(&self) -> CreateRuleGroupInput
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for CreateRuleGroupInput
impl Debug for CreateRuleGroupInput
sourceimpl PartialEq<CreateRuleGroupInput> for CreateRuleGroupInput
impl PartialEq<CreateRuleGroupInput> for CreateRuleGroupInput
sourcefn eq(&self, other: &CreateRuleGroupInput) -> bool
fn eq(&self, other: &CreateRuleGroupInput) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &CreateRuleGroupInput) -> bool
fn ne(&self, other: &CreateRuleGroupInput) -> bool
This method tests for !=
.
impl StructuralPartialEq for CreateRuleGroupInput
Auto Trait Implementations
impl RefUnwindSafe for CreateRuleGroupInput
impl Send for CreateRuleGroupInput
impl Sync for CreateRuleGroupInput
impl Unpin for CreateRuleGroupInput
impl UnwindSafe for CreateRuleGroupInput
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more