Struct aws_sdk_networkfirewall::operation::create_rule_group::builders::CreateRuleGroupFluentBuilder

pub struct CreateRuleGroupFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateRuleGroup.

Creates the specified stateless or stateful rule group, which includes the rules for network traffic inspection, a capacity setting, and tags.

You provide your rule group specification in your request using either RuleGroup or Rules.

Implementations

impl CreateRuleGroupFluentBuilder

pub fn as_input(&self) -> &CreateRuleGroupInputBuilder

Access the CreateRuleGroup as a reference.

pub async fn send( self ) -> Result<CreateRuleGroupOutput, SdkError<CreateRuleGroupError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<CreateRuleGroupOutput, CreateRuleGroupError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn rule_group_name(self, input: impl Into<String>) -> Self

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

pub fn set_rule_group_name(self, input: Option<String>) -> Self

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

pub fn get_rule_group_name(&self) -> &Option<String>

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

pub fn rule_group(self, input: RuleGroup) -> Self

An object that defines the rule group rules.

You must provide either this rule group setting or a Rules setting, but not both.

pub fn set_rule_group(self, input: Option<RuleGroup>) -> Self

An object that defines the rule group rules.

You must provide either this rule group setting or a Rules setting, but not both.

pub fn get_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.

pub fn rules(self, input: impl Into<String>) -> Self

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.

pub fn set_rules(self, input: Option<String>) -> Self

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.

pub fn get_rules(&self) -> &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.

pub fn type(self, input: RuleGroupType) -> Self

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.

pub fn set_type(self, input: Option<RuleGroupType>) -> Self

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.

pub fn get_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.

pub fn description(self, input: impl Into<String>) -> Self

A description of the rule group.

pub fn set_description(self, input: Option<String>) -> Self

A description of the rule group.

pub fn get_description(&self) -> &Option<String>

A description of the rule group.

pub fn capacity(self, input: i32) -> Self

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.

pub fn set_capacity(self, input: Option<i32>) -> Self

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.

pub fn get_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.

pub fn tags(self, input: Tag) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

The key:value pairs to associate with the resource.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

The key:value pairs to associate with the resource.

pub fn get_tags(&self) -> &Option<Vec<Tag>>

The key:value pairs to associate with the resource.

pub fn dry_run(self, input: bool) -> Self

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.

pub fn set_dry_run(self, input: Option<bool>) -> Self

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.

pub fn get_dry_run(&self) -> &Option<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.

pub fn encryption_configuration(self, input: EncryptionConfiguration) -> Self

A complex type that contains settings for encryption of your rule group resources.

pub fn set_encryption_configuration( self, input: Option<EncryptionConfiguration> ) -> Self

A complex type that contains settings for encryption of your rule group resources.

pub fn get_encryption_configuration(&self) -> &Option<EncryptionConfiguration>

A complex type that contains settings for encryption of your rule group resources.

pub fn source_metadata(self, input: SourceMetadata) -> Self

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.

pub fn set_source_metadata(self, input: Option<SourceMetadata>) -> Self

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.

pub fn get_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

impl Clone for CreateRuleGroupFluentBuilder

fn clone(&self) -> CreateRuleGroupFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateRuleGroupFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.