/******************************************************************************* * 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.WAFV2; using Amazon.WAFV2.Model; namespace Amazon.PowerShell.Cmdlets.WAF2 { /// /// Retrieves the IP addresses that are currently blocked by a rate-based rule instance. /// This is only available for rate-based rules that aggregate solely on the IP address /// or on the forwarded IP address. /// /// /// /// The maximum number of addresses that can be blocked for a single rate-based rule instance /// is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest /// rates are blocked. /// /// For a rate-based rule that you've defined inside a rule group, provide the name of /// the rule group reference statement in your request, in addition to the rate-based /// rule name and the web ACL name. /// /// WAF monitors web requests and manages keys independently for each unique combination /// of web ACL, optional rule group, and rate-based rule. For example, if you define a /// rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF /// monitors web requests and manages keys for that web ACL, rule group reference statement, /// and rate-based rule instance. If you use the same rule group in a second web ACL, /// WAF monitors web requests and manages keys for this second usage completely independent /// of your first. /// /// [Cmdlet("Get", "WAF2RateBasedStatementManagedKey")] [OutputType("Amazon.WAFV2.Model.GetRateBasedStatementManagedKeysResponse")] [AWSCmdlet("Calls the AWS WAF V2 GetRateBasedStatementManagedKeys API operation.", Operation = new[] {"GetRateBasedStatementManagedKeys"}, SelectReturnType = typeof(Amazon.WAFV2.Model.GetRateBasedStatementManagedKeysResponse))] [AWSCmdletOutput("Amazon.WAFV2.Model.GetRateBasedStatementManagedKeysResponse", "This cmdlet returns an Amazon.WAFV2.Model.GetRateBasedStatementManagedKeysResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetWAF2RateBasedStatementManagedKeyCmdlet : AmazonWAFV2ClientCmdlet, IExecutor { #region Parameter RuleGroupRuleName /// /// /// The name of the rule group reference statement in your web ACL. This is required only /// when you have the rate-based rule nested inside a rule group. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String RuleGroupRuleName { get; set; } #endregion #region Parameter RuleName /// /// /// The name of the rate-based rule to get the keys for. If you have the rule defined /// inside a rule group that you're using in your web ACL, also provide the name of the /// rule group reference statement in the request parameter RuleGroupRuleName. /// /// #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 RuleName { get; set; } #endregion #region Parameter 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: /// /// #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.WAFV2.Scope")] public Amazon.WAFV2.Scope Scope { get; set; } #endregion #region Parameter WebACLId /// /// /// The unique identifier for the web ACL. This ID is returned in the responses to create /// and list commands. You provide it to operations like update and delete. /// /// #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 WebACLId { get; set; } #endregion #region Parameter WebACLName /// /// /// The name of the web ACL. You cannot change the name of a web ACL 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 WebACLName { 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.WAFV2.Model.GetRateBasedStatementManagedKeysResponse). /// Specifying the name of a property of type Amazon.WAFV2.Model.GetRateBasedStatementManagedKeysResponse 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 RuleName parameter. /// The -PassThru parameter is deprecated, use -Select '^RuleName' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^RuleName' instead. This parameter will be removed in a future version.")] [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter PassThru { 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); #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.RuleName; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.RuleGroupRuleName = this.RuleGroupRuleName; context.RuleName = this.RuleName; #if MODULAR if (this.RuleName == null && ParameterWasBound(nameof(this.RuleName))) { WriteWarning("You are passing $null as a value for parameter RuleName 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.Scope = this.Scope; #if MODULAR if (this.Scope == null && ParameterWasBound(nameof(this.Scope))) { WriteWarning("You are passing $null as a value for parameter Scope 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.WebACLId = this.WebACLId; #if MODULAR if (this.WebACLId == null && ParameterWasBound(nameof(this.WebACLId))) { WriteWarning("You are passing $null as a value for parameter WebACLId 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.WebACLName = this.WebACLName; #if MODULAR if (this.WebACLName == null && ParameterWasBound(nameof(this.WebACLName))) { WriteWarning("You are passing $null as a value for parameter WebACLName 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 // 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.WAFV2.Model.GetRateBasedStatementManagedKeysRequest(); if (cmdletContext.RuleGroupRuleName != null) { request.RuleGroupRuleName = cmdletContext.RuleGroupRuleName; } if (cmdletContext.RuleName != null) { request.RuleName = cmdletContext.RuleName; } if (cmdletContext.Scope != null) { request.Scope = cmdletContext.Scope; } if (cmdletContext.WebACLId != null) { request.WebACLId = cmdletContext.WebACLId; } if (cmdletContext.WebACLName != null) { request.WebACLName = cmdletContext.WebACLName; } 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.WAFV2.Model.GetRateBasedStatementManagedKeysResponse CallAWSServiceOperation(IAmazonWAFV2 client, Amazon.WAFV2.Model.GetRateBasedStatementManagedKeysRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS WAF V2", "GetRateBasedStatementManagedKeys"); try { #if DESKTOP return client.GetRateBasedStatementManagedKeys(request); #elif CORECLR return client.GetRateBasedStatementManagedKeysAsync(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 RuleGroupRuleName { get; set; } public System.String RuleName { get; set; } public Amazon.WAFV2.Scope Scope { get; set; } public System.String WebACLId { get; set; } public System.String WebACLName { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }