1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::update_rule_group::_update_rule_group_output::UpdateRuleGroupOutputBuilder;
pub use crate::operation::update_rule_group::_update_rule_group_input::UpdateRuleGroupInputBuilder;
/// Fluent builder constructing a request to `UpdateRuleGroup`.
///
/// <p>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. </p>
/// <p>To update a rule group, first call <code>DescribeRuleGroup</code> to retrieve the current <code>RuleGroup</code> object, update the object as needed, and then provide the updated object to this call. </p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct UpdateRuleGroupFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::update_rule_group::builders::UpdateRuleGroupInputBuilder,
}
impl UpdateRuleGroupFluentBuilder {
/// Creates a new `UpdateRuleGroup`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
}
}
// This function will go away in the near future. Do not rely on it.
#[doc(hidden)]
pub async fn customize_middleware(
self,
) -> ::std::result::Result<
crate::client::customize::CustomizableOperation<
crate::operation::update_rule_group::UpdateRuleGroup,
::aws_http::retry::AwsResponseRetryClassifier,
>,
::aws_smithy_http::result::SdkError<
crate::operation::update_rule_group::UpdateRuleGroupError,
>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(::aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(::aws_smithy_http::result::SdkError::construction_failure)?;
::std::result::Result::Ok(crate::client::customize::CustomizableOperation {
handle,
operation,
})
}
// This function will go away in the near future. Do not rely on it.
#[doc(hidden)]
pub async fn send_middleware(
self,
) -> ::std::result::Result<
crate::operation::update_rule_group::UpdateRuleGroupOutput,
::aws_smithy_http::result::SdkError<
crate::operation::update_rule_group::UpdateRuleGroupError,
>,
> {
let op = self
.inner
.build()
.map_err(::aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(::aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> ::std::result::Result<
crate::operation::update_rule_group::UpdateRuleGroupOutput,
::aws_smithy_http::result::SdkError<
crate::operation::update_rule_group::UpdateRuleGroupError,
>,
> {
self.send_middleware().await
}
/// Consumes 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 customize(
self,
) -> ::std::result::Result<
crate::client::customize::CustomizableOperation<
crate::operation::update_rule_group::UpdateRuleGroup,
::aws_http::retry::AwsResponseRetryClassifier,
>,
::aws_smithy_http::result::SdkError<
crate::operation::update_rule_group::UpdateRuleGroupError,
>,
> {
self.customize_middleware().await
}
/// <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>
pub fn update_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.update_token(input.into());
self
}
/// <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>
pub fn set_update_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_update_token(input);
self
}
/// <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>
pub fn rule_group_arn(
mut self,
input: impl ::std::convert::Into<::std::string::String>,
) -> Self {
self.inner = self.inner.rule_group_arn(input.into());
self
}
/// <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>
pub fn set_rule_group_arn(
mut self,
input: ::std::option::Option<::std::string::String>,
) -> Self {
self.inner = self.inner.set_rule_group_arn(input);
self
}
/// <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>
pub fn rule_group_name(
mut self,
input: impl ::std::convert::Into<::std::string::String>,
) -> Self {
self.inner = self.inner.rule_group_name(input.into());
self
}
/// <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>
pub fn set_rule_group_name(
mut self,
input: ::std::option::Option<::std::string::String>,
) -> Self {
self.inner = self.inner.set_rule_group_name(input);
self
}
/// <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>
pub fn rule_group(mut self, input: crate::types::RuleGroup) -> Self {
self.inner = self.inner.rule_group(input);
self
}
/// <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>
pub fn set_rule_group(mut self, input: ::std::option::Option<crate::types::RuleGroup>) -> Self {
self.inner = self.inner.set_rule_group(input);
self
}
/// <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>
pub fn rules(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.rules(input.into());
self
}
/// <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>
pub fn set_rules(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_rules(input);
self
}
/// <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>
pub fn r#type(mut self, input: crate::types::RuleGroupType) -> Self {
self.inner = self.inner.r#type(input);
self
}
/// <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>
pub fn set_type(mut self, input: ::std::option::Option<crate::types::RuleGroupType>) -> Self {
self.inner = self.inner.set_type(input);
self
}
/// <p>A description of the rule group. </p>
pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.description(input.into());
self
}
/// <p>A description of the rule group. </p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_description(input);
self
}
/// <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>
pub fn dry_run(mut self, input: bool) -> Self {
self.inner = self.inner.dry_run(input);
self
}
/// <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>
pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
self.inner = self.inner.set_dry_run(input);
self
}
/// <p>A complex type that contains settings for encryption of your rule group resources.</p>
pub fn encryption_configuration(
mut self,
input: crate::types::EncryptionConfiguration,
) -> Self {
self.inner = self.inner.encryption_configuration(input);
self
}
/// <p>A complex type that contains settings for encryption of your rule group resources.</p>
pub fn set_encryption_configuration(
mut self,
input: ::std::option::Option<crate::types::EncryptionConfiguration>,
) -> Self {
self.inner = self.inner.set_encryption_configuration(input);
self
}
/// <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>
pub fn source_metadata(mut self, input: crate::types::SourceMetadata) -> Self {
self.inner = self.inner.source_metadata(input);
self
}
/// <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>
pub fn set_source_metadata(
mut self,
input: ::std::option::Option<crate::types::SourceMetadata>,
) -> Self {
self.inner = self.inner.set_source_metadata(input);
self
}
}