/******************************************************************************* * 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 a list of the available versions for the specified managed rule group.

This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. ///
[Cmdlet("Get", "WAF2AvailableManagedRuleGroupVersionList")] [OutputType("Amazon.WAFV2.Model.ManagedRuleGroupVersion")] [AWSCmdlet("Calls the AWS WAF V2 ListAvailableManagedRuleGroupVersions API operation.", Operation = new[] {"ListAvailableManagedRuleGroupVersions"}, SelectReturnType = typeof(Amazon.WAFV2.Model.ListAvailableManagedRuleGroupVersionsResponse))] [AWSCmdletOutput("Amazon.WAFV2.Model.ManagedRuleGroupVersion or Amazon.WAFV2.Model.ListAvailableManagedRuleGroupVersionsResponse", "This cmdlet returns a collection of Amazon.WAFV2.Model.ManagedRuleGroupVersion objects.", "The service call response (type Amazon.WAFV2.Model.ListAvailableManagedRuleGroupVersionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetWAF2AvailableManagedRuleGroupVersionListCmdlet : AmazonWAFV2ClientCmdlet, IExecutor { #region Parameter Name /// /// /// The name of the managed rule group. You use this, along with the vendor name, to identify /// the rule group. /// /// #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 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(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 VendorName /// /// /// The name of the managed rule group vendor. You use this, along with the rule group /// name, to identify a rule group. /// /// #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 VendorName { get; set; } #endregion #region Parameter Limit /// /// /// The maximum number of objects that you want WAF to return for this request. If more /// objects are available, in the response, WAF provides a NextMarker value /// that you can use in a subsequent call to get the next batch of objects. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? Limit { get; set; } #endregion #region Parameter NextMarker /// /// /// When you request a list of objects with a Limit setting, if the number /// of objects that are still available for retrieval exceeds the limit, WAF returns a /// NextMarker value in the response. To retrieve the next batch of objects, /// provide the marker from the prior call in your next request. /// /// ///
Note: This parameter is only used if you are manually controlling output pagination of the service API call. ///
In order to manually control output pagination, use '-NextMarker $null' for the first call and '-NextMarker $AWSHistory.LastServiceResponse.NextMarker' for subsequent calls. ///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("NextToken")] public System.String NextMarker { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'Versions'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.ListAvailableManagedRuleGroupVersionsResponse). /// Specifying the name of a property of type Amazon.WAFV2.Model.ListAvailableManagedRuleGroupVersionsResponse 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; } = "Versions"; #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 #region Parameter NoAutoIteration /// /// By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple /// service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextMarker /// as the start point. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter NoAutoIteration { 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 context.Limit = this.Limit; 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.NextMarker = this.NextMarker; 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.VendorName = this.VendorName; #if MODULAR if (this.VendorName == null && ParameterWasBound(nameof(this.VendorName))) { WriteWarning("You are passing $null as a value for parameter VendorName 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; #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute var useParameterSelect = this.Select.StartsWith("^") || this.PassThru.IsPresent; #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute // create request and set iteration invariants var request = new Amazon.WAFV2.Model.ListAvailableManagedRuleGroupVersionsRequest(); if (cmdletContext.Limit != null) { request.Limit = cmdletContext.Limit.Value; } if (cmdletContext.Name != null) { request.Name = cmdletContext.Name; } if (cmdletContext.Scope != null) { request.Scope = cmdletContext.Scope; } if (cmdletContext.VendorName != null) { request.VendorName = cmdletContext.VendorName; } // Initialize loop variant and commence piping var _nextToken = cmdletContext.NextMarker; var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.NextMarker)); var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); do { request.NextMarker = _nextToken; CmdletOutput output; try { var response = CallAWSServiceOperation(client, request); object pipelineOutput = null; if (!useParameterSelect) { pipelineOutput = cmdletContext.Select(response, this); } output = new CmdletOutput { PipelineOutput = pipelineOutput, ServiceResponse = response }; _nextToken = response.NextMarker; } catch (Exception e) { output = new CmdletOutput { ErrorResponse = e }; } ProcessOutput(output); } while (!_userControllingPaging && AutoIterationHelpers.HasValue(_nextToken)); if (useParameterSelect) { WriteObject(cmdletContext.Select(null, this)); } return null; } public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.WAFV2.Model.ListAvailableManagedRuleGroupVersionsResponse CallAWSServiceOperation(IAmazonWAFV2 client, Amazon.WAFV2.Model.ListAvailableManagedRuleGroupVersionsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS WAF V2", "ListAvailableManagedRuleGroupVersions"); try { #if DESKTOP return client.ListAvailableManagedRuleGroupVersions(request); #elif CORECLR return client.ListAvailableManagedRuleGroupVersionsAsync(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.Int32? Limit { get; set; } public System.String Name { get; set; } public System.String NextMarker { get; set; } public Amazon.WAFV2.Scope Scope { get; set; } public System.String VendorName { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.Versions; } } }