/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the wafv2-2019-07-29.normal.json service model. */ using System; using System.Collections.Generic; using System.Xml.Serialization; using System.Text; using System.IO; using System.Net; using Amazon.Runtime; using Amazon.Runtime.Internal; namespace Amazon.WAFV2.Model { /// /// Container for the parameters to the CreateWebACL operation. /// Creates a WebACL per the specifications provided. /// /// /// /// A web ACL defines a collection of rules to use to inspect and control web requests. /// Each rule has an action defined (allow, block, or count) for requests that match the /// statement of the rule. In the web ACL, you assign a default action to take (allow, /// block) for any request that does not match any of the rules. The rules in a web ACL /// can be a combination of the types Rule, RuleGroup, and managed rule /// group. You can associate a web ACL with one or more Amazon Web Services resources /// to protect. The resources can be an Amazon CloudFront distribution, an Amazon API /// Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon /// Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access /// instance. /// /// public partial class CreateWebACLRequest : AmazonWAFV2Request { private AssociationConfig _associationConfig; private CaptchaConfig _captchaConfig; private ChallengeConfig _challengeConfig; private Dictionary _customResponseBodies = new Dictionary(); private DefaultAction _defaultAction; private string _description; private string _name; private List _rules = new List(); private Scope _scope; private List _tags = new List(); private List _tokenDomains = new List(); private VisibilityConfig _visibilityConfig; /// /// Gets and sets the property AssociationConfig. /// /// Specifies custom configurations for the associations between the web ACL and protected /// resources. /// /// /// /// Use this to customize the maximum size of the request body that your protected CloudFront /// distributions forward to WAF for inspection. The default is 16 KB (16,384 kilobytes). /// /// /// /// /// You are charged additional fees when your protected resources forward body sizes that /// are larger than the default. For more information, see WAF /// Pricing. /// /// /// public AssociationConfig AssociationConfig { get { return this._associationConfig; } set { this._associationConfig = value; } } // Check to see if AssociationConfig property is set internal bool IsSetAssociationConfig() { return this._associationConfig != null; } /// /// Gets and sets the property CaptchaConfig. /// /// Specifies how WAF should handle CAPTCHA evaluations for rules that don't /// have their own CaptchaConfig settings. If you don't specify this, WAF /// uses its default settings for CaptchaConfig. /// /// public CaptchaConfig CaptchaConfig { get { return this._captchaConfig; } set { this._captchaConfig = value; } } // Check to see if CaptchaConfig property is set internal bool IsSetCaptchaConfig() { return this._captchaConfig != null; } /// /// Gets and sets the property ChallengeConfig. /// /// Specifies how WAF should handle challenge evaluations for rules that don't have their /// own ChallengeConfig settings. If you don't specify this, WAF uses its /// default settings for ChallengeConfig. /// /// public ChallengeConfig ChallengeConfig { get { return this._challengeConfig; } set { this._challengeConfig = value; } } // Check to see if ChallengeConfig property is set internal bool IsSetChallengeConfig() { return this._challengeConfig != null; } /// /// Gets and sets the property CustomResponseBodies. /// /// 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. /// /// /// /// For information about customizing web requests and responses, see Customizing /// web requests and responses in WAF in the WAF Developer Guide. /// /// /// /// For information about the limits on count and size for custom request and response /// settings, see WAF /// quotas in the WAF Developer Guide. /// /// [AWSProperty(Min=1)] public Dictionary CustomResponseBodies { get { return this._customResponseBodies; } set { this._customResponseBodies = value; } } // Check to see if CustomResponseBodies property is set internal bool IsSetCustomResponseBodies() { return this._customResponseBodies != null && this._customResponseBodies.Count > 0; } /// /// Gets and sets the property DefaultAction. /// /// The action to perform if none of the Rules contained in the WebACL /// match. /// /// [AWSProperty(Required=true)] public DefaultAction DefaultAction { get { return this._defaultAction; } set { this._defaultAction = value; } } // Check to see if DefaultAction property is set internal bool IsSetDefaultAction() { return this._defaultAction != null; } /// /// Gets and sets the property Description. /// /// A description of the web ACL that helps with identification. /// /// [AWSProperty(Min=1, Max=256)] public string Description { get { return this._description; } set { this._description = value; } } // Check to see if Description property is set internal bool IsSetDescription() { return this._description != null; } /// /// Gets and sets the property Name. /// /// The name of the web ACL. You cannot change the name of a web ACL after you create /// it. /// /// [AWSProperty(Required=true, Min=1, Max=128)] public string Name { get { return this._name; } set { this._name = value; } } // Check to see if Name property is set internal bool IsSetName() { return this._name != null; } /// /// Gets and sets the property Rules. /// /// The Rule statements used to identify the web requests that you want to allow, /// block, or count. Each rule includes one top-level statement that WAF uses to identify /// matching web requests, and parameters that govern how WAF handles them. /// /// public List Rules { get { return this._rules; } set { this._rules = value; } } // Check to see if Rules property is set internal bool IsSetRules() { return this._rules != null && this._rules.Count > 0; } /// /// Gets and sets the property Scope. /// /// Specifies whether this is for an Amazon CloudFront distribution or for a regional /// application. A regional application can be an Application Load Balancer (ALB), an /// Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, /// an App Runner service, or an Amazon Web Services Verified Access instance. /// /// /// /// To work with CloudFront, you must also specify the Region US East (N. Virginia) as /// follows: /// ///
  • /// /// CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT /// --region=us-east-1. /// ///
  • /// /// API and SDKs - For all calls, use the Region endpoint us-east-1. /// ///
///
[AWSProperty(Required=true)] public Scope Scope { get { return this._scope; } set { this._scope = value; } } // Check to see if Scope property is set internal bool IsSetScope() { return this._scope != null; } /// /// Gets and sets the property Tags. /// /// An array of key:value pairs to associate with the resource. /// /// [AWSProperty(Min=1)] public List Tags { get { return this._tags; } set { this._tags = value; } } // Check to see if Tags property is set internal bool IsSetTags() { return this._tags != null && this._tags.Count > 0; } /// /// Gets and sets the property TokenDomains. /// /// 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. /// /// /// /// Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" } /// /// /// /// /// Public suffixes aren't allowed. For example, you can't use usa.gov or /// co.uk as token domains. /// /// public List TokenDomains { get { return this._tokenDomains; } set { this._tokenDomains = value; } } // Check to see if TokenDomains property is set internal bool IsSetTokenDomains() { return this._tokenDomains != null && this._tokenDomains.Count > 0; } /// /// Gets and sets the property VisibilityConfig. /// /// Defines and enables Amazon CloudWatch metrics and web request sample collection. /// /// [AWSProperty(Required=true)] public VisibilityConfig VisibilityConfig { get { return this._visibilityConfig; } set { this._visibilityConfig = value; } } // Check to see if VisibilityConfig property is set internal bool IsSetVisibilityConfig() { return this._visibilityConfig != null; } } }