/******************************************************************************* * 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 { /// /// Allocates an Elastic IP address to your Amazon Web Services account. After you allocate /// the Elastic IP address you can associate it with an instance or network interface. /// After you release an Elastic IP address, it is released to the IP address pool and /// can be allocated to a different Amazon Web Services account. /// /// /// /// You can allocate an Elastic IP address from an address pool owned by Amazon Web Services /// or from an address pool created from a public IPv4 address range that you have brought /// to Amazon Web Services for use with your Amazon Web Services resources using bring /// your own IP addresses (BYOIP). For more information, see Bring /// Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide. /// /// If you release an Elastic IP address, you might be able to recover it. You cannot /// recover an Elastic IP address that you released after it is allocated to another Amazon /// Web Services account. To attempt to recover an Elastic IP address that you released, /// specify it in this operation. /// /// For more information, see Elastic /// IP Addresses in the Amazon Elastic Compute Cloud User Guide. /// /// You can allocate a carrier IP address which is a public IP address from a telecommunication /// carrier, to a network interface which resides in a subnet in a Wavelength Zone (for /// example an EC2 instance). /// /// [Cmdlet("New", "EC2Address", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.EC2.Model.AllocateAddressResponse")] [AWSCmdlet("Calls the Amazon Elastic Compute Cloud (EC2) AllocateAddress API operation.", Operation = new[] {"AllocateAddress"}, SelectReturnType = typeof(Amazon.EC2.Model.AllocateAddressResponse))] [AWSCmdletOutput("Amazon.EC2.Model.AllocateAddressResponse", "This cmdlet returns an Amazon.EC2.Model.AllocateAddressResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewEC2AddressCmdlet : AmazonEC2ClientCmdlet, IExecutor { #region Parameter Address /// /// /// The Elastic IP address to recover or an IPv4 address from an address pool. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Address { get; set; } #endregion #region Parameter CustomerOwnedIpv4Pool /// /// /// The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select /// an address from the address pool. Alternatively, specify a specific address from the /// address pool. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String CustomerOwnedIpv4Pool { get; set; } #endregion #region Parameter Domain /// /// /// The network (vpc). /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.EC2.DomainType")] public Amazon.EC2.DomainType Domain { get; set; } #endregion #region Parameter NetworkBorderGroup /// /// /// A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon /// Web Services advertises IP addresses. Use this parameter to limit the IP address to /// this location. IP addresses cannot move between network border groups.Use DescribeAvailabilityZones /// to view the network border groups.You cannot use a network border group with EC2 Classic. If you attempt this operation /// on EC2 Classic, you receive an InvalidParameterCombination error. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String NetworkBorderGroup { get; set; } #endregion #region Parameter PublicIpv4Pool /// /// /// The ID of an address pool that you own. Use this parameter to let Amazon EC2 select /// an address from the address pool. To specify a specific address from the address pool, /// use the Address parameter instead. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String PublicIpv4Pool { get; set; } #endregion #region Parameter TagSpecification /// /// /// The tags to assign to the Elastic IP address. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("TagSpecifications")] public Amazon.EC2.Model.TagSpecification[] TagSpecification { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is '*'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.AllocateAddressResponse). /// Specifying the name of a property of type Amazon.EC2.Model.AllocateAddressResponse 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; } = "*"; #endregion #region Parameter Force /// /// This parameter overrides confirmation prompts to force /// the cmdlet to continue its operation. This parameter should always /// be used with caution. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter Force { get; set; } #endregion protected override void ProcessRecord() { this._AWSSignerType = "v4"; base.ProcessRecord(); var resourceIdentifiersText = string.Empty; if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-EC2Address (AllocateAddress)")) { return; } 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.Address = this.Address; context.CustomerOwnedIpv4Pool = this.CustomerOwnedIpv4Pool; context.Domain = this.Domain; context.NetworkBorderGroup = this.NetworkBorderGroup; context.PublicIpv4Pool = this.PublicIpv4Pool; if (this.TagSpecification != null) { context.TagSpecification = new List(this.TagSpecification); } // 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.AllocateAddressRequest(); if (cmdletContext.Address != null) { request.Address = cmdletContext.Address; } if (cmdletContext.CustomerOwnedIpv4Pool != null) { request.CustomerOwnedIpv4Pool = cmdletContext.CustomerOwnedIpv4Pool; } if (cmdletContext.Domain != null) { request.Domain = cmdletContext.Domain; } if (cmdletContext.NetworkBorderGroup != null) { request.NetworkBorderGroup = cmdletContext.NetworkBorderGroup; } if (cmdletContext.PublicIpv4Pool != null) { request.PublicIpv4Pool = cmdletContext.PublicIpv4Pool; } if (cmdletContext.TagSpecification != null) { request.TagSpecifications = cmdletContext.TagSpecification; } 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.AllocateAddressResponse CallAWSServiceOperation(IAmazonEC2 client, Amazon.EC2.Model.AllocateAddressRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Elastic Compute Cloud (EC2)", "AllocateAddress"); try { #if DESKTOP return client.AllocateAddress(request); #elif CORECLR return client.AllocateAddressAsync(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 Address { get; set; } public System.String CustomerOwnedIpv4Pool { get; set; } public Amazon.EC2.DomainType Domain { get; set; } public System.String NetworkBorderGroup { get; set; } public System.String PublicIpv4Pool { get; set; } public List TagSpecification { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }