/*******************************************************************************
* 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.EC2;
using Amazon.EC2.Model;
namespace Amazon.PowerShell.Cmdlets.EC2
{
///
/// Describes the specified Elastic IP addresses or all of your Elastic IP addresses.
///
[Cmdlet("Get", "EC2Address")]
[OutputType("Amazon.EC2.Model.Address")]
[AWSCmdlet("Calls the Amazon Elastic Compute Cloud (EC2) DescribeAddresses API operation.", Operation = new[] {"DescribeAddresses"}, SelectReturnType = typeof(Amazon.EC2.Model.DescribeAddressesResponse))]
[AWSCmdletOutput("Amazon.EC2.Model.Address or Amazon.EC2.Model.DescribeAddressesResponse",
"This cmdlet returns a collection of Amazon.EC2.Model.Address objects.",
"The service call response (type Amazon.EC2.Model.DescribeAddressesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetEC2AddressCmdlet : AmazonEC2ClientCmdlet, IExecutor
{
#region Parameter AllocationId
///
///
/// Information about the allocation IDs.
///
///
[System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)]
[Alias("AllocationIds")]
public System.String[] AllocationId { get; set; }
#endregion
#region Parameter Filter
///
///
/// One or more filters. Filter names and values are case-sensitive.allocation-id
- The allocation ID for the address.association-id
- The association ID for the address.instance-id
- The ID of the instance the address is associated with,
/// if any.network-border-group
- A unique set of Availability Zones, Local Zones,
/// or Wavelength Zones from where Amazon Web Services advertises IP addresses. network-interface-id
- The ID of the network interface that the address
/// is associated with, if any.network-interface-owner-id
- The Amazon Web Services account ID of the
/// owner.private-ip-address
- The private IP address associated with the Elastic
/// IP address.public-ip
- The Elastic IP address, or the carrier IP address.tag
:<key> - The key/value combination of a tag assigned to the
/// resource. Use the tag key in the filter name and the tag value as the filter value.
/// For example, to find all resources that have a tag with the key Owner
/// and the value TeamA
, specify tag:Owner
for the filter name
/// and TeamA
for the filter value.tag-key
- The key of a tag assigned to the resource. Use this filter
/// to find all resources assigned a tag with a specific key, regardless of the tag value.
///
///
[System.Management.Automation.Parameter(Position = 2, ValueFromPipelineByPropertyName = true)]
[Alias("Filters")]
public Amazon.EC2.Model.Filter[] Filter { get; set; }
#endregion
#region Parameter PublicIp
///
///
/// One or more Elastic IP addresses.Default: Describes all your Elastic IP addresses.
///
///
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
[Alias("PublicIps")]
public System.String[] PublicIp { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'Addresses'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.DescribeAddressesResponse).
/// Specifying the name of a property of type Amazon.EC2.Model.DescribeAddressesResponse 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; } = "Addresses";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the PublicIp parameter.
/// The -PassThru parameter is deprecated, use -Select '^PublicIp' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^PublicIp' 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.PublicIp;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (this.AllocationId != null)
{
context.AllocationId = new List(this.AllocationId);
}
if (this.Filter != null)
{
context.Filter = new List(this.Filter);
}
if (this.PublicIp != null)
{
context.PublicIp = new List(this.PublicIp);
}
// 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.EC2.Model.DescribeAddressesRequest();
if (cmdletContext.AllocationId != null)
{
request.AllocationIds = cmdletContext.AllocationId;
}
if (cmdletContext.Filter != null)
{
request.Filters = cmdletContext.Filter;
}
if (cmdletContext.PublicIp != null)
{
request.PublicIps = cmdletContext.PublicIp;
}
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.EC2.Model.DescribeAddressesResponse CallAWSServiceOperation(IAmazonEC2 client, Amazon.EC2.Model.DescribeAddressesRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Elastic Compute Cloud (EC2)", "DescribeAddresses");
try
{
#if DESKTOP
return client.DescribeAddresses(request);
#elif CORECLR
return client.DescribeAddressesAsync(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 AllocationId { get; set; }
public List Filter { get; set; }
public List PublicIp { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.Addresses;
}
}
}