/*******************************************************************************
* 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 the specified attribute of the specified instance. You can specify only one
/// attribute at a time.
///
///
/// Note: Using this action to change the security groups associated with an elastic
/// network interface (ENI) attached to an instance can result in an error if the instance
/// has more than one ENI. To change the security groups associated with an ENI attached
/// to an instance that has multiple ENIs, we recommend that you use the ModifyNetworkInterfaceAttribute
/// action.
///
/// To modify some attributes, the instance must be stopped. For more information, see
/// Modify
/// a stopped instance in the Amazon EC2 User Guide.
///
///
[Cmdlet("Edit", "EC2InstanceAttribute", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("None")]
[AWSCmdlet("Calls the Amazon Elastic Compute Cloud (EC2) ModifyInstanceAttribute API operation.", Operation = new[] {"ModifyInstanceAttribute"}, SelectReturnType = typeof(Amazon.EC2.Model.ModifyInstanceAttributeResponse))]
[AWSCmdletOutput("None or Amazon.EC2.Model.ModifyInstanceAttributeResponse",
"This cmdlet does not generate any output." +
"The service response (type Amazon.EC2.Model.ModifyInstanceAttributeResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class EditEC2InstanceAttributeCmdlet : AmazonEC2ClientCmdlet, IExecutor
{
#region Parameter Attribute
///
///
/// The name of the attribute to modify.You can modify the following attributes only: disableApiTermination
|
/// instanceType
| kernel
| ramdisk
| instanceInitiatedShutdownBehavior
/// | blockDeviceMapping
| userData
| sourceDestCheck
/// | groupSet
| ebsOptimized
| sriovNetSupport
/// | enaSupport
| nvmeSupport
| disableApiStop
/// | enclaveOptions
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.EC2.InstanceAttributeName")]
public Amazon.EC2.InstanceAttributeName Attribute { get; set; }
#endregion
#region Parameter BlockDeviceMapping
///
///
/// Modifies the DeleteOnTermination
attribute for volumes that are currently
/// attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination
,
/// the default is true
and the volume is deleted when the instance is terminated.To add instance store volumes to an Amazon EBS-backed instance, you must add them
/// when you launch the instance. For more information, see Update
/// the block device mapping when launching an instance in the Amazon EC2 User
/// Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("BlockDeviceMappings")]
public Amazon.EC2.Model.InstanceBlockDeviceMappingSpecification[] BlockDeviceMapping { get; set; }
#endregion
#region Parameter DisableApiStop
///
///
/// Indicates whether an instance is enabled for stop protection. For more information,
/// see Stop
/// Protection.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? DisableApiStop { get; set; }
#endregion
#region Parameter DisableApiTermination
///
///
/// If the value is true
, you can't terminate the instance using the Amazon
/// EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot
/// Instances.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? DisableApiTermination { get; set; }
#endregion
#region Parameter EbsOptimized
///
///
/// Specifies whether the instance is optimized for Amazon EBS I/O. This optimization
/// provides dedicated throughput to Amazon EBS and an optimized configuration stack to
/// provide optimal EBS I/O performance. This optimization isn't available with all instance
/// types. Additional usage charges apply when using an EBS Optimized instance.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? EbsOptimized { get; set; }
#endregion
#region Parameter EnaSupport
///
///
/// Set to true
to enable enhanced networking with ENA for the instance.This option is supported only for HVM instances. Specifying this option with a PV
/// instance can make it unreachable.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? EnaSupport { get; set; }
#endregion
#region Parameter Group
///
///
/// Replaces the security groups of the instance with the specified security groups. You
/// must specify the ID of at least one security group, even if it's just the default
/// security group for the VPC.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("GroupId","Groups")]
public System.String[] Group { get; set; }
#endregion
#region Parameter InstanceId
///
///
/// The ID of the instance.
///
///
#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 InstanceId { get; set; }
#endregion
#region Parameter InstanceInitiatedShutdownBehavior
///
///
/// Specifies whether an instance stops or terminates when you initiate shutdown from
/// the instance (using the operating system command for system shutdown).
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String InstanceInitiatedShutdownBehavior { get; set; }
#endregion
#region Parameter InstanceType
///
///
/// Changes the instance type to the specified value. For more information, see Instance
/// types in the Amazon EC2 User Guide. If the instance type is not valid,
/// the error returned is InvalidInstanceAttributeValue
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String InstanceType { get; set; }
#endregion
#region Parameter Kernel
///
///
/// Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB
/// instead of kernels and RAM disks. For more information, see PV-GRUB.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Kernel { get; set; }
#endregion
#region Parameter Ramdisk
///
///
/// Changes the instance's RAM disk to the specified value. We recommend that you use
/// PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Ramdisk { get; set; }
#endregion
#region Parameter SourceDestCheck
///
///
/// Enable or disable source/destination checks, which ensure that the instance is either
/// the source or the destination of any traffic that it receives. If the value is true
,
/// source/destination checks are enabled; otherwise, they are disabled. The default value
/// is true
. You must disable source/destination checks if the instance runs
/// services such as network address translation, routing, or firewalls.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? SourceDestCheck { get; set; }
#endregion
#region Parameter SriovNetSupport
///
///
/// Set to simple
to enable enhanced networking with the Intel 82599 Virtual
/// Function interface for the instance.There is no way to disable enhanced networking with the Intel 82599 Virtual Function
/// interface at this time.This option is supported only for HVM instances. Specifying this option with a PV
/// instance can make it unreachable.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String SriovNetSupport { get; set; }
#endregion
#region Parameter UserData
///
///
/// Changes the instance's user data to the specified value. If you are using an Amazon
/// Web Services SDK or command line tool, base64-encoding is performed for you, and you
/// can load the text from a file. Otherwise, you must provide base64-encoded text.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String UserData { get; set; }
#endregion
#region Parameter Value
///
///
/// A new value for the attribute. Use only with the kernel
, ramdisk
,
/// userData
, disableApiTermination
, or instanceInitiatedShutdownBehavior
/// attribute.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Value { 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.ModifyInstanceAttributeResponse).
/// 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 InstanceId parameter.
/// The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^InstanceId' 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.InstanceId), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Edit-EC2InstanceAttribute (ModifyInstanceAttribute)"))
{
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.InstanceId;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.Attribute = this.Attribute;
if (this.BlockDeviceMapping != null)
{
context.BlockDeviceMapping = new List(this.BlockDeviceMapping);
}
context.DisableApiStop = this.DisableApiStop;
context.DisableApiTermination = this.DisableApiTermination;
context.EbsOptimized = this.EbsOptimized;
context.EnaSupport = this.EnaSupport;
if (this.Group != null)
{
context.Group = new List(this.Group);
}
context.InstanceId = this.InstanceId;
#if MODULAR
if (this.InstanceId == null && ParameterWasBound(nameof(this.InstanceId)))
{
WriteWarning("You are passing $null as a value for parameter InstanceId 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.InstanceInitiatedShutdownBehavior = this.InstanceInitiatedShutdownBehavior;
context.InstanceType = this.InstanceType;
context.Kernel = this.Kernel;
context.Ramdisk = this.Ramdisk;
context.SourceDestCheck = this.SourceDestCheck;
context.SriovNetSupport = this.SriovNetSupport;
context.UserData = this.UserData;
context.Value = this.Value;
// 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.ModifyInstanceAttributeRequest();
if (cmdletContext.Attribute != null)
{
request.Attribute = cmdletContext.Attribute;
}
if (cmdletContext.BlockDeviceMapping != null)
{
request.BlockDeviceMappings = cmdletContext.BlockDeviceMapping;
}
if (cmdletContext.DisableApiStop != null)
{
request.DisableApiStop = cmdletContext.DisableApiStop.Value;
}
if (cmdletContext.DisableApiTermination != null)
{
request.DisableApiTermination = cmdletContext.DisableApiTermination.Value;
}
if (cmdletContext.EbsOptimized != null)
{
request.EbsOptimized = cmdletContext.EbsOptimized.Value;
}
if (cmdletContext.EnaSupport != null)
{
request.EnaSupport = cmdletContext.EnaSupport.Value;
}
if (cmdletContext.Group != null)
{
request.Groups = cmdletContext.Group;
}
if (cmdletContext.InstanceId != null)
{
request.InstanceId = cmdletContext.InstanceId;
}
if (cmdletContext.InstanceInitiatedShutdownBehavior != null)
{
request.InstanceInitiatedShutdownBehavior = cmdletContext.InstanceInitiatedShutdownBehavior;
}
if (cmdletContext.InstanceType != null)
{
request.InstanceType = cmdletContext.InstanceType;
}
if (cmdletContext.Kernel != null)
{
request.Kernel = cmdletContext.Kernel;
}
if (cmdletContext.Ramdisk != null)
{
request.Ramdisk = cmdletContext.Ramdisk;
}
if (cmdletContext.SourceDestCheck != null)
{
request.SourceDestCheck = cmdletContext.SourceDestCheck.Value;
}
if (cmdletContext.SriovNetSupport != null)
{
request.SriovNetSupport = cmdletContext.SriovNetSupport;
}
if (cmdletContext.UserData != null)
{
request.UserData = cmdletContext.UserData;
}
if (cmdletContext.Value != null)
{
request.Value = cmdletContext.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.ModifyInstanceAttributeResponse CallAWSServiceOperation(IAmazonEC2 client, Amazon.EC2.Model.ModifyInstanceAttributeRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Elastic Compute Cloud (EC2)", "ModifyInstanceAttribute");
try
{
#if DESKTOP
return client.ModifyInstanceAttribute(request);
#elif CORECLR
return client.ModifyInstanceAttributeAsync(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.InstanceAttributeName Attribute { get; set; }
public List BlockDeviceMapping { get; set; }
public System.Boolean? DisableApiStop { get; set; }
public System.Boolean? DisableApiTermination { get; set; }
public System.Boolean? EbsOptimized { get; set; }
public System.Boolean? EnaSupport { get; set; }
public List Group { get; set; }
public System.String InstanceId { get; set; }
public System.String InstanceInitiatedShutdownBehavior { get; set; }
public System.String InstanceType { get; set; }
public System.String Kernel { get; set; }
public System.String Ramdisk { get; set; }
public System.Boolean? SourceDestCheck { get; set; }
public System.String SriovNetSupport { get; set; }
public System.String UserData { get; set; }
public System.String Value { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => null;
}
}
}