Struct aws_sdk_networkfirewall::client::fluent_builders::UpdateRuleGroup

pub struct UpdateRuleGroup { /* private fields */ }

Fluent builder constructing a request to UpdateRuleGroup.

Updates the rule settings for the specified rule group. You use a rule group by reference in one or more firewall policies. When you modify a rule group, you modify all firewall policies that use the rule group.

To update a rule group, first call DescribeRuleGroup to retrieve the current RuleGroup object, update the object as needed, and then provide the updated object to this call.

Implementations

impl UpdateRuleGroup

pub async fn customize(
    self
) -> Result<CustomizableOperation<UpdateRuleGroup, AwsResponseRetryClassifier>, SdkError<UpdateRuleGroupError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<UpdateRuleGroupOutput, SdkError<UpdateRuleGroupError>>

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 update_token(self, input: impl Into<String>) -> Self

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 set_update_token(self, input: Option<String>) -> Self

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, input: impl Into<String>) -> Self

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

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

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

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, 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.

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

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.

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

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

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

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.

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

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

Trait Implementations

impl Clone for UpdateRuleGroup

fn clone(&self) -> UpdateRuleGroup

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateRuleGroup

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

Formats the value using the given formatter.