/*******************************************************************************
* 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
{
///
/// Returns the web ACL capacity unit (WCU) requirements for a specified scope and set
/// of rules. You can use this to check the capacity requirements for the rules you want
/// to use in a RuleGroup or WebACL.
///
///
///
/// WAF uses WCUs to calculate and control the operating resources that are used to run
/// your rules, rule groups, and web ACLs. WAF calculates capacity differently for each
/// rule type, to reflect the relative cost of each rule. Simple rules that cost little
/// to run use fewer WCUs than more complex rules that use more processing power. Rule
/// group capacity is fixed at creation, which helps users plan their web ACL WCU usage
/// when they use a rule group. For more information, see WAF
/// web ACL capacity units (WCU) in the WAF Developer Guide.
///
///
[Cmdlet("Test", "WAF2Capacity")]
[OutputType("System.Int64")]
[AWSCmdlet("Calls the AWS WAF V2 CheckCapacity API operation.", Operation = new[] {"CheckCapacity"}, SelectReturnType = typeof(Amazon.WAFV2.Model.CheckCapacityResponse))]
[AWSCmdletOutput("System.Int64 or Amazon.WAFV2.Model.CheckCapacityResponse",
"This cmdlet returns a System.Int64 object.",
"The service call response (type Amazon.WAFV2.Model.CheckCapacityResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class TestWAF2CapacityCmdlet : AmazonWAFV2ClientCmdlet, IExecutor
{
#region Parameter Rule
///
///
/// An array of Rule that you're configuring to use in a rule group or web ACL.
///
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyCollection]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
[Alias("Rules")]
public Amazon.WAFV2.Model.Rule[] Rule { 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: - 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.
///
///
#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.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
[AWSConstantClassSource("Amazon.WAFV2.Scope")]
public Amazon.WAFV2.Scope Scope { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'Capacity'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.CheckCapacityResponse).
/// Specifying the name of a property of type Amazon.WAFV2.Model.CheckCapacityResponse 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; } = "Capacity";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the Scope parameter.
/// The -PassThru parameter is deprecated, use -Select '^Scope' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Scope' 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.Scope;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (this.Rule != null)
{
context.Rule = new List(this.Rule);
}
#if MODULAR
if (this.Rule == null && ParameterWasBound(nameof(this.Rule)))
{
WriteWarning("You are passing $null as a value for parameter Rule 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
// 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.CheckCapacityRequest();
if (cmdletContext.Rule != null)
{
request.Rules = cmdletContext.Rule;
}
if (cmdletContext.Scope != null)
{
request.Scope = cmdletContext.Scope;
}
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.CheckCapacityResponse CallAWSServiceOperation(IAmazonWAFV2 client, Amazon.WAFV2.Model.CheckCapacityRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS WAF V2", "CheckCapacity");
try
{
#if DESKTOP
return client.CheckCapacity(request);
#elif CORECLR
return client.CheckCapacityAsync(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 List Rule { get; set; }
public Amazon.WAFV2.Scope Scope { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.Capacity;
}
}
}