/******************************************************************************* * 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 Rule, which contains the IPSet objects, ByteMatchSet /// objects, and other predicates that identify the requests that you want to block. If /// you add more than one predicate to a Rule, a request must match all of /// the specifications to be allowed or blocked. For example, suppose that you add the /// following to a Rule: /// /// You then add the Rule to a WebACL and specify that you want /// to blocks requests that satisfy 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. /// /// To create and configure a Rule, 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 CreateRule request. ///
  4. /// Use GetChangeToken to get the change token that you provide in the ChangeToken /// parameter of an UpdateRule request. ///
  5. /// Submit an UpdateRule request to specify the predicates that you want /// to include in the Rule. ///
  6. /// Create and update a WebACL that contains the Rule. 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", "WAFRule")] [OutputType("Amazon.WAF.Model.CreateRuleResponse")] [AWSCmdlet("Calls the AWS WAF CreateRule API operation.", Operation = new[] {"CreateRule"}, SelectReturnType = typeof(Amazon.WAF.Model.CreateRuleResponse))] [AWSCmdletOutput("Amazon.WAF.Model.CreateRuleResponse", "This cmdlet returns an Amazon.WAF.Model.CreateRuleResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewWAFRuleCmdlet : AmazonWAFClientCmdlet, IExecutor { #region Parameter ChangeToken /// /// /// The value returned by the most recent call to GetChangeToken. /// /// #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 Rule. 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 Rule. /// /// #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 Rule. You can't change the name of a /// Rule after you create it. /// /// #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 Name { 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.CreateRuleResponse). /// Specifying the name of a property of type Amazon.WAF.Model.CreateRuleResponse 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 protected override void ProcessRecord() { this._AWSSignerType = "v4"; base.ProcessRecord(); var context = new CmdletContext(); // allow for manipulation of parameters prior to loading into context PreExecutionContextLoad(context); if (ParameterWasBound(nameof(this.Select))) { context.Select = CreateSelectDelegate(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); } 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 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.CreateRuleRequest(); 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.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.CreateRuleResponse CallAWSServiceOperation(IAmazonWAF client, Amazon.WAF.Model.CreateRuleRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS WAF", "CreateRule"); try { #if DESKTOP return client.CreateRule(request); #elif CORECLR return client.CreateRuleAsync(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 List Tag { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }