aws_sdk_networkfirewall/client/update_proxy_rule_priorities.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`UpdateProxyRulePriorities`](crate::operation::update_proxy_rule_priorities::builders::UpdateProxyRulePrioritiesFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`proxy_rule_group_name(impl Into<String>)`](crate::operation::update_proxy_rule_priorities::builders::UpdateProxyRulePrioritiesFluentBuilder::proxy_rule_group_name) / [`set_proxy_rule_group_name(Option<String>)`](crate::operation::update_proxy_rule_priorities::builders::UpdateProxyRulePrioritiesFluentBuilder::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>
7 /// - [`proxy_rule_group_arn(impl Into<String>)`](crate::operation::update_proxy_rule_priorities::builders::UpdateProxyRulePrioritiesFluentBuilder::proxy_rule_group_arn) / [`set_proxy_rule_group_arn(Option<String>)`](crate::operation::update_proxy_rule_priorities::builders::UpdateProxyRulePrioritiesFluentBuilder::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>
8 /// - [`rule_group_request_phase(RuleGroupRequestPhase)`](crate::operation::update_proxy_rule_priorities::builders::UpdateProxyRulePrioritiesFluentBuilder::rule_group_request_phase) / [`set_rule_group_request_phase(Option<RuleGroupRequestPhase>)`](crate::operation::update_proxy_rule_priorities::builders::UpdateProxyRulePrioritiesFluentBuilder::set_rule_group_request_phase):<br>required: **true**<br><p>Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.</p><br>
9 /// - [`rules(ProxyRulePriority)`](crate::operation::update_proxy_rule_priorities::builders::UpdateProxyRulePrioritiesFluentBuilder::rules) / [`set_rules(Option<Vec::<ProxyRulePriority>>)`](crate::operation::update_proxy_rule_priorities::builders::UpdateProxyRulePrioritiesFluentBuilder::set_rules):<br>required: **true**<br><p>proxy rule resources to update to new positions.</p><br>
10 /// - [`update_token(impl Into<String>)`](crate::operation::update_proxy_rule_priorities::builders::UpdateProxyRulePrioritiesFluentBuilder::update_token) / [`set_update_token(Option<String>)`](crate::operation::update_proxy_rule_priorities::builders::UpdateProxyRulePrioritiesFluentBuilder::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 group. The token marks the state of the proxy rule group resource at the time of the request.</p> <p>To make changes to the proxy rule group, you provide the token in your request. Network Firewall uses the token to ensure that the proxy 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 proxy 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>
11 /// - On success, responds with [`UpdateProxyRulePrioritiesOutput`](crate::operation::update_proxy_rule_priorities::UpdateProxyRulePrioritiesOutput) with field(s):
12 /// - [`proxy_rule_group_name(Option<String>)`](crate::operation::update_proxy_rule_priorities::UpdateProxyRulePrioritiesOutput::proxy_rule_group_name): <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>
13 /// - [`proxy_rule_group_arn(Option<String>)`](crate::operation::update_proxy_rule_priorities::UpdateProxyRulePrioritiesOutput::proxy_rule_group_arn): <p>The Amazon Resource Name (ARN) of a proxy rule group.</p>
14 /// - [`rule_group_request_phase(Option<RuleGroupRequestPhase>)`](crate::operation::update_proxy_rule_priorities::UpdateProxyRulePrioritiesOutput::rule_group_request_phase): <p>Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.</p>
15 /// - [`rules(Option<Vec::<ProxyRulePriority>>)`](crate::operation::update_proxy_rule_priorities::UpdateProxyRulePrioritiesOutput::rules): <p>The updated proxy rule hierarchy that reflects the updates from the request.</p>
16 /// - [`update_token(Option<String>)`](crate::operation::update_proxy_rule_priorities::UpdateProxyRulePrioritiesOutput::update_token): <p>A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule group. The token marks the state of the proxy rule group resource at the time of the request.</p> <p>To make changes to the proxy rule group, you provide the token in your request. Network Firewall uses the token to ensure that the proxy 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 proxy 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>
17 /// - On failure, responds with [`SdkError<UpdateProxyRulePrioritiesError>`](crate::operation::update_proxy_rule_priorities::UpdateProxyRulePrioritiesError)
18 pub fn update_proxy_rule_priorities(&self) -> crate::operation::update_proxy_rule_priorities::builders::UpdateProxyRulePrioritiesFluentBuilder {
19 crate::operation::update_proxy_rule_priorities::builders::UpdateProxyRulePrioritiesFluentBuilder::new(self.handle.clone())
20 }
21}