/******************************************************************************* * Copyright 2012-2019 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. * ***************************************************************************** * * AWS Tools for Windows (TM) PowerShell (TM) * */ using System; using System.Collections.Generic; using System.Linq; using System.Management.Automation; using System.Text; using Amazon.PowerShell.Common; using Amazon.Runtime; using Amazon.WAF; using Amazon.WAF.Model; namespace Amazon.PowerShell.Cmdlets.WAF { /// /// /// This is AWS WAF Classic documentation. For more information, see AWS /// WAF Classic in the developer guide. /// For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS /// WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints /// for regional and global use. /// /// Creates a RateBasedRule. The RateBasedRule contains a RateLimit, /// which specifies the maximum number of requests that AWS WAF allows from a specified /// IP address in a five-minute period. The RateBasedRule also contains the /// IPSet objects, ByteMatchSet objects, and other predicates /// that identify the requests that you want to count or block if these requests exceed /// the RateLimit. /// /// If you add more than one predicate to a RateBasedRule, a request not /// only must exceed the RateLimit, but it also must match all the conditions /// to be counted or blocked. For example, suppose you add the following to a RateBasedRule: /// /// Further, you specify a RateLimit of 1,000. /// /// You then add the RateBasedRule to a WebACL and specify that /// you want to block requests that meet the conditions in the rule. For a request to /// be blocked, it must come from the IP address 192.0.2.44 and the User-Agent /// header in the request must contain the value BadBot. Further, requests /// that match these two conditions must be received at a rate of more than 1,000 requests /// every five minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks /// the requests. If the rate drops below 1,000 for a five-minute period, AWS WAF no longer /// blocks the requests. /// /// As a second example, suppose you want to limit requests to a particular page on your /// site. To do this, you could add the following to a RateBasedRule: /// /// Further, you specify a RateLimit of 1,000. /// /// By adding this RateBasedRule to a WebACL, you could limit /// requests to your login page without affecting the rest of your site. /// /// To create and configure a RateBasedRule, perform the following steps: ///
  1. /// Create and update the predicates that you want to include in the rule. For more information, /// see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. ///
  2. /// Use GetChangeToken to get the change token that you provide in the ChangeToken /// parameter of a CreateRule request. ///
  3. /// Submit a CreateRateBasedRule request. ///
  4. /// Use GetChangeToken to get the change token that you provide in the ChangeToken /// parameter of an UpdateRule request. ///
  5. /// Submit an UpdateRateBasedRule request to specify the predicates that /// you want to include in the rule. ///
  6. /// Create and update a WebACL that contains the RateBasedRule. /// For more information, see CreateWebACL. ///
/// For more information about how to use the AWS WAF API to allow or block HTTP requests, /// see the AWS WAF Developer /// Guide. /// /// [Cmdlet("New", "WAFRateBasedRule", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.WAF.Model.CreateRateBasedRuleResponse")] [AWSCmdlet("Calls the AWS WAF CreateRateBasedRule API operation.", Operation = new[] {"CreateRateBasedRule"}, SelectReturnType = typeof(Amazon.WAF.Model.CreateRateBasedRuleResponse))] [AWSCmdletOutput("Amazon.WAF.Model.CreateRateBasedRuleResponse", "This cmdlet returns an Amazon.WAF.Model.CreateRateBasedRuleResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewWAFRateBasedRuleCmdlet : AmazonWAFClientCmdlet, IExecutor { #region Parameter ChangeToken /// /// /// The ChangeToken that you used to submit the CreateRateBasedRule /// request. You can also use this value to query the status of the request. For more /// information, see GetChangeTokenStatus. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String ChangeToken { get; set; } #endregion #region Parameter MetricName /// /// /// A friendly name or description for the metrics for this RateBasedRule. /// The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length /// 128 and minimum length one. It can't contain whitespace or metric names reserved for /// AWS WAF, including "All" and "Default_Action." You can't change the name of the metric /// after you create the RateBasedRule. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String MetricName { get; set; } #endregion #region Parameter Name /// /// /// A friendly name or description of the RateBasedRule. You can't change the name /// of a RateBasedRule after you create it. /// /// #if !MODULAR [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] #else [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String Name { get; set; } #endregion #region Parameter RateKey /// /// /// The field that AWS WAF uses to determine if requests are likely arriving from a single /// source and thus subject to rate monitoring. The only valid value for RateKey /// is IP. IP indicates that requests that arrive from the same /// IP address are subject to the RateLimit that is specified in the RateBasedRule. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [AWSConstantClassSource("Amazon.WAF.RateKey")] public Amazon.WAF.RateKey RateKey { get; set; } #endregion #region Parameter RateLimit /// /// /// The maximum number of requests, which have an identical value in the field that is /// specified by RateKey, allowed in a five-minute period. If the number /// of requests exceeds the RateLimit and the other predicates specified /// in the rule are also met, AWS WAF triggers the action that is specified for this rule. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.Int64? RateLimit { get; set; } #endregion #region Parameter Tag /// /// /// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Tags")] public Amazon.WAF.Model.Tag[] Tag { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is '*'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAF.Model.CreateRateBasedRuleResponse). /// Specifying the name of a property of type Amazon.WAF.Model.CreateRateBasedRuleResponse will result in that property being returned. /// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public string Select { get; set; } = "*"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the Name parameter. /// The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.")] [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter PassThru { get; set; } #endregion #region Parameter Force /// /// This parameter overrides confirmation prompts to force /// the cmdlet to continue its operation. This parameter should always /// be used with caution. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter Force { get; set; } #endregion protected override void ProcessRecord() { this._AWSSignerType = "v4"; base.ProcessRecord(); var resourceIdentifiersText = FormatParameterValuesForConfirmationMsg(nameof(this.Name), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-WAFRateBasedRule (CreateRateBasedRule)")) { return; } var context = new CmdletContext(); // allow for manipulation of parameters prior to loading into context PreExecutionContextLoad(context); #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute if (ParameterWasBound(nameof(this.Select))) { context.Select = CreateSelectDelegate(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); if (this.PassThru.IsPresent) { throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select)); } } else if (this.PassThru.IsPresent) { context.Select = (response, cmdlet) => this.Name; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.ChangeToken = this.ChangeToken; #if MODULAR if (this.ChangeToken == null && ParameterWasBound(nameof(this.ChangeToken))) { WriteWarning("You are passing $null as a value for parameter ChangeToken which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif context.MetricName = this.MetricName; #if MODULAR if (this.MetricName == null && ParameterWasBound(nameof(this.MetricName))) { WriteWarning("You are passing $null as a value for parameter MetricName which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif context.Name = this.Name; #if MODULAR if (this.Name == null && ParameterWasBound(nameof(this.Name))) { WriteWarning("You are passing $null as a value for parameter Name which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif context.RateKey = this.RateKey; #if MODULAR if (this.RateKey == null && ParameterWasBound(nameof(this.RateKey))) { WriteWarning("You are passing $null as a value for parameter RateKey which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif context.RateLimit = this.RateLimit; #if MODULAR if (this.RateLimit == null && ParameterWasBound(nameof(this.RateLimit))) { WriteWarning("You are passing $null as a value for parameter RateLimit which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif if (this.Tag != null) { context.Tag = new List(this.Tag); } // allow further manipulation of loaded context prior to processing PostExecutionContextLoad(context); var output = Execute(context) as CmdletOutput; ProcessOutput(output); } #region IExecutor Members public object Execute(ExecutorContext context) { var cmdletContext = context as CmdletContext; // create request var request = new Amazon.WAF.Model.CreateRateBasedRuleRequest(); if (cmdletContext.ChangeToken != null) { request.ChangeToken = cmdletContext.ChangeToken; } if (cmdletContext.MetricName != null) { request.MetricName = cmdletContext.MetricName; } if (cmdletContext.Name != null) { request.Name = cmdletContext.Name; } if (cmdletContext.RateKey != null) { request.RateKey = cmdletContext.RateKey; } if (cmdletContext.RateLimit != null) { request.RateLimit = cmdletContext.RateLimit.Value; } if (cmdletContext.Tag != null) { request.Tags = cmdletContext.Tag; } CmdletOutput output; // issue call var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); try { var response = CallAWSServiceOperation(client, request); object pipelineOutput = null; pipelineOutput = cmdletContext.Select(response, this); output = new CmdletOutput { PipelineOutput = pipelineOutput, ServiceResponse = response }; } catch (Exception e) { output = new CmdletOutput { ErrorResponse = e }; } return output; } public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.WAF.Model.CreateRateBasedRuleResponse CallAWSServiceOperation(IAmazonWAF client, Amazon.WAF.Model.CreateRateBasedRuleRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS WAF", "CreateRateBasedRule"); try { #if DESKTOP return client.CreateRateBasedRule(request); #elif CORECLR return client.CreateRateBasedRuleAsync(request).GetAwaiter().GetResult(); #else #error "Unknown build edition" #endif } catch (AmazonServiceException exc) { var webException = exc.InnerException as System.Net.WebException; if (webException != null) { throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException); } throw; } } #endregion internal partial class CmdletContext : ExecutorContext { public System.String ChangeToken { get; set; } public System.String MetricName { get; set; } public System.String Name { get; set; } public Amazon.WAF.RateKey RateKey { get; set; } public System.Int64? RateLimit { get; set; } public List Tag { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }