aws_sdk_networkfirewall/client/

update_proxy_rule.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateProxyRule`](crate::operation::update_proxy_rule::builders::UpdateProxyRuleFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`proxy_rule_group_name(impl Into<String>)`](crate::operation::update_proxy_rule::builders::UpdateProxyRuleFluentBuilder::proxy_rule_group_name) / [`set_proxy_rule_group_name(Option<String>)`](crate::operation::update_proxy_rule::builders::UpdateProxyRuleFluentBuilder::set_proxy_rule_group_name):<br>required: **false**<br><p>The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.</p> <p>You must specify the ARN or the name, and you can specify both.</p><br>
    ///   - [`proxy_rule_group_arn(impl Into<String>)`](crate::operation::update_proxy_rule::builders::UpdateProxyRuleFluentBuilder::proxy_rule_group_arn) / [`set_proxy_rule_group_arn(Option<String>)`](crate::operation::update_proxy_rule::builders::UpdateProxyRuleFluentBuilder::set_proxy_rule_group_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of a proxy rule group.</p> <p>You must specify the ARN or the name, and you can specify both.</p><br>
    ///   - [`proxy_rule_name(impl Into<String>)`](crate::operation::update_proxy_rule::builders::UpdateProxyRuleFluentBuilder::proxy_rule_name) / [`set_proxy_rule_name(Option<String>)`](crate::operation::update_proxy_rule::builders::UpdateProxyRuleFluentBuilder::set_proxy_rule_name):<br>required: **true**<br><p>The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.</p><br>
    ///   - [`description(impl Into<String>)`](crate::operation::update_proxy_rule::builders::UpdateProxyRuleFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_proxy_rule::builders::UpdateProxyRuleFluentBuilder::set_description):<br>required: **false**<br><p>A description of the proxy rule.</p><br>
    ///   - [`action(ProxyRulePhaseAction)`](crate::operation::update_proxy_rule::builders::UpdateProxyRuleFluentBuilder::action) / [`set_action(Option<ProxyRulePhaseAction>)`](crate::operation::update_proxy_rule::builders::UpdateProxyRuleFluentBuilder::set_action):<br>required: **false**<br><p>Depending on the match action, the proxy either stops the evaluation (if the action is terminal - allow or deny), or continues it (if the action is alert) until it matches a rule with a terminal action.</p><br>
    ///   - [`add_conditions(ProxyRuleCondition)`](crate::operation::update_proxy_rule::builders::UpdateProxyRuleFluentBuilder::add_conditions) / [`set_add_conditions(Option<Vec::<ProxyRuleCondition>>)`](crate::operation::update_proxy_rule::builders::UpdateProxyRuleFluentBuilder::set_add_conditions):<br>required: **false**<br><p>Proxy rule conditions to add. Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.</p><br>
    ///   - [`remove_conditions(ProxyRuleCondition)`](crate::operation::update_proxy_rule::builders::UpdateProxyRuleFluentBuilder::remove_conditions) / [`set_remove_conditions(Option<Vec::<ProxyRuleCondition>>)`](crate::operation::update_proxy_rule::builders::UpdateProxyRuleFluentBuilder::set_remove_conditions):<br>required: **false**<br><p>Proxy rule conditions to remove. Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.</p><br>
    ///   - [`update_token(impl Into<String>)`](crate::operation::update_proxy_rule::builders::UpdateProxyRuleFluentBuilder::update_token) / [`set_update_token(Option<String>)`](crate::operation::update_proxy_rule::builders::UpdateProxyRuleFluentBuilder::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 proxy rule. The token marks the state of the proxy rule resource at the time of the request.</p> <p>To make changes to the proxy rule, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule 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 proxy rule 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>
    /// - On success, responds with [`UpdateProxyRuleOutput`](crate::operation::update_proxy_rule::UpdateProxyRuleOutput) with field(s):
    ///   - [`proxy_rule(Option<ProxyRule>)`](crate::operation::update_proxy_rule::UpdateProxyRuleOutput::proxy_rule): <p>The updated proxy rule resource that reflects the updates from the request.</p>
    ///   - [`removed_conditions(Option<Vec::<ProxyRuleCondition>>)`](crate::operation::update_proxy_rule::UpdateProxyRuleOutput::removed_conditions): <p>Proxy rule conditions removed from the rule.</p>
    ///   - [`update_token(Option<String>)`](crate::operation::update_proxy_rule::UpdateProxyRuleOutput::update_token): <p>A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule. The token marks the state of the proxy rule resource at the time of the request.</p> <p>To make changes to the proxy rule, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule 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 proxy rule 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>
    /// - On failure, responds with [`SdkError<UpdateProxyRuleError>`](crate::operation::update_proxy_rule::UpdateProxyRuleError)
    pub fn update_proxy_rule(&self) -> crate::operation::update_proxy_rule::builders::UpdateProxyRuleFluentBuilder {
        crate::operation::update_proxy_rule::builders::UpdateProxyRuleFluentBuilder::new(self.handle.clone())
    }
}