/******************************************************************************* * 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 { /// /// Create an IP address pool for Amazon VPC IP Address Manager (IPAM). In IPAM, a pool /// is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your /// IP addresses according to your routing and security needs. For example, if you have /// separate routing and security needs for development and production applications, you /// can create a pool for each. /// /// /// /// For more information, see Create /// a top-level pool in the Amazon VPC IPAM User Guide. /// /// [Cmdlet("New", "EC2IpamPool", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.EC2.Model.IpamPool")] [AWSCmdlet("Calls the Amazon Elastic Compute Cloud (EC2) CreateIpamPool API operation.", Operation = new[] {"CreateIpamPool"}, SelectReturnType = typeof(Amazon.EC2.Model.CreateIpamPoolResponse))] [AWSCmdletOutput("Amazon.EC2.Model.IpamPool or Amazon.EC2.Model.CreateIpamPoolResponse", "This cmdlet returns an Amazon.EC2.Model.IpamPool object.", "The service call response (type Amazon.EC2.Model.CreateIpamPoolResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewEC2IpamPoolCmdlet : AmazonEC2ClientCmdlet, IExecutor { #region Parameter AddressFamily /// /// /// The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol /// for a pool. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [AWSConstantClassSource("Amazon.EC2.AddressFamily")] public Amazon.EC2.AddressFamily AddressFamily { get; set; } #endregion #region Parameter AllocationDefaultNetmaskLength /// /// /// The default netmask length for allocations added to this pool. If, for example, the /// CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will /// default to 10.0.0.0/16. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? AllocationDefaultNetmaskLength { get; set; } #endregion #region Parameter AllocationMaxNetmaskLength /// /// /// The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. /// The maximum netmask length must be greater than the minimum netmask length. 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? AllocationMaxNetmaskLength { get; set; } #endregion #region Parameter AllocationMinNetmaskLength /// /// /// The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. /// The minimum netmask length must be less than the maximum netmask length. 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? AllocationMinNetmaskLength { get; set; } #endregion #region Parameter AllocationResourceTag /// /// /// Tags that are required for resources that use CIDRs from this IPAM pool. Resources /// that do not have these tags will not be allowed to allocate space from the pool. If /// the resources have their tags changed after they have allocated space or if the allocation /// tagging requirements are changed on the pool, the resource may be marked as noncompliant. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("AllocationResourceTags")] public Amazon.EC2.Model.RequestIpamResourceTag[] AllocationResourceTag { get; set; } #endregion #region Parameter AutoImport /// /// /// If selected, IPAM will continuously look for resources within the CIDR range of this /// pool and automatically import them as allocations into your IPAM. The CIDRs that will /// be allocated for these resources must not already be allocated to other resources /// in order for the import to succeed. IPAM will import a CIDR regardless of its compliance /// with the pool's allocation rules, so a resource might be imported and subsequently /// marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import /// the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM /// will randomly import one of them only. A locale must be set on the pool for this feature to work. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? AutoImport { get; set; } #endregion #region Parameter AwsService /// /// /// Limits which service in Amazon Web Services that the pool can be used in. "ec2", for /// example, allows users to use space for Elastic IP addresses and VPCs. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.EC2.IpamPoolAwsService")] public Amazon.EC2.IpamPoolAwsService AwsService { get; set; } #endregion #region Parameter Description /// /// /// A description for the IPAM pool. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Description { get; set; } #endregion #region Parameter IpamScopeId /// /// /// The ID of the scope in which you would like to create the IPAM pool. /// /// #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 IpamScopeId { get; set; } #endregion #region Parameter Locale /// /// /// In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM /// pool available for allocations. Only resources in the same Region as the locale of /// the pool can get IP address allocations from the pool. You can only allocate a CIDR /// for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. /// Note that once you choose a Locale for a pool, you cannot modify it. If you do not /// choose a locale, resources in Regions others than the IPAM's home region cannot use /// CIDRs from this pool.Possible values: Any Amazon Web Services Region, such as us-east-1. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Locale { get; set; } #endregion #region Parameter PublicIpSource /// /// /// The IP address source for pools in the public scope. Only used for provisioning IP /// address CIDRs to pools in the public scope. Default is byoip. For more /// information, see Create /// IPv6 pools in the Amazon VPC IPAM User Guide. By default, you can add only /// one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool if PublicIpSource is /// amazon. For information on increasing the default limit, see /// Quotas for your IPAM in the Amazon VPC IPAM User Guide. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.EC2.IpamPoolPublicIpSource")] public Amazon.EC2.IpamPoolPublicIpSource PublicIpSource { get; set; } #endregion #region Parameter PubliclyAdvertisable /// /// /// Determines if the pool is publicly advertisable. This option is not available for /// pools with AddressFamily set to ipv4. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? PubliclyAdvertisable { get; set; } #endregion #region Parameter SourceIpamPoolId /// /// /// The ID of the source IPAM pool. Use this option to create a pool within an existing /// pool. Note that the CIDR you provision for the pool within the source pool must be /// available in the source pool's CIDR range. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String SourceIpamPoolId { get; set; } #endregion #region Parameter TagSpecification /// /// /// 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. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("TagSpecifications")] public Amazon.EC2.Model.TagSpecification[] TagSpecification { 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 'IpamPool'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.CreateIpamPoolResponse). /// Specifying the name of a property of type Amazon.EC2.Model.CreateIpamPoolResponse 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; } = "IpamPool"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the IpamScopeId parameter. /// The -PassThru parameter is deprecated, use -Select '^IpamScopeId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^IpamScopeId' 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.IpamScopeId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-EC2IpamPool (CreateIpamPool)")) { 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.IpamScopeId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.AddressFamily = this.AddressFamily; #if MODULAR if (this.AddressFamily == null && ParameterWasBound(nameof(this.AddressFamily))) { WriteWarning("You are passing $null as a value for parameter AddressFamily 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.AllocationDefaultNetmaskLength = this.AllocationDefaultNetmaskLength; context.AllocationMaxNetmaskLength = this.AllocationMaxNetmaskLength; context.AllocationMinNetmaskLength = this.AllocationMinNetmaskLength; if (this.AllocationResourceTag != null) { context.AllocationResourceTag = new List(this.AllocationResourceTag); } context.AutoImport = this.AutoImport; context.AwsService = this.AwsService; context.ClientToken = this.ClientToken; context.Description = this.Description; context.IpamScopeId = this.IpamScopeId; #if MODULAR if (this.IpamScopeId == null && ParameterWasBound(nameof(this.IpamScopeId))) { WriteWarning("You are passing $null as a value for parameter IpamScopeId 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.Locale = this.Locale; context.PublicIpSource = this.PublicIpSource; context.PubliclyAdvertisable = this.PubliclyAdvertisable; context.SourceIpamPoolId = this.SourceIpamPoolId; 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.CreateIpamPoolRequest(); if (cmdletContext.AddressFamily != null) { request.AddressFamily = cmdletContext.AddressFamily; } if (cmdletContext.AllocationDefaultNetmaskLength != null) { request.AllocationDefaultNetmaskLength = cmdletContext.AllocationDefaultNetmaskLength.Value; } if (cmdletContext.AllocationMaxNetmaskLength != null) { request.AllocationMaxNetmaskLength = cmdletContext.AllocationMaxNetmaskLength.Value; } if (cmdletContext.AllocationMinNetmaskLength != null) { request.AllocationMinNetmaskLength = cmdletContext.AllocationMinNetmaskLength.Value; } if (cmdletContext.AllocationResourceTag != null) { request.AllocationResourceTags = cmdletContext.AllocationResourceTag; } if (cmdletContext.AutoImport != null) { request.AutoImport = cmdletContext.AutoImport.Value; } if (cmdletContext.AwsService != null) { request.AwsService = cmdletContext.AwsService; } if (cmdletContext.ClientToken != null) { request.ClientToken = cmdletContext.ClientToken; } if (cmdletContext.Description != null) { request.Description = cmdletContext.Description; } if (cmdletContext.IpamScopeId != null) { request.IpamScopeId = cmdletContext.IpamScopeId; } if (cmdletContext.Locale != null) { request.Locale = cmdletContext.Locale; } if (cmdletContext.PublicIpSource != null) { request.PublicIpSource = cmdletContext.PublicIpSource; } if (cmdletContext.PubliclyAdvertisable != null) { request.PubliclyAdvertisable = cmdletContext.PubliclyAdvertisable.Value; } if (cmdletContext.SourceIpamPoolId != null) { request.SourceIpamPoolId = cmdletContext.SourceIpamPoolId; } 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.CreateIpamPoolResponse CallAWSServiceOperation(IAmazonEC2 client, Amazon.EC2.Model.CreateIpamPoolRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Elastic Compute Cloud (EC2)", "CreateIpamPool"); try { #if DESKTOP return client.CreateIpamPool(request); #elif CORECLR return client.CreateIpamPoolAsync(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 Amazon.EC2.AddressFamily AddressFamily { get; set; } public System.Int32? AllocationDefaultNetmaskLength { get; set; } public System.Int32? AllocationMaxNetmaskLength { get; set; } public System.Int32? AllocationMinNetmaskLength { get; set; } public List AllocationResourceTag { get; set; } public System.Boolean? AutoImport { get; set; } public Amazon.EC2.IpamPoolAwsService AwsService { get; set; } public System.String ClientToken { get; set; } public System.String Description { get; set; } public System.String IpamScopeId { get; set; } public System.String Locale { get; set; } public Amazon.EC2.IpamPoolPublicIpSource PublicIpSource { get; set; } public System.Boolean? PubliclyAdvertisable { get; set; } public System.String SourceIpamPoolId { get; set; } public List TagSpecification { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.IpamPool; } } }