// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct UpdateRuleGroupInput {
/// <p>The name of the rule group. You cannot change the name of a rule group after you create it.</p>
pub name: ::std::option::Option<::std::string::String>,
/// <p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use <code>CLOUDFRONT</code>.</p>
/// <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:</p>
/// <ul>
/// <li>
/// <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>.</p></li>
/// <li>
/// <p>API and SDKs - For all calls, use the Region endpoint us-east-1.</p></li>
/// </ul>
pub scope: ::std::option::Option<crate::types::Scope>,
/// <p>A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.</p>
pub id: ::std::option::Option<::std::string::String>,
/// <p>A description of the rule group that helps with identification.</p>
pub description: ::std::option::Option<::std::string::String>,
/// <p>The <code>Rule</code> statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.</p>
pub rules: ::std::option::Option<::std::vec::Vec<crate::types::Rule>>,
/// <p>Defines and enables Amazon CloudWatch metrics and web request sample collection.</p>
pub visibility_config: ::std::option::Option<crate::types::VisibilityConfig>,
/// <p>A token used for optimistic locking. WAF returns a token to your <code>get</code> and <code>list</code> requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like <code>update</code> and <code>delete</code>. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a <code>WAFOptimisticLockException</code>. If this happens, perform another <code>get</code>, and use the new token returned by that operation.</p>
pub lock_token: ::std::option::Option<::std::string::String>,
/// <p>A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.</p>
/// <p>For information about customizing web requests and responses, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html">Customizing web requests and responses in WAF</a> in the <i>WAF Developer Guide</i>.</p>
/// <p>For information about the limits on count and size for custom request and response settings, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/limits.html">WAF quotas</a> in the <i>WAF Developer Guide</i>.</p>
pub custom_response_bodies: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::CustomResponseBody>>,
/// <p>The monetization configuration for the rule group. Provide this when any rule in the rule group uses the <code>Monetize</code> action.</p>
pub monetization_config: ::std::option::Option<crate::types::MonetizationConfig>,
}
impl UpdateRuleGroupInput {
/// <p>The name of the rule group. You cannot change the name of a rule group after you create it.</p>
pub fn name(&self) -> ::std::option::Option<&str> {
self.name.as_deref()
}
/// <p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use <code>CLOUDFRONT</code>.</p>
/// <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:</p>
/// <ul>
/// <li>
/// <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>.</p></li>
/// <li>
/// <p>API and SDKs - For all calls, use the Region endpoint us-east-1.</p></li>
/// </ul>
pub fn scope(&self) -> ::std::option::Option<&crate::types::Scope> {
self.scope.as_ref()
}
/// <p>A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.</p>
pub fn id(&self) -> ::std::option::Option<&str> {
self.id.as_deref()
}
/// <p>A description of the rule group that helps with identification.</p>
pub fn description(&self) -> ::std::option::Option<&str> {
self.description.as_deref()
}
/// <p>The <code>Rule</code> statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.rules.is_none()`.
pub fn rules(&self) -> &[crate::types::Rule] {
self.rules.as_deref().unwrap_or_default()
}
/// <p>Defines and enables Amazon CloudWatch metrics and web request sample collection.</p>
pub fn visibility_config(&self) -> ::std::option::Option<&crate::types::VisibilityConfig> {
self.visibility_config.as_ref()
}
/// <p>A token used for optimistic locking. WAF returns a token to your <code>get</code> and <code>list</code> requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like <code>update</code> and <code>delete</code>. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a <code>WAFOptimisticLockException</code>. If this happens, perform another <code>get</code>, and use the new token returned by that operation.</p>
pub fn lock_token(&self) -> ::std::option::Option<&str> {
self.lock_token.as_deref()
}
/// <p>A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.</p>
/// <p>For information about customizing web requests and responses, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html">Customizing web requests and responses in WAF</a> in the <i>WAF Developer Guide</i>.</p>
/// <p>For information about the limits on count and size for custom request and response settings, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/limits.html">WAF quotas</a> in the <i>WAF Developer Guide</i>.</p>
pub fn custom_response_bodies(
&self,
) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, crate::types::CustomResponseBody>> {
self.custom_response_bodies.as_ref()
}
/// <p>The monetization configuration for the rule group. Provide this when any rule in the rule group uses the <code>Monetize</code> action.</p>
pub fn monetization_config(&self) -> ::std::option::Option<&crate::types::MonetizationConfig> {
self.monetization_config.as_ref()
}
}
impl UpdateRuleGroupInput {
/// Creates a new builder-style object to manufacture [`UpdateRuleGroupInput`](crate::operation::update_rule_group::UpdateRuleGroupInput).
pub fn builder() -> crate::operation::update_rule_group::builders::UpdateRuleGroupInputBuilder {
crate::operation::update_rule_group::builders::UpdateRuleGroupInputBuilder::default()
}
}
/// A builder for [`UpdateRuleGroupInput`](crate::operation::update_rule_group::UpdateRuleGroupInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct UpdateRuleGroupInputBuilder {
pub(crate) name: ::std::option::Option<::std::string::String>,
pub(crate) scope: ::std::option::Option<crate::types::Scope>,
pub(crate) id: ::std::option::Option<::std::string::String>,
pub(crate) description: ::std::option::Option<::std::string::String>,
pub(crate) rules: ::std::option::Option<::std::vec::Vec<crate::types::Rule>>,
pub(crate) visibility_config: ::std::option::Option<crate::types::VisibilityConfig>,
pub(crate) lock_token: ::std::option::Option<::std::string::String>,
pub(crate) custom_response_bodies: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::CustomResponseBody>>,
pub(crate) monetization_config: ::std::option::Option<crate::types::MonetizationConfig>,
}
impl UpdateRuleGroupInputBuilder {
/// <p>The name of the rule group. You cannot change the name of a rule group after you create it.</p>
/// This field is required.
pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the rule group. You cannot change the name of a rule group after you create it.</p>
pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.name = input;
self
}
/// <p>The name of the rule group. You cannot change the name of a rule group after you create it.</p>
pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
&self.name
}
/// <p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use <code>CLOUDFRONT</code>.</p>
/// <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:</p>
/// <ul>
/// <li>
/// <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>.</p></li>
/// <li>
/// <p>API and SDKs - For all calls, use the Region endpoint us-east-1.</p></li>
/// </ul>
/// This field is required.
pub fn scope(mut self, input: crate::types::Scope) -> Self {
self.scope = ::std::option::Option::Some(input);
self
}
/// <p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use <code>CLOUDFRONT</code>.</p>
/// <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:</p>
/// <ul>
/// <li>
/// <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>.</p></li>
/// <li>
/// <p>API and SDKs - For all calls, use the Region endpoint us-east-1.</p></li>
/// </ul>
pub fn set_scope(mut self, input: ::std::option::Option<crate::types::Scope>) -> Self {
self.scope = input;
self
}
/// <p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use <code>CLOUDFRONT</code>.</p>
/// <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:</p>
/// <ul>
/// <li>
/// <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>.</p></li>
/// <li>
/// <p>API and SDKs - For all calls, use the Region endpoint us-east-1.</p></li>
/// </ul>
pub fn get_scope(&self) -> &::std::option::Option<crate::types::Scope> {
&self.scope
}
/// <p>A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.</p>
/// This field is required.
pub fn id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.id = ::std::option::Option::Some(input.into());
self
}
/// <p>A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.</p>
pub fn set_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.id = input;
self
}
/// <p>A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.</p>
pub fn get_id(&self) -> &::std::option::Option<::std::string::String> {
&self.id
}
/// <p>A description of the rule group that helps with identification.</p>
pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.description = ::std::option::Option::Some(input.into());
self
}
/// <p>A description of the rule group that helps with identification.</p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.description = input;
self
}
/// <p>A description of the rule group that helps with identification.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
&self.description
}
/// Appends an item to `rules`.
///
/// To override the contents of this collection use [`set_rules`](Self::set_rules).
///
/// <p>The <code>Rule</code> statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.</p>
pub fn rules(mut self, input: crate::types::Rule) -> Self {
let mut v = self.rules.unwrap_or_default();
v.push(input);
self.rules = ::std::option::Option::Some(v);
self
}
/// <p>The <code>Rule</code> statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.</p>
pub fn set_rules(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Rule>>) -> Self {
self.rules = input;
self
}
/// <p>The <code>Rule</code> statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.</p>
pub fn get_rules(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Rule>> {
&self.rules
}
/// <p>Defines and enables Amazon CloudWatch metrics and web request sample collection.</p>
/// This field is required.
pub fn visibility_config(mut self, input: crate::types::VisibilityConfig) -> Self {
self.visibility_config = ::std::option::Option::Some(input);
self
}
/// <p>Defines and enables Amazon CloudWatch metrics and web request sample collection.</p>
pub fn set_visibility_config(mut self, input: ::std::option::Option<crate::types::VisibilityConfig>) -> Self {
self.visibility_config = input;
self
}
/// <p>Defines and enables Amazon CloudWatch metrics and web request sample collection.</p>
pub fn get_visibility_config(&self) -> &::std::option::Option<crate::types::VisibilityConfig> {
&self.visibility_config
}
/// <p>A token used for optimistic locking. WAF returns a token to your <code>get</code> and <code>list</code> requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like <code>update</code> and <code>delete</code>. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a <code>WAFOptimisticLockException</code>. If this happens, perform another <code>get</code>, and use the new token returned by that operation.</p>
/// This field is required.
pub fn lock_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.lock_token = ::std::option::Option::Some(input.into());
self
}
/// <p>A token used for optimistic locking. WAF returns a token to your <code>get</code> and <code>list</code> requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like <code>update</code> and <code>delete</code>. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a <code>WAFOptimisticLockException</code>. If this happens, perform another <code>get</code>, and use the new token returned by that operation.</p>
pub fn set_lock_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.lock_token = input;
self
}
/// <p>A token used for optimistic locking. WAF returns a token to your <code>get</code> and <code>list</code> requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like <code>update</code> and <code>delete</code>. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a <code>WAFOptimisticLockException</code>. If this happens, perform another <code>get</code>, and use the new token returned by that operation.</p>
pub fn get_lock_token(&self) -> &::std::option::Option<::std::string::String> {
&self.lock_token
}
/// Adds a key-value pair to `custom_response_bodies`.
///
/// To override the contents of this collection use [`set_custom_response_bodies`](Self::set_custom_response_bodies).
///
/// <p>A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.</p>
/// <p>For information about customizing web requests and responses, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html">Customizing web requests and responses in WAF</a> in the <i>WAF Developer Guide</i>.</p>
/// <p>For information about the limits on count and size for custom request and response settings, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/limits.html">WAF quotas</a> in the <i>WAF Developer Guide</i>.</p>
pub fn custom_response_bodies(mut self, k: impl ::std::convert::Into<::std::string::String>, v: crate::types::CustomResponseBody) -> Self {
let mut hash_map = self.custom_response_bodies.unwrap_or_default();
hash_map.insert(k.into(), v);
self.custom_response_bodies = ::std::option::Option::Some(hash_map);
self
}
/// <p>A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.</p>
/// <p>For information about customizing web requests and responses, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html">Customizing web requests and responses in WAF</a> in the <i>WAF Developer Guide</i>.</p>
/// <p>For information about the limits on count and size for custom request and response settings, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/limits.html">WAF quotas</a> in the <i>WAF Developer Guide</i>.</p>
pub fn set_custom_response_bodies(
mut self,
input: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::CustomResponseBody>>,
) -> Self {
self.custom_response_bodies = input;
self
}
/// <p>A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.</p>
/// <p>For information about customizing web requests and responses, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html">Customizing web requests and responses in WAF</a> in the <i>WAF Developer Guide</i>.</p>
/// <p>For information about the limits on count and size for custom request and response settings, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/limits.html">WAF quotas</a> in the <i>WAF Developer Guide</i>.</p>
pub fn get_custom_response_bodies(
&self,
) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::CustomResponseBody>> {
&self.custom_response_bodies
}
/// <p>The monetization configuration for the rule group. Provide this when any rule in the rule group uses the <code>Monetize</code> action.</p>
pub fn monetization_config(mut self, input: crate::types::MonetizationConfig) -> Self {
self.monetization_config = ::std::option::Option::Some(input);
self
}
/// <p>The monetization configuration for the rule group. Provide this when any rule in the rule group uses the <code>Monetize</code> action.</p>
pub fn set_monetization_config(mut self, input: ::std::option::Option<crate::types::MonetizationConfig>) -> Self {
self.monetization_config = input;
self
}
/// <p>The monetization configuration for the rule group. Provide this when any rule in the rule group uses the <code>Monetize</code> action.</p>
pub fn get_monetization_config(&self) -> &::std::option::Option<crate::types::MonetizationConfig> {
&self.monetization_config
}
/// Consumes the builder and constructs a [`UpdateRuleGroupInput`](crate::operation::update_rule_group::UpdateRuleGroupInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::update_rule_group::UpdateRuleGroupInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::update_rule_group::UpdateRuleGroupInput {
name: self.name,
scope: self.scope,
id: self.id,
description: self.description,
rules: self.rules,
visibility_config: self.visibility_config,
lock_token: self.lock_token,
custom_response_bodies: self.custom_response_bodies,
monetization_config: self.monetization_config,
})
}
}