/******************************************************************************* * 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.EKS; using Amazon.EKS.Model; namespace Amazon.PowerShell.Cmdlets.EKS { /// /// Describes the versions for an add-on. Information such as the Kubernetes versions /// that you can use the add-on with, the owner, publisher, /// and the type of the add-on are returned.

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", "EKSAddonVersion")] [OutputType("Amazon.EKS.Model.AddonInfo")] [AWSCmdlet("Calls the Amazon Elastic Container Service for Kubernetes DescribeAddonVersions API operation.", Operation = new[] {"DescribeAddonVersions"}, SelectReturnType = typeof(Amazon.EKS.Model.DescribeAddonVersionsResponse))] [AWSCmdletOutput("Amazon.EKS.Model.AddonInfo or Amazon.EKS.Model.DescribeAddonVersionsResponse", "This cmdlet returns a collection of Amazon.EKS.Model.AddonInfo objects.", "The service call response (type Amazon.EKS.Model.DescribeAddonVersionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetEKSAddonVersionCmdlet : AmazonEKSClientCmdlet, IExecutor { #region Parameter AddonName /// /// /// The name of the add-on. The name must match one of the names returned by ListAddons. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String AddonName { get; set; } #endregion #region Parameter KubernetesVersion /// /// /// The Kubernetes versions that you can use the add-on with. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String KubernetesVersion { get; set; } #endregion #region Parameter Owner /// /// /// The owner of the add-on. For valid owners, don't specify a value for /// this property. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Owners")] public System.String[] Owner { get; set; } #endregion #region Parameter Publisher /// /// /// The publisher of the add-on. For valid publishers, don't specify a value /// for this property. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Publishers")] public System.String[] Publisher { get; set; } #endregion #region Parameter Type /// /// /// The type of the add-on. For valid types, don't specify a value for this /// property. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Types")] public System.String[] Type { get; set; } #endregion #region Parameter MaxResult /// /// /// The maximum number of results to return. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("MaxResults")] public System.Int32? MaxResult { get; set; } #endregion #region Parameter NextToken /// /// /// The nextToken value returned from a previous paginated DescribeAddonVersionsRequest /// where maxResults was used and the results exceeded the value of that /// parameter. Pagination continues from the end of the previous results that returned /// the nextToken value.This token should be treated as an opaque identifier that is used only to retrieve /// the next items in a list and not for other programmatic purposes. /// /// ///
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 '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. ///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String NextToken { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'Addons'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.DescribeAddonVersionsResponse). /// Specifying the name of a property of type Amazon.EKS.Model.DescribeAddonVersionsResponse 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; } = "Addons"; #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 NextToken /// 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); if (ParameterWasBound(nameof(this.Select))) { context.Select = CreateSelectDelegate(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); } context.AddonName = this.AddonName; context.KubernetesVersion = this.KubernetesVersion; context.MaxResult = this.MaxResult; context.NextToken = this.NextToken; if (this.Owner != null) { context.Owner = new List(this.Owner); } if (this.Publisher != null) { context.Publisher = new List(this.Publisher); } if (this.Type != null) { context.Type = new List(this.Type); } // 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; var useParameterSelect = this.Select.StartsWith("^"); // create request and set iteration invariants var request = new Amazon.EKS.Model.DescribeAddonVersionsRequest(); if (cmdletContext.AddonName != null) { request.AddonName = cmdletContext.AddonName; } if (cmdletContext.KubernetesVersion != null) { request.KubernetesVersion = cmdletContext.KubernetesVersion; } if (cmdletContext.MaxResult != null) { request.MaxResults = cmdletContext.MaxResult.Value; } if (cmdletContext.Owner != null) { request.Owners = cmdletContext.Owner; } if (cmdletContext.Publisher != null) { request.Publishers = cmdletContext.Publisher; } if (cmdletContext.Type != null) { request.Types = cmdletContext.Type; } // Initialize loop variant and commence piping var _nextToken = cmdletContext.NextToken; var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.NextToken)); var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); do { request.NextToken = _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.NextToken; } 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.EKS.Model.DescribeAddonVersionsResponse CallAWSServiceOperation(IAmazonEKS client, Amazon.EKS.Model.DescribeAddonVersionsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Elastic Container Service for Kubernetes", "DescribeAddonVersions"); try { #if DESKTOP return client.DescribeAddonVersions(request); #elif CORECLR return client.DescribeAddonVersionsAsync(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 AddonName { get; set; } public System.String KubernetesVersion { get; set; } public System.Int32? MaxResult { get; set; } public System.String NextToken { get; set; } public List Owner { get; set; } public List Publisher { get; set; } public List Type { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.Addons; } } }