Struct UpdateRuleGroupInput

#[non_exhaustive]
pub struct UpdateRuleGroupInput {
    pub update_token: Option<String>,
    pub rule_group_arn: Option<String>,
    pub rule_group_name: Option<String>,
    pub rule_group: Option<RuleGroup>,
    pub rules: Option<String>,
    pub type: Option<RuleGroupType>,
    pub description: Option<String>,
    pub dry_run: Option<bool>,
    pub encryption_configuration: Option<EncryptionConfiguration>,
    pub source_metadata: Option<SourceMetadata>,
    pub analyze_rule_group: Option<bool>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

update_token: Option<String>

A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.

To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

rule_group_arn: Option<String>

The Amazon Resource Name (ARN) of the rule group.

You must specify the ARN or the name, and you can specify both.

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.

You must specify the ARN or the name, and you can specify both.

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.

This setting is required for requests that do not include the RuleGroupARN.

description: Option<String>

A description of the rule group.

dry_run: 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.

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.

analyze_rule_group: Option<bool>

Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to TRUE, Network Firewall runs the analysis and then updates the rule group for you. To run the stateless rule group analyzer without updating the rule group, set DryRun to TRUE.

Implementations

impl UpdateRuleGroupInput

pub fn update_token(&self) -> Option<&str>

A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.

To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

pub fn rule_group_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the rule group.

You must specify the ARN or the name, and you can specify both.

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.

You must specify the ARN or the name, and you can specify both.

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.

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.

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.

This setting is required for requests that do not include the RuleGroupARN.

pub fn description(&self) -> Option<&str>

A description of the rule group.

pub fn 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) -> Option<&EncryptionConfiguration>

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

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.

pub fn analyze_rule_group(&self) -> Option<bool>

Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to TRUE, Network Firewall runs the analysis and then updates the rule group for you. To run the stateless rule group analyzer without updating the rule group, set DryRun to TRUE.

impl UpdateRuleGroupInput

pub fn builder() -> UpdateRuleGroupInputBuilder

Creates a new builder-style object to manufacture UpdateRuleGroupInput.

Trait Implementations

impl Clone for UpdateRuleGroupInput

fn clone(&self) -> UpdateRuleGroupInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateRuleGroupInput

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

Formats the value using the given formatter.

impl PartialEq for UpdateRuleGroupInput

fn eq(&self, other: &UpdateRuleGroupInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UpdateRuleGroupInput