/******************************************************************************* * 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.OpsWorks; using Amazon.OpsWorks.Model; namespace Amazon.PowerShell.Cmdlets.OPS { /// <summary> /// Describes <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic /// IP addresses</a>. /// /// <note><para> /// This call accepts only one resource-identifying parameter. /// </para></note><para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, /// or Manage permissions level for the stack, or an attached policy that explicitly grants /// permissions. For more information about user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing /// User Permissions</a>. /// </para> /// </summary> [Cmdlet("Get", "OPSElasticIp")] [OutputType("Amazon.OpsWorks.Model.ElasticIp")] [AWSCmdlet("Calls the AWS OpsWorks DescribeElasticIps API operation.", Operation = new[] {"DescribeElasticIps"}, SelectReturnType = typeof(Amazon.OpsWorks.Model.DescribeElasticIpsResponse), LegacyAlias="Get-OPSElasticIps")] [AWSCmdletOutput("Amazon.OpsWorks.Model.ElasticIp or Amazon.OpsWorks.Model.DescribeElasticIpsResponse", "This cmdlet returns a collection of Amazon.OpsWorks.Model.ElasticIp objects.", "The service call response (type Amazon.OpsWorks.Model.DescribeElasticIpsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetOPSElasticIpCmdlet : AmazonOpsWorksClientCmdlet, IExecutor { #region Parameter InstanceId /// <summary> /// <para> /// <para>The instance ID. If you include this parameter, <code>DescribeElasticIps</code> returns /// a description of the Elastic IP addresses associated with the specified instance.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] public System.String InstanceId { get; set; } #endregion #region Parameter Ip /// <summary> /// <para> /// <para>An array of Elastic IP addresses to be described. If you include this parameter, <code>DescribeElasticIps</code> /// returns a description of the specified Elastic IP addresses. Otherwise, it returns /// a description of every Elastic IP address.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)] [Alias("Ips")] public System.String[] Ip { get; set; } #endregion #region Parameter StackId /// <summary> /// <para> /// <para>A stack ID. If you include this parameter, <code>DescribeElasticIps</code> returns /// a description of the Elastic IP addresses that are registered with the specified stack.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String StackId { get; set; } #endregion #region Parameter Select /// <summary> /// Use the -Select parameter to control the cmdlet output. The default value is 'ElasticIps'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpsWorks.Model.DescribeElasticIpsResponse). /// Specifying the name of a property of type Amazon.OpsWorks.Model.DescribeElasticIpsResponse will result in that property being returned. /// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public string Select { get; set; } = "ElasticIps"; #endregion #region Parameter PassThru /// <summary> /// Changes the cmdlet behavior to return the value passed to the InstanceId parameter. /// The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version. /// </summary> [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^InstanceId' 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<Amazon.OpsWorks.Model.DescribeElasticIpsResponse, GetOPSElasticIpCmdlet>(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.InstanceId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.InstanceId = this.InstanceId; if (this.Ip != null) { context.Ip = new List<System.String>(this.Ip); } context.StackId = this.StackId; // 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.OpsWorks.Model.DescribeElasticIpsRequest(); if (cmdletContext.InstanceId != null) { request.InstanceId = cmdletContext.InstanceId; } if (cmdletContext.Ip != null) { request.Ips = cmdletContext.Ip; } if (cmdletContext.StackId != null) { request.StackId = cmdletContext.StackId; } 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.OpsWorks.Model.DescribeElasticIpsResponse CallAWSServiceOperation(IAmazonOpsWorks client, Amazon.OpsWorks.Model.DescribeElasticIpsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS OpsWorks", "DescribeElasticIps"); try { #if DESKTOP return client.DescribeElasticIps(request); #elif CORECLR return client.DescribeElasticIpsAsync(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 InstanceId { get; set; } public List<System.String> Ip { get; set; } public System.String StackId { get; set; } public System.Func<Amazon.OpsWorks.Model.DescribeElasticIpsResponse, GetOPSElasticIpCmdlet, object> Select { get; set; } = (response, cmdlet) => response.ElasticIps; } } }