aws_sdk_networkfirewall/client/

update_rule_group.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateRuleGroup`](crate::operation::update_rule_group::builders::UpdateRuleGroupFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`update_token(impl Into<String>)`](crate::operation::update_rule_group::builders::UpdateRuleGroupFluentBuilder::update_token) / [`set_update_token(Option<String>)`](crate::operation::update_rule_group::builders::UpdateRuleGroupFluentBuilder::set_update_token):<br>required: **true**<br><p>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.</p> <p>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 <code>InvalidTokenException</code>. 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.</p><br>
    ///   - [`rule_group_arn(impl Into<String>)`](crate::operation::update_rule_group::builders::UpdateRuleGroupFluentBuilder::rule_group_arn) / [`set_rule_group_arn(Option<String>)`](crate::operation::update_rule_group::builders::UpdateRuleGroupFluentBuilder::set_rule_group_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the rule group.</p> <p>You must specify the ARN or the name, and you can specify both.</p><br>
    ///   - [`rule_group_name(impl Into<String>)`](crate::operation::update_rule_group::builders::UpdateRuleGroupFluentBuilder::rule_group_name) / [`set_rule_group_name(Option<String>)`](crate::operation::update_rule_group::builders::UpdateRuleGroupFluentBuilder::set_rule_group_name):<br>required: **false**<br><p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p> <p>You must specify the ARN or the name, and you can specify both.</p><br>
    ///   - [`rule_group(RuleGroup)`](crate::operation::update_rule_group::builders::UpdateRuleGroupFluentBuilder::rule_group) / [`set_rule_group(Option<RuleGroup>)`](crate::operation::update_rule_group::builders::UpdateRuleGroupFluentBuilder::set_rule_group):<br>required: **false**<br><p>An object that defines the rule group rules.</p><note>  <p>You must provide either this rule group setting or a <code>Rules</code> setting, but not both.</p> </note><br>
    ///   - [`rules(impl Into<String>)`](crate::operation::update_rule_group::builders::UpdateRuleGroupFluentBuilder::rules) / [`set_rules(Option<String>)`](crate::operation::update_rule_group::builders::UpdateRuleGroupFluentBuilder::set_rules):<br>required: **false**<br><p>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.</p><note>  <p>You must provide either this rules setting or a populated <code>RuleGroup</code> setting, but not both.</p> </note> <p>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 <code>RuleGroup</code> object that Network Firewall has populated from your string.</p><br>
    ///   - [`r#type(RuleGroupType)`](crate::operation::update_rule_group::builders::UpdateRuleGroupFluentBuilder::type) / [`set_type(Option<RuleGroupType>)`](crate::operation::update_rule_group::builders::UpdateRuleGroupFluentBuilder::set_type):<br>required: **false**<br><p>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.</p><note>  <p>This setting is required for requests that do not include the <code>RuleGroupARN</code>.</p> </note><br>
    ///   - [`description(impl Into<String>)`](crate::operation::update_rule_group::builders::UpdateRuleGroupFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_rule_group::builders::UpdateRuleGroupFluentBuilder::set_description):<br>required: **false**<br><p>A description of the rule group.</p><br>
    ///   - [`dry_run(bool)`](crate::operation::update_rule_group::builders::UpdateRuleGroupFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::update_rule_group::builders::UpdateRuleGroupFluentBuilder::set_dry_run):<br>required: **false**<br><p>Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.</p> <p>If set to <code>TRUE</code>, 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 <code>FALSE</code>, 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.</p> <p>If set to <code>FALSE</code>, Network Firewall makes the requested changes to your resources.</p><br>
    ///   - [`encryption_configuration(EncryptionConfiguration)`](crate::operation::update_rule_group::builders::UpdateRuleGroupFluentBuilder::encryption_configuration) / [`set_encryption_configuration(Option<EncryptionConfiguration>)`](crate::operation::update_rule_group::builders::UpdateRuleGroupFluentBuilder::set_encryption_configuration):<br>required: **false**<br><p>A complex type that contains settings for encryption of your rule group resources.</p><br>
    ///   - [`source_metadata(SourceMetadata)`](crate::operation::update_rule_group::builders::UpdateRuleGroupFluentBuilder::source_metadata) / [`set_source_metadata(Option<SourceMetadata>)`](crate::operation::update_rule_group::builders::UpdateRuleGroupFluentBuilder::set_source_metadata):<br>required: **false**<br><p>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.</p><br>
    ///   - [`analyze_rule_group(bool)`](crate::operation::update_rule_group::builders::UpdateRuleGroupFluentBuilder::analyze_rule_group) / [`set_analyze_rule_group(Option<bool>)`](crate::operation::update_rule_group::builders::UpdateRuleGroupFluentBuilder::set_analyze_rule_group):<br>required: **false**<br><p>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 <code>TRUE</code>, 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 <code>DryRun</code> to <code>TRUE</code>.</p><br>
    ///   - [`summary_configuration(SummaryConfiguration)`](crate::operation::update_rule_group::builders::UpdateRuleGroupFluentBuilder::summary_configuration) / [`set_summary_configuration(Option<SummaryConfiguration>)`](crate::operation::update_rule_group::builders::UpdateRuleGroupFluentBuilder::set_summary_configuration):<br>required: **false**<br><p>Updates the selected summary configuration for a rule group.</p> <p>Changes affect subsequent responses from <code>DescribeRuleGroupSummary</code>.</p><br>
    /// - On success, responds with [`UpdateRuleGroupOutput`](crate::operation::update_rule_group::UpdateRuleGroupOutput) with field(s):
    ///   - [`update_token(String)`](crate::operation::update_rule_group::UpdateRuleGroupOutput::update_token): <p>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.</p> <p>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 <code>InvalidTokenException</code>. 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.</p>
    ///   - [`rule_group_response(Option<RuleGroupResponse>)`](crate::operation::update_rule_group::UpdateRuleGroupOutput::rule_group_response): <p>The high-level properties of a rule group. This, along with the <code>RuleGroup</code>, define the rule group. You can retrieve all objects for a rule group by calling <code>DescribeRuleGroup</code>.</p>
    /// - On failure, responds with [`SdkError<UpdateRuleGroupError>`](crate::operation::update_rule_group::UpdateRuleGroupError)
    pub fn update_rule_group(&self) -> crate::operation::update_rule_group::builders::UpdateRuleGroupFluentBuilder {
        crate::operation::update_rule_group::builders::UpdateRuleGroupFluentBuilder::new(self.handle.clone())
    }
}