// 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 CreateWebAclInput {
/// <p>The name of the web ACL. You cannot change the name of a web ACL 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>The action to perform if none of the <code>Rules</code> contained in the <code>WebACL</code> match.</p>
pub default_action: ::std::option::Option<crate::types::DefaultAction>,
/// <p>A description of the web ACL 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>Specifies data protection to apply to the web request data for the web ACL. This is a web ACL level data protection option.</p>
/// <p>The data protection that you configure for the web ACL alters the data that's available for any other data collection activity, including your WAF logging destinations, web ACL request sampling, and Amazon Security Lake data collection and management. Your other option for data protection is in the logging configuration, which only affects logging.</p>
pub data_protection_config: ::std::option::Option<crate::types::DataProtectionConfig>,
/// <p>An array of key:value pairs to associate with the resource.</p>
pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
/// <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 web ACL, and then use them in the rules and default actions that you define in the web ACL.</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>Specifies how WAF should handle <code>CAPTCHA</code> evaluations for rules that don't have their own <code>CaptchaConfig</code> settings. If you don't specify this, WAF uses its default settings for <code>CaptchaConfig</code>.</p>
pub captcha_config: ::std::option::Option<crate::types::CaptchaConfig>,
/// <p>Specifies how WAF should handle challenge evaluations for rules that don't have their own <code>ChallengeConfig</code> settings. If you don't specify this, WAF uses its default settings for <code>ChallengeConfig</code>.</p>
pub challenge_config: ::std::option::Option<crate::types::ChallengeConfig>,
/// <p>Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.</p>
/// <p>Example JSON: <code>"TokenDomains": { "mywebsite.com", "myotherwebsite.com" }</code></p>
/// <p>Public suffixes aren't allowed. For example, you can't use <code>gov.au</code> or <code>co.uk</code> as token domains.</p>
pub token_domains: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>Specifies custom configurations for the associations between the web ACL and protected resources.</p>
/// <p>Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).</p><note>
/// <p>You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see <a href="http://aws.amazon.com/waf/pricing/">WAF Pricing</a>.</p>
/// </note>
/// <p>For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).</p>
pub association_config: ::std::option::Option<crate::types::AssociationConfig>,
/// <p>Specifies the type of DDoS protection to apply to web request data for a web ACL. For most scenarios, it is recommended to use the default protection level, <code>ACTIVE_UNDER_DDOS</code>. If a web ACL is associated with multiple Application Load Balancers, the changes you make to DDoS protection in that web ACL will apply to all associated Application Load Balancers.</p>
pub on_source_d_do_s_protection_config: ::std::option::Option<crate::types::OnSourceDDoSProtectionConfig>,
/// <p>Configures the ability for the WAF console to store and retrieve application attributes during the web ACL creation process. Application attributes help WAF give recommendations for protection packs.</p>
pub application_config: ::std::option::Option<crate::types::ApplicationConfig>,
/// <p>The monetization configuration for the web ACL. Provide this when any rule in the web ACL uses the <code>Monetize</code> action.</p>
pub monetization_config: ::std::option::Option<crate::types::MonetizationConfig>,
}
impl CreateWebAclInput {
/// <p>The name of the web ACL. You cannot change the name of a web ACL 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>The action to perform if none of the <code>Rules</code> contained in the <code>WebACL</code> match.</p>
pub fn default_action(&self) -> ::std::option::Option<&crate::types::DefaultAction> {
self.default_action.as_ref()
}
/// <p>A description of the web ACL 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>Specifies data protection to apply to the web request data for the web ACL. This is a web ACL level data protection option.</p>
/// <p>The data protection that you configure for the web ACL alters the data that's available for any other data collection activity, including your WAF logging destinations, web ACL request sampling, and Amazon Security Lake data collection and management. Your other option for data protection is in the logging configuration, which only affects logging.</p>
pub fn data_protection_config(&self) -> ::std::option::Option<&crate::types::DataProtectionConfig> {
self.data_protection_config.as_ref()
}
/// <p>An array of key:value pairs to associate with the resource.</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 `.tags.is_none()`.
pub fn tags(&self) -> &[crate::types::Tag] {
self.tags.as_deref().unwrap_or_default()
}
/// <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 web ACL, and then use them in the rules and default actions that you define in the web ACL.</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>Specifies how WAF should handle <code>CAPTCHA</code> evaluations for rules that don't have their own <code>CaptchaConfig</code> settings. If you don't specify this, WAF uses its default settings for <code>CaptchaConfig</code>.</p>
pub fn captcha_config(&self) -> ::std::option::Option<&crate::types::CaptchaConfig> {
self.captcha_config.as_ref()
}
/// <p>Specifies how WAF should handle challenge evaluations for rules that don't have their own <code>ChallengeConfig</code> settings. If you don't specify this, WAF uses its default settings for <code>ChallengeConfig</code>.</p>
pub fn challenge_config(&self) -> ::std::option::Option<&crate::types::ChallengeConfig> {
self.challenge_config.as_ref()
}
/// <p>Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.</p>
/// <p>Example JSON: <code>"TokenDomains": { "mywebsite.com", "myotherwebsite.com" }</code></p>
/// <p>Public suffixes aren't allowed. For example, you can't use <code>gov.au</code> or <code>co.uk</code> as token domains.</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 `.token_domains.is_none()`.
pub fn token_domains(&self) -> &[::std::string::String] {
self.token_domains.as_deref().unwrap_or_default()
}
/// <p>Specifies custom configurations for the associations between the web ACL and protected resources.</p>
/// <p>Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).</p><note>
/// <p>You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see <a href="http://aws.amazon.com/waf/pricing/">WAF Pricing</a>.</p>
/// </note>
/// <p>For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).</p>
pub fn association_config(&self) -> ::std::option::Option<&crate::types::AssociationConfig> {
self.association_config.as_ref()
}
/// <p>Specifies the type of DDoS protection to apply to web request data for a web ACL. For most scenarios, it is recommended to use the default protection level, <code>ACTIVE_UNDER_DDOS</code>. If a web ACL is associated with multiple Application Load Balancers, the changes you make to DDoS protection in that web ACL will apply to all associated Application Load Balancers.</p>
pub fn on_source_d_do_s_protection_config(&self) -> ::std::option::Option<&crate::types::OnSourceDDoSProtectionConfig> {
self.on_source_d_do_s_protection_config.as_ref()
}
/// <p>Configures the ability for the WAF console to store and retrieve application attributes during the web ACL creation process. Application attributes help WAF give recommendations for protection packs.</p>
pub fn application_config(&self) -> ::std::option::Option<&crate::types::ApplicationConfig> {
self.application_config.as_ref()
}
/// <p>The monetization configuration for the web ACL. Provide this when any rule in the web ACL uses the <code>Monetize</code> action.</p>
pub fn monetization_config(&self) -> ::std::option::Option<&crate::types::MonetizationConfig> {
self.monetization_config.as_ref()
}
}
impl CreateWebAclInput {
/// Creates a new builder-style object to manufacture [`CreateWebAclInput`](crate::operation::create_web_acl::CreateWebAclInput).
pub fn builder() -> crate::operation::create_web_acl::builders::CreateWebAclInputBuilder {
crate::operation::create_web_acl::builders::CreateWebAclInputBuilder::default()
}
}
/// A builder for [`CreateWebAclInput`](crate::operation::create_web_acl::CreateWebAclInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct CreateWebAclInputBuilder {
pub(crate) name: ::std::option::Option<::std::string::String>,
pub(crate) scope: ::std::option::Option<crate::types::Scope>,
pub(crate) default_action: ::std::option::Option<crate::types::DefaultAction>,
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) data_protection_config: ::std::option::Option<crate::types::DataProtectionConfig>,
pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
pub(crate) custom_response_bodies: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::CustomResponseBody>>,
pub(crate) captcha_config: ::std::option::Option<crate::types::CaptchaConfig>,
pub(crate) challenge_config: ::std::option::Option<crate::types::ChallengeConfig>,
pub(crate) token_domains: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) association_config: ::std::option::Option<crate::types::AssociationConfig>,
pub(crate) on_source_d_do_s_protection_config: ::std::option::Option<crate::types::OnSourceDDoSProtectionConfig>,
pub(crate) application_config: ::std::option::Option<crate::types::ApplicationConfig>,
pub(crate) monetization_config: ::std::option::Option<crate::types::MonetizationConfig>,
}
impl CreateWebAclInputBuilder {
/// <p>The name of the web ACL. You cannot change the name of a web ACL 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 web ACL. You cannot change the name of a web ACL 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 web ACL. You cannot change the name of a web ACL 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>The action to perform if none of the <code>Rules</code> contained in the <code>WebACL</code> match.</p>
/// This field is required.
pub fn default_action(mut self, input: crate::types::DefaultAction) -> Self {
self.default_action = ::std::option::Option::Some(input);
self
}
/// <p>The action to perform if none of the <code>Rules</code> contained in the <code>WebACL</code> match.</p>
pub fn set_default_action(mut self, input: ::std::option::Option<crate::types::DefaultAction>) -> Self {
self.default_action = input;
self
}
/// <p>The action to perform if none of the <code>Rules</code> contained in the <code>WebACL</code> match.</p>
pub fn get_default_action(&self) -> &::std::option::Option<crate::types::DefaultAction> {
&self.default_action
}
/// <p>A description of the web ACL 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 web ACL 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 web ACL 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>Specifies data protection to apply to the web request data for the web ACL. This is a web ACL level data protection option.</p>
/// <p>The data protection that you configure for the web ACL alters the data that's available for any other data collection activity, including your WAF logging destinations, web ACL request sampling, and Amazon Security Lake data collection and management. Your other option for data protection is in the logging configuration, which only affects logging.</p>
pub fn data_protection_config(mut self, input: crate::types::DataProtectionConfig) -> Self {
self.data_protection_config = ::std::option::Option::Some(input);
self
}
/// <p>Specifies data protection to apply to the web request data for the web ACL. This is a web ACL level data protection option.</p>
/// <p>The data protection that you configure for the web ACL alters the data that's available for any other data collection activity, including your WAF logging destinations, web ACL request sampling, and Amazon Security Lake data collection and management. Your other option for data protection is in the logging configuration, which only affects logging.</p>
pub fn set_data_protection_config(mut self, input: ::std::option::Option<crate::types::DataProtectionConfig>) -> Self {
self.data_protection_config = input;
self
}
/// <p>Specifies data protection to apply to the web request data for the web ACL. This is a web ACL level data protection option.</p>
/// <p>The data protection that you configure for the web ACL alters the data that's available for any other data collection activity, including your WAF logging destinations, web ACL request sampling, and Amazon Security Lake data collection and management. Your other option for data protection is in the logging configuration, which only affects logging.</p>
pub fn get_data_protection_config(&self) -> &::std::option::Option<crate::types::DataProtectionConfig> {
&self.data_protection_config
}
/// Appends an item to `tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>An array of key:value pairs to associate with the resource.</p>
pub fn tags(mut self, input: crate::types::Tag) -> Self {
let mut v = self.tags.unwrap_or_default();
v.push(input);
self.tags = ::std::option::Option::Some(v);
self
}
/// <p>An array of key:value pairs to associate with the resource.</p>
pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
self.tags = input;
self
}
/// <p>An array of key:value pairs to associate with the resource.</p>
pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
&self.tags
}
/// 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 web ACL, and then use them in the rules and default actions that you define in the web ACL.</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 web ACL, and then use them in the rules and default actions that you define in the web ACL.</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 web ACL, and then use them in the rules and default actions that you define in the web ACL.</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>Specifies how WAF should handle <code>CAPTCHA</code> evaluations for rules that don't have their own <code>CaptchaConfig</code> settings. If you don't specify this, WAF uses its default settings for <code>CaptchaConfig</code>.</p>
pub fn captcha_config(mut self, input: crate::types::CaptchaConfig) -> Self {
self.captcha_config = ::std::option::Option::Some(input);
self
}
/// <p>Specifies how WAF should handle <code>CAPTCHA</code> evaluations for rules that don't have their own <code>CaptchaConfig</code> settings. If you don't specify this, WAF uses its default settings for <code>CaptchaConfig</code>.</p>
pub fn set_captcha_config(mut self, input: ::std::option::Option<crate::types::CaptchaConfig>) -> Self {
self.captcha_config = input;
self
}
/// <p>Specifies how WAF should handle <code>CAPTCHA</code> evaluations for rules that don't have their own <code>CaptchaConfig</code> settings. If you don't specify this, WAF uses its default settings for <code>CaptchaConfig</code>.</p>
pub fn get_captcha_config(&self) -> &::std::option::Option<crate::types::CaptchaConfig> {
&self.captcha_config
}
/// <p>Specifies how WAF should handle challenge evaluations for rules that don't have their own <code>ChallengeConfig</code> settings. If you don't specify this, WAF uses its default settings for <code>ChallengeConfig</code>.</p>
pub fn challenge_config(mut self, input: crate::types::ChallengeConfig) -> Self {
self.challenge_config = ::std::option::Option::Some(input);
self
}
/// <p>Specifies how WAF should handle challenge evaluations for rules that don't have their own <code>ChallengeConfig</code> settings. If you don't specify this, WAF uses its default settings for <code>ChallengeConfig</code>.</p>
pub fn set_challenge_config(mut self, input: ::std::option::Option<crate::types::ChallengeConfig>) -> Self {
self.challenge_config = input;
self
}
/// <p>Specifies how WAF should handle challenge evaluations for rules that don't have their own <code>ChallengeConfig</code> settings. If you don't specify this, WAF uses its default settings for <code>ChallengeConfig</code>.</p>
pub fn get_challenge_config(&self) -> &::std::option::Option<crate::types::ChallengeConfig> {
&self.challenge_config
}
/// Appends an item to `token_domains`.
///
/// To override the contents of this collection use [`set_token_domains`](Self::set_token_domains).
///
/// <p>Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.</p>
/// <p>Example JSON: <code>"TokenDomains": { "mywebsite.com", "myotherwebsite.com" }</code></p>
/// <p>Public suffixes aren't allowed. For example, you can't use <code>gov.au</code> or <code>co.uk</code> as token domains.</p>
pub fn token_domains(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.token_domains.unwrap_or_default();
v.push(input.into());
self.token_domains = ::std::option::Option::Some(v);
self
}
/// <p>Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.</p>
/// <p>Example JSON: <code>"TokenDomains": { "mywebsite.com", "myotherwebsite.com" }</code></p>
/// <p>Public suffixes aren't allowed. For example, you can't use <code>gov.au</code> or <code>co.uk</code> as token domains.</p>
pub fn set_token_domains(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.token_domains = input;
self
}
/// <p>Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.</p>
/// <p>Example JSON: <code>"TokenDomains": { "mywebsite.com", "myotherwebsite.com" }</code></p>
/// <p>Public suffixes aren't allowed. For example, you can't use <code>gov.au</code> or <code>co.uk</code> as token domains.</p>
pub fn get_token_domains(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.token_domains
}
/// <p>Specifies custom configurations for the associations between the web ACL and protected resources.</p>
/// <p>Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).</p><note>
/// <p>You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see <a href="http://aws.amazon.com/waf/pricing/">WAF Pricing</a>.</p>
/// </note>
/// <p>For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).</p>
pub fn association_config(mut self, input: crate::types::AssociationConfig) -> Self {
self.association_config = ::std::option::Option::Some(input);
self
}
/// <p>Specifies custom configurations for the associations between the web ACL and protected resources.</p>
/// <p>Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).</p><note>
/// <p>You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see <a href="http://aws.amazon.com/waf/pricing/">WAF Pricing</a>.</p>
/// </note>
/// <p>For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).</p>
pub fn set_association_config(mut self, input: ::std::option::Option<crate::types::AssociationConfig>) -> Self {
self.association_config = input;
self
}
/// <p>Specifies custom configurations for the associations between the web ACL and protected resources.</p>
/// <p>Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).</p><note>
/// <p>You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see <a href="http://aws.amazon.com/waf/pricing/">WAF Pricing</a>.</p>
/// </note>
/// <p>For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).</p>
pub fn get_association_config(&self) -> &::std::option::Option<crate::types::AssociationConfig> {
&self.association_config
}
/// <p>Specifies the type of DDoS protection to apply to web request data for a web ACL. For most scenarios, it is recommended to use the default protection level, <code>ACTIVE_UNDER_DDOS</code>. If a web ACL is associated with multiple Application Load Balancers, the changes you make to DDoS protection in that web ACL will apply to all associated Application Load Balancers.</p>
pub fn on_source_d_do_s_protection_config(mut self, input: crate::types::OnSourceDDoSProtectionConfig) -> Self {
self.on_source_d_do_s_protection_config = ::std::option::Option::Some(input);
self
}
/// <p>Specifies the type of DDoS protection to apply to web request data for a web ACL. For most scenarios, it is recommended to use the default protection level, <code>ACTIVE_UNDER_DDOS</code>. If a web ACL is associated with multiple Application Load Balancers, the changes you make to DDoS protection in that web ACL will apply to all associated Application Load Balancers.</p>
pub fn set_on_source_d_do_s_protection_config(mut self, input: ::std::option::Option<crate::types::OnSourceDDoSProtectionConfig>) -> Self {
self.on_source_d_do_s_protection_config = input;
self
}
/// <p>Specifies the type of DDoS protection to apply to web request data for a web ACL. For most scenarios, it is recommended to use the default protection level, <code>ACTIVE_UNDER_DDOS</code>. If a web ACL is associated with multiple Application Load Balancers, the changes you make to DDoS protection in that web ACL will apply to all associated Application Load Balancers.</p>
pub fn get_on_source_d_do_s_protection_config(&self) -> &::std::option::Option<crate::types::OnSourceDDoSProtectionConfig> {
&self.on_source_d_do_s_protection_config
}
/// <p>Configures the ability for the WAF console to store and retrieve application attributes during the web ACL creation process. Application attributes help WAF give recommendations for protection packs.</p>
pub fn application_config(mut self, input: crate::types::ApplicationConfig) -> Self {
self.application_config = ::std::option::Option::Some(input);
self
}
/// <p>Configures the ability for the WAF console to store and retrieve application attributes during the web ACL creation process. Application attributes help WAF give recommendations for protection packs.</p>
pub fn set_application_config(mut self, input: ::std::option::Option<crate::types::ApplicationConfig>) -> Self {
self.application_config = input;
self
}
/// <p>Configures the ability for the WAF console to store and retrieve application attributes during the web ACL creation process. Application attributes help WAF give recommendations for protection packs.</p>
pub fn get_application_config(&self) -> &::std::option::Option<crate::types::ApplicationConfig> {
&self.application_config
}
/// <p>The monetization configuration for the web ACL. Provide this when any rule in the web ACL 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 web ACL. Provide this when any rule in the web ACL 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 web ACL. Provide this when any rule in the web ACL 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 [`CreateWebAclInput`](crate::operation::create_web_acl::CreateWebAclInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::create_web_acl::CreateWebAclInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::create_web_acl::CreateWebAclInput {
name: self.name,
scope: self.scope,
default_action: self.default_action,
description: self.description,
rules: self.rules,
visibility_config: self.visibility_config,
data_protection_config: self.data_protection_config,
tags: self.tags,
custom_response_bodies: self.custom_response_bodies,
captcha_config: self.captcha_config,
challenge_config: self.challenge_config,
token_domains: self.token_domains,
association_config: self.association_config,
on_source_d_do_s_protection_config: self.on_source_d_do_s_protection_config,
application_config: self.application_config,
monetization_config: self.monetization_config,
})
}
}