/*******************************************************************************
* 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
{
///
/// Modifies a subnet attribute. You can only modify one attribute at a time.
///
///
///
/// Use this action to modify subnets on Amazon Web Services Outposts.
/// -
/// To modify a subnet on an Outpost rack, set both
MapCustomerOwnedIpOnLaunch
/// and CustomerOwnedIpv4Pool
. These two parameters act as a single attribute.
/// -
/// To modify a subnet on an Outpost server, set either
EnableLniAtDeviceIndex
/// or DisableLniAtDeviceIndex
.
///
/// For more information about Amazon Web Services Outposts, see the following:
///
///
[Cmdlet("Edit", "EC2SubnetAttribute", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("None")]
[AWSCmdlet("Calls the Amazon Elastic Compute Cloud (EC2) ModifySubnetAttribute API operation.", Operation = new[] {"ModifySubnetAttribute"}, SelectReturnType = typeof(Amazon.EC2.Model.ModifySubnetAttributeResponse))]
[AWSCmdletOutput("None or Amazon.EC2.Model.ModifySubnetAttributeResponse",
"This cmdlet does not generate any output." +
"The service response (type Amazon.EC2.Model.ModifySubnetAttributeResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class EditEC2SubnetAttributeCmdlet : AmazonEC2ClientCmdlet, IExecutor
{
#region Parameter AssignIpv6AddressOnCreation
///
///
/// Specify true
to indicate that network interfaces created in the specified
/// subnet should be assigned an IPv6 address. This includes a network interface that's
/// created when launching an instance into the subnet (the instance therefore receives
/// an IPv6 address). If you enable the IPv6 addressing feature for your subnet, your network interface
/// or instance only receives an IPv6 address if it's created using version 2016-11-15
/// or later of the Amazon EC2 API.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? AssignIpv6AddressOnCreation { get; set; }
#endregion
#region Parameter CustomerOwnedIpv4Pool
///
///
/// The customer-owned IPv4 address pool associated with the subnet.You must set this value when you specify true
for MapCustomerOwnedIpOnLaunch
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String CustomerOwnedIpv4Pool { get; set; }
#endregion
#region Parameter DisableLniAtDeviceIndex
///
///
/// Specify true
to indicate that local network interfaces at the current
/// position should be disabled.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? DisableLniAtDeviceIndex { get; set; }
#endregion
#region Parameter EnableDns64
///
///
/// Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet
/// should return synthetic IPv6 addresses for IPv4-only destinations.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? EnableDns64 { get; set; }
#endregion
#region Parameter EnableLniAtDeviceIndex
///
///
/// Indicates the device position for local network interfaces in this subnet. For example,
/// 1
indicates local network interfaces in this subnet are the secondary
/// network interface (eth1). A local network interface cannot be the primary network
/// interface (eth0).
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Int32? EnableLniAtDeviceIndex { get; set; }
#endregion
#region Parameter EnableResourceNameDnsAAAARecordOnLaunch
///
///
/// Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? EnableResourceNameDnsAAAARecordOnLaunch { get; set; }
#endregion
#region Parameter EnableResourceNameDnsARecordOnLaunch
///
///
/// Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? EnableResourceNameDnsARecordOnLaunch { get; set; }
#endregion
#region Parameter MapCustomerOwnedIpOnLaunch
///
///
/// Specify true
to indicate that network interfaces attached to instances
/// created in the specified subnet should be assigned a customer-owned IPv4 address.When this value is true
, you must specify the customer-owned IP pool
/// using CustomerOwnedIpv4Pool
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? MapCustomerOwnedIpOnLaunch { get; set; }
#endregion
#region Parameter MapPublicIpOnLaunch
///
///
/// Specify true
to indicate that network interfaces attached to instances
/// created in the specified subnet should be assigned a public IPv4 address.
///
///
[System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)]
public System.Boolean? MapPublicIpOnLaunch { get; set; }
#endregion
#region Parameter PrivateDnsHostnameTypeOnLaunch
///
///
/// The type of hostname to assign to instances in the subnet at launch. For IPv4-only
/// and dual-stack (IPv4 and IPv6) subnets, an instance DNS name can be based on the instance
/// IPv4 address (ip-name) or the instance ID (resource-name). For IPv6 only subnets,
/// an instance DNS name must be based on the instance ID (resource-name).
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.EC2.HostnameType")]
public Amazon.EC2.HostnameType PrivateDnsHostnameTypeOnLaunch { get; set; }
#endregion
#region Parameter SubnetId
///
///
/// The ID of the subnet.
///
///
#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 Select
///
/// Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.ModifySubnetAttributeResponse).
/// 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, "Edit-EC2SubnetAttribute (ModifySubnetAttribute)"))
{
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.AssignIpv6AddressOnCreation = this.AssignIpv6AddressOnCreation;
context.CustomerOwnedIpv4Pool = this.CustomerOwnedIpv4Pool;
context.DisableLniAtDeviceIndex = this.DisableLniAtDeviceIndex;
context.EnableDns64 = this.EnableDns64;
context.EnableLniAtDeviceIndex = this.EnableLniAtDeviceIndex;
context.EnableResourceNameDnsAAAARecordOnLaunch = this.EnableResourceNameDnsAAAARecordOnLaunch;
context.EnableResourceNameDnsARecordOnLaunch = this.EnableResourceNameDnsARecordOnLaunch;
context.MapCustomerOwnedIpOnLaunch = this.MapCustomerOwnedIpOnLaunch;
context.MapPublicIpOnLaunch = this.MapPublicIpOnLaunch;
context.PrivateDnsHostnameTypeOnLaunch = this.PrivateDnsHostnameTypeOnLaunch;
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
// 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.ModifySubnetAttributeRequest();
if (cmdletContext.AssignIpv6AddressOnCreation != null)
{
request.AssignIpv6AddressOnCreation = cmdletContext.AssignIpv6AddressOnCreation.Value;
}
if (cmdletContext.CustomerOwnedIpv4Pool != null)
{
request.CustomerOwnedIpv4Pool = cmdletContext.CustomerOwnedIpv4Pool;
}
if (cmdletContext.DisableLniAtDeviceIndex != null)
{
request.DisableLniAtDeviceIndex = cmdletContext.DisableLniAtDeviceIndex.Value;
}
if (cmdletContext.EnableDns64 != null)
{
request.EnableDns64 = cmdletContext.EnableDns64.Value;
}
if (cmdletContext.EnableLniAtDeviceIndex != null)
{
request.EnableLniAtDeviceIndex = cmdletContext.EnableLniAtDeviceIndex.Value;
}
if (cmdletContext.EnableResourceNameDnsAAAARecordOnLaunch != null)
{
request.EnableResourceNameDnsAAAARecordOnLaunch = cmdletContext.EnableResourceNameDnsAAAARecordOnLaunch.Value;
}
if (cmdletContext.EnableResourceNameDnsARecordOnLaunch != null)
{
request.EnableResourceNameDnsARecordOnLaunch = cmdletContext.EnableResourceNameDnsARecordOnLaunch.Value;
}
if (cmdletContext.MapCustomerOwnedIpOnLaunch != null)
{
request.MapCustomerOwnedIpOnLaunch = cmdletContext.MapCustomerOwnedIpOnLaunch.Value;
}
if (cmdletContext.MapPublicIpOnLaunch != null)
{
request.MapPublicIpOnLaunch = cmdletContext.MapPublicIpOnLaunch.Value;
}
if (cmdletContext.PrivateDnsHostnameTypeOnLaunch != null)
{
request.PrivateDnsHostnameTypeOnLaunch = cmdletContext.PrivateDnsHostnameTypeOnLaunch;
}
if (cmdletContext.SubnetId != null)
{
request.SubnetId = cmdletContext.SubnetId;
}
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.ModifySubnetAttributeResponse CallAWSServiceOperation(IAmazonEC2 client, Amazon.EC2.Model.ModifySubnetAttributeRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Elastic Compute Cloud (EC2)", "ModifySubnetAttribute");
try
{
#if DESKTOP
return client.ModifySubnetAttribute(request);
#elif CORECLR
return client.ModifySubnetAttributeAsync(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.Boolean? AssignIpv6AddressOnCreation { get; set; }
public System.String CustomerOwnedIpv4Pool { get; set; }
public System.Boolean? DisableLniAtDeviceIndex { get; set; }
public System.Boolean? EnableDns64 { get; set; }
public System.Int32? EnableLniAtDeviceIndex { get; set; }
public System.Boolean? EnableResourceNameDnsAAAARecordOnLaunch { get; set; }
public System.Boolean? EnableResourceNameDnsARecordOnLaunch { get; set; }
public System.Boolean? MapCustomerOwnedIpOnLaunch { get; set; }
public System.Boolean? MapPublicIpOnLaunch { get; set; }
public Amazon.EC2.HostnameType PrivateDnsHostnameTypeOnLaunch { get; set; }
public System.String SubnetId { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => null;
}
}
}