/******************************************************************************* * 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 { /// /// Creates a NAT gateway in the specified subnet. This action creates a network interface /// in the specified subnet with a private IP address from the IP address range of the /// subnet. You can create either a public NAT gateway or a private NAT gateway. /// /// /// /// With a public NAT gateway, internet-bound traffic from a private subnet can be routed /// to the NAT gateway, so that instances in a private subnet can connect to the internet. /// /// With a private NAT gateway, private communication is routed across VPCs and on-premises /// networks through a transit gateway or virtual private gateway. Common use cases include /// running large workloads behind a small pool of allowlisted IPv4 addresses, preserving /// private IPv4 addresses, and communicating between overlapping networks. /// /// For more information, see NAT /// gateways in the Amazon VPC User Guide. /// /// [Cmdlet("New", "EC2NatGateway", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.EC2.Model.CreateNatGatewayResponse")] [AWSCmdlet("Calls the Amazon Elastic Compute Cloud (EC2) CreateNatGateway API operation.", Operation = new[] {"CreateNatGateway"}, SelectReturnType = typeof(Amazon.EC2.Model.CreateNatGatewayResponse))] [AWSCmdletOutput("Amazon.EC2.Model.CreateNatGatewayResponse", "This cmdlet returns an Amazon.EC2.Model.CreateNatGatewayResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewEC2NatGatewayCmdlet : AmazonEC2ClientCmdlet, IExecutor { #region Parameter AllocationId /// /// /// [Public NAT gateways only] The allocation ID of an Elastic IP address to associate /// with the NAT gateway. You cannot specify an Elastic IP address with a private NAT /// gateway. If the Elastic IP address is associated with another resource, you must first /// disassociate it. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String AllocationId { get; set; } #endregion #region Parameter ConnectivityType /// /// /// Indicates whether the NAT gateway supports public or private connectivity. The default /// is public connectivity. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.EC2.ConnectivityType")] public Amazon.EC2.ConnectivityType ConnectivityType { get; set; } #endregion #region Parameter PrivateIpAddress /// /// /// The private IPv4 address to assign to the NAT gateway. If you don't provide an address, /// a private IPv4 address will be automatically assigned. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String PrivateIpAddress { get; set; } #endregion #region Parameter SecondaryAllocationId /// /// /// Secondary EIP allocation IDs. For more information, see Create /// a NAT gateway in the Amazon VPC User Guide. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("SecondaryAllocationIds")] public System.String[] SecondaryAllocationId { get; set; } #endregion #region Parameter SecondaryPrivateIpAddressCount /// /// /// [Private NAT gateway only] The number of secondary private IPv4 addresses you want /// to assign to the NAT gateway. For more information about secondary addresses, see /// Create /// a NAT gateway in the Amazon VPC User Guide. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? SecondaryPrivateIpAddressCount { get; set; } #endregion #region Parameter SecondaryPrivateIpAddress /// /// /// Secondary private IPv4 addresses. For more information about secondary addresses, /// see Create /// a NAT gateway in the Amazon VPC User Guide. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("SecondaryPrivateIpAddresses")] public System.String[] SecondaryPrivateIpAddress { get; set; } #endregion #region Parameter SubnetId /// /// /// The ID of the subnet in which to create the NAT gateway. /// /// #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 SubnetId { get; set; } #endregion #region Parameter TagSpecification /// /// /// The tags to assign to the NAT gateway. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("TagSpecifications")] public Amazon.EC2.Model.TagSpecification[] TagSpecification { get; set; } #endregion #region Parameter ClientToken /// /// /// Unique, case-sensitive identifier that you provide to ensure the idempotency of the /// request. For more information, see How /// to ensure idempotency.Constraint: Maximum 64 ASCII characters. /// /// [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 '*'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.CreateNatGatewayResponse). /// Specifying the name of a property of type Amazon.EC2.Model.CreateNatGatewayResponse 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 PassThru /// /// Changes the cmdlet behavior to return the value passed to the SubnetId parameter. /// The -PassThru parameter is deprecated, use -Select '^SubnetId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^SubnetId' 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.SubnetId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-EC2NatGateway (CreateNatGateway)")) { 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.SubnetId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.AllocationId = this.AllocationId; context.ClientToken = this.ClientToken; context.ConnectivityType = this.ConnectivityType; context.PrivateIpAddress = this.PrivateIpAddress; if (this.SecondaryAllocationId != null) { context.SecondaryAllocationId = new List(this.SecondaryAllocationId); } context.SecondaryPrivateIpAddressCount = this.SecondaryPrivateIpAddressCount; if (this.SecondaryPrivateIpAddress != null) { context.SecondaryPrivateIpAddress = new List(this.SecondaryPrivateIpAddress); } context.SubnetId = this.SubnetId; #if MODULAR if (this.SubnetId == null && ParameterWasBound(nameof(this.SubnetId))) { WriteWarning("You are passing $null as a value for parameter SubnetId 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 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.CreateNatGatewayRequest(); if (cmdletContext.AllocationId != null) { request.AllocationId = cmdletContext.AllocationId; } if (cmdletContext.ClientToken != null) { request.ClientToken = cmdletContext.ClientToken; } if (cmdletContext.ConnectivityType != null) { request.ConnectivityType = cmdletContext.ConnectivityType; } if (cmdletContext.PrivateIpAddress != null) { request.PrivateIpAddress = cmdletContext.PrivateIpAddress; } if (cmdletContext.SecondaryAllocationId != null) { request.SecondaryAllocationIds = cmdletContext.SecondaryAllocationId; } if (cmdletContext.SecondaryPrivateIpAddressCount != null) { request.SecondaryPrivateIpAddressCount = cmdletContext.SecondaryPrivateIpAddressCount.Value; } if (cmdletContext.SecondaryPrivateIpAddress != null) { request.SecondaryPrivateIpAddresses = cmdletContext.SecondaryPrivateIpAddress; } if (cmdletContext.SubnetId != null) { request.SubnetId = cmdletContext.SubnetId; } 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.CreateNatGatewayResponse CallAWSServiceOperation(IAmazonEC2 client, Amazon.EC2.Model.CreateNatGatewayRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Elastic Compute Cloud (EC2)", "CreateNatGateway"); try { #if DESKTOP return client.CreateNatGateway(request); #elif CORECLR return client.CreateNatGatewayAsync(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 AllocationId { get; set; } public System.String ClientToken { get; set; } public Amazon.EC2.ConnectivityType ConnectivityType { get; set; } public System.String PrivateIpAddress { get; set; } public List SecondaryAllocationId { get; set; } public System.Int32? SecondaryPrivateIpAddressCount { get; set; } public List SecondaryPrivateIpAddress { get; set; } public System.String SubnetId { get; set; } public List TagSpecification { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }