/*******************************************************************************
* 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 network interface in the specified subnet.
///
///
///
/// The number of IP addresses you can assign to a network interface varies by instance
/// type. For more information, see IP
/// Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User
/// Guide.
///
/// For more information about network interfaces, see Elastic
/// network interfaces in the Amazon Elastic Compute Cloud User Guide.
///
///
[Cmdlet("New", "EC2NetworkInterface", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.EC2.Model.NetworkInterface")]
[AWSCmdlet("Calls the Amazon Elastic Compute Cloud (EC2) CreateNetworkInterface API operation.", Operation = new[] {"CreateNetworkInterface"}, SelectReturnType = typeof(Amazon.EC2.Model.CreateNetworkInterfaceResponse))]
[AWSCmdletOutput("Amazon.EC2.Model.NetworkInterface or Amazon.EC2.Model.CreateNetworkInterfaceResponse",
"This cmdlet returns an Amazon.EC2.Model.NetworkInterface object.",
"The service call response (type Amazon.EC2.Model.CreateNetworkInterfaceResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewEC2NetworkInterfaceCmdlet : AmazonEC2ClientCmdlet, IExecutor
{
#region Parameter Description
///
///
/// A description for the network interface.
///
///
[System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)]
public System.String Description { get; set; }
#endregion
#region Parameter Group
///
///
/// The IDs of one or more security groups.
///
///
[System.Management.Automation.Parameter(Position = 3, ValueFromPipelineByPropertyName = true)]
[Alias("GroupId","Groups")]
public System.String[] Group { get; set; }
#endregion
#region Parameter InterfaceType
///
///
/// The type of network interface. The default is interface
.The only supported values are interface
, efa
, and trunk
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.EC2.NetworkInterfaceCreationType")]
public Amazon.EC2.NetworkInterfaceCreationType InterfaceType { get; set; }
#endregion
#region Parameter Ipv4PrefixCount
///
///
/// The number of IPv4 prefixes that Amazon Web Services automatically assigns to the
/// network interface.You can't specify a count of IPv4 prefixes if you've specified one of the following:
/// specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4
/// addresses.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Int32? Ipv4PrefixCount { get; set; }
#endregion
#region Parameter Ipv4Prefix
///
///
/// The IPv4 prefixes assigned to the network interface.You can't specify IPv4 prefixes if you've specified one of the following: a count
/// of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Ipv4Prefixes")]
public Amazon.EC2.Model.Ipv4PrefixSpecificationRequest[] Ipv4Prefix { get; set; }
#endregion
#region Parameter Ipv6AddressCount
///
///
/// The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically
/// selects the IPv6 addresses from the subnet range.You can't specify a count of IPv6 addresses using this parameter if you've specified
/// one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count
/// of IPv6 prefixes.If your subnet has the AssignIpv6AddressOnCreation
attribute set, you
/// can override that setting by specifying 0 as the IPv6 address count.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Int32? Ipv6AddressCount { get; set; }
#endregion
#region Parameter Ipv6Address
///
///
/// The IPv6 addresses from the IPv6 CIDR block range of your subnet.You can't specify IPv6 addresses using this parameter if you've specified one of the
/// following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Ipv6Addresses")]
public Amazon.EC2.Model.InstanceIpv6Address[] Ipv6Address { get; set; }
#endregion
#region Parameter Ipv6PrefixCount
///
///
/// The number of IPv6 prefixes that Amazon Web Services automatically assigns to the
/// network interface.You can't specify a count of IPv6 prefixes if you've specified one of the following:
/// specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Int32? Ipv6PrefixCount { get; set; }
#endregion
#region Parameter Ipv6Prefix
///
///
/// The IPv6 prefixes assigned to the network interface.You can't specify IPv6 prefixes if you've specified one of the following: a count
/// of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Ipv6Prefixes")]
public Amazon.EC2.Model.Ipv6PrefixSpecificationRequest[] Ipv6Prefix { get; set; }
#endregion
#region Parameter PrivateIpAddress
///
///
/// The primary private IPv4 address of the network interface. If you don't specify an
/// IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If
/// you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses
/// as primary (only one IP address can be designated as primary).
///
///
[System.Management.Automation.Parameter(Position = 2, ValueFromPipelineByPropertyName = true)]
public System.String PrivateIpAddress { get; set; }
#endregion
#region Parameter PrivateIpAddressSet
///
///
/// The private IPv4 addresses.You can't specify private IPv4 addresses if you've specified one of the following:
/// a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("PrivateIpAddresses")]
public Amazon.EC2.Model.PrivateIpAddressSpecification[] PrivateIpAddressSet { get; set; }
#endregion
#region Parameter SecondaryPrivateIpAddressCount
///
///
/// The number of secondary private IPv4 addresses to assign to a network interface. When
/// you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses
/// within the subnet's IPv4 CIDR range. You can't specify this option and specify more
/// than one private IP address using privateIpAddresses
.You can't specify a count of private IPv4 addresses if you've specified one of the
/// following: specific private IPv4 addresses, specific IPv4 prefixes, or a count of
/// IPv4 prefixes.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Int32? SecondaryPrivateIpAddressCount { get; set; }
#endregion
#region Parameter SubnetId
///
///
/// The ID of the subnet to associate with the network interface.
///
///
#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 apply to the new network interface.
///
///
[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 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 'NetworkInterface'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.CreateNetworkInterfaceResponse).
/// Specifying the name of a property of type Amazon.EC2.Model.CreateNetworkInterfaceResponse 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; } = "NetworkInterface";
#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-EC2NetworkInterface (CreateNetworkInterface)"))
{
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.ClientToken = this.ClientToken;
context.Description = this.Description;
if (this.Group != null)
{
context.Group = new List(this.Group);
}
context.InterfaceType = this.InterfaceType;
context.Ipv4PrefixCount = this.Ipv4PrefixCount;
if (this.Ipv4Prefix != null)
{
context.Ipv4Prefix = new List(this.Ipv4Prefix);
}
context.Ipv6AddressCount = this.Ipv6AddressCount;
if (this.Ipv6Address != null)
{
context.Ipv6Address = new List(this.Ipv6Address);
}
context.Ipv6PrefixCount = this.Ipv6PrefixCount;
if (this.Ipv6Prefix != null)
{
context.Ipv6Prefix = new List(this.Ipv6Prefix);
}
context.PrivateIpAddress = this.PrivateIpAddress;
if (this.PrivateIpAddressSet != null)
{
context.PrivateIpAddressSet = new List(this.PrivateIpAddressSet);
}
context.SecondaryPrivateIpAddressCount = this.SecondaryPrivateIpAddressCount;
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.CreateNetworkInterfaceRequest();
if (cmdletContext.ClientToken != null)
{
request.ClientToken = cmdletContext.ClientToken;
}
if (cmdletContext.Description != null)
{
request.Description = cmdletContext.Description;
}
if (cmdletContext.Group != null)
{
request.Groups = cmdletContext.Group;
}
if (cmdletContext.InterfaceType != null)
{
request.InterfaceType = cmdletContext.InterfaceType;
}
if (cmdletContext.Ipv4PrefixCount != null)
{
request.Ipv4PrefixCount = cmdletContext.Ipv4PrefixCount.Value;
}
if (cmdletContext.Ipv4Prefix != null)
{
request.Ipv4Prefixes = cmdletContext.Ipv4Prefix;
}
if (cmdletContext.Ipv6AddressCount != null)
{
request.Ipv6AddressCount = cmdletContext.Ipv6AddressCount.Value;
}
if (cmdletContext.Ipv6Address != null)
{
request.Ipv6Addresses = cmdletContext.Ipv6Address;
}
if (cmdletContext.Ipv6PrefixCount != null)
{
request.Ipv6PrefixCount = cmdletContext.Ipv6PrefixCount.Value;
}
if (cmdletContext.Ipv6Prefix != null)
{
request.Ipv6Prefixes = cmdletContext.Ipv6Prefix;
}
if (cmdletContext.PrivateIpAddress != null)
{
request.PrivateIpAddress = cmdletContext.PrivateIpAddress;
}
if (cmdletContext.PrivateIpAddressSet != null)
{
request.PrivateIpAddresses = cmdletContext.PrivateIpAddressSet;
}
if (cmdletContext.SecondaryPrivateIpAddressCount != null)
{
request.SecondaryPrivateIpAddressCount = cmdletContext.SecondaryPrivateIpAddressCount.Value;
}
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.CreateNetworkInterfaceResponse CallAWSServiceOperation(IAmazonEC2 client, Amazon.EC2.Model.CreateNetworkInterfaceRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Elastic Compute Cloud (EC2)", "CreateNetworkInterface");
try
{
#if DESKTOP
return client.CreateNetworkInterface(request);
#elif CORECLR
return client.CreateNetworkInterfaceAsync(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 ClientToken { get; set; }
public System.String Description { get; set; }
public List Group { get; set; }
public Amazon.EC2.NetworkInterfaceCreationType InterfaceType { get; set; }
public System.Int32? Ipv4PrefixCount { get; set; }
public List Ipv4Prefix { get; set; }
public System.Int32? Ipv6AddressCount { get; set; }
public List Ipv6Address { get; set; }
public System.Int32? Ipv6PrefixCount { get; set; }
public List Ipv6Prefix { get; set; }
public System.String PrivateIpAddress { get; set; }
public List PrivateIpAddressSet { get; set; }
public System.Int32? SecondaryPrivateIpAddressCount { get; set; }
public System.String SubnetId { get; set; }
public List TagSpecification { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.NetworkInterface;
}
}
}