/******************************************************************************* * 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 { /// /// Allocate a CIDR from an IPAM pool. The Region you use should be the IPAM pool locale. /// The locale is the Amazon Web Services Region where this IPAM pool is available for /// allocations. /// /// /// /// In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool /// or to a resource. For more information, see Allocate /// CIDRs in the Amazon VPC IPAM User Guide. /// /// This action creates an allocation with strong consistency. The returned CIDR will /// not overlap with any other allocations from the same pool. /// /// [Cmdlet("New", "EC2IpamPoolCidr", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.EC2.Model.IpamPoolAllocation")] [AWSCmdlet("Calls the Amazon Elastic Compute Cloud (EC2) AllocateIpamPoolCidr API operation.", Operation = new[] {"AllocateIpamPoolCidr"}, SelectReturnType = typeof(Amazon.EC2.Model.AllocateIpamPoolCidrResponse))] [AWSCmdletOutput("Amazon.EC2.Model.IpamPoolAllocation or Amazon.EC2.Model.AllocateIpamPoolCidrResponse", "This cmdlet returns an Amazon.EC2.Model.IpamPoolAllocation object.", "The service call response (type Amazon.EC2.Model.AllocateIpamPoolCidrResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewEC2IpamPoolCidrCmdlet : AmazonEC2ClientCmdlet, IExecutor { #region Parameter Cidr /// /// /// The CIDR you would like to allocate from the IPAM pool. Note the following:Possible values: Any available IPv4 or IPv6 CIDR. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Cidr { get; set; } #endregion #region Parameter Description /// /// /// A description for the allocation. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Description { get; set; } #endregion #region Parameter DisallowedCidr /// /// /// Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs /// are only allowed if using netmask length for allocation. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("DisallowedCidrs")] public System.String[] DisallowedCidr { get; set; } #endregion #region Parameter IpamPoolId /// /// /// The ID of the IPAM pool from which you would like to allocate a CIDR. /// /// #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.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String IpamPoolId { get; set; } #endregion #region Parameter NetmaskLength /// /// /// The netmask length of the CIDR you would like to allocate from the IPAM pool. Note /// the following:Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for /// IPv6 addresses are 0 - 128. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? NetmaskLength { get; set; } #endregion #region Parameter PreviewNextCidr /// /// /// A preview of the next available CIDR in a pool. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? PreviewNextCidr { get; set; } #endregion #region Parameter ClientToken /// /// /// A unique, case-sensitive identifier that you provide to ensure the idempotency of /// the request. For more information, see Ensuring /// Idempotency. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ClientToken { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'IpamPoolAllocation'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.AllocateIpamPoolCidrResponse). /// Specifying the name of a property of type Amazon.EC2.Model.AllocateIpamPoolCidrResponse 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; } = "IpamPoolAllocation"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the IpamPoolId parameter. /// The -PassThru parameter is deprecated, use -Select '^IpamPoolId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^IpamPoolId' instead. This parameter will be removed in a future version.")] [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter PassThru { 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 = FormatParameterValuesForConfirmationMsg(nameof(this.IpamPoolId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-EC2IpamPoolCidr (AllocateIpamPoolCidr)")) { return; } 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.IpamPoolId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.Cidr = this.Cidr; context.ClientToken = this.ClientToken; context.Description = this.Description; if (this.DisallowedCidr != null) { context.DisallowedCidr = new List(this.DisallowedCidr); } context.IpamPoolId = this.IpamPoolId; #if MODULAR if (this.IpamPoolId == null && ParameterWasBound(nameof(this.IpamPoolId))) { WriteWarning("You are passing $null as a value for parameter IpamPoolId 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.NetmaskLength = this.NetmaskLength; context.PreviewNextCidr = this.PreviewNextCidr; // 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.AllocateIpamPoolCidrRequest(); if (cmdletContext.Cidr != null) { request.Cidr = cmdletContext.Cidr; } if (cmdletContext.ClientToken != null) { request.ClientToken = cmdletContext.ClientToken; } if (cmdletContext.Description != null) { request.Description = cmdletContext.Description; } if (cmdletContext.DisallowedCidr != null) { request.DisallowedCidrs = cmdletContext.DisallowedCidr; } if (cmdletContext.IpamPoolId != null) { request.IpamPoolId = cmdletContext.IpamPoolId; } if (cmdletContext.NetmaskLength != null) { request.NetmaskLength = cmdletContext.NetmaskLength.Value; } if (cmdletContext.PreviewNextCidr != null) { request.PreviewNextCidr = cmdletContext.PreviewNextCidr.Value; } 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.AllocateIpamPoolCidrResponse CallAWSServiceOperation(IAmazonEC2 client, Amazon.EC2.Model.AllocateIpamPoolCidrRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Elastic Compute Cloud (EC2)", "AllocateIpamPoolCidr"); try { #if DESKTOP return client.AllocateIpamPoolCidr(request); #elif CORECLR return client.AllocateIpamPoolCidrAsync(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 Cidr { get; set; } public System.String ClientToken { get; set; } public System.String Description { get; set; } public List DisallowedCidr { get; set; } public System.String IpamPoolId { get; set; } public System.Int32? NetmaskLength { get; set; } public System.Boolean? PreviewNextCidr { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.IpamPoolAllocation; } } }