ModifyInstanceAttributeRequest Class

Container for the parameters to the ModifyInstanceAttribute operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.EC2.AmazonEC2Request
      Amazon.EC2.Model.ModifyInstanceAttributeRequest

Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z

Syntax

public class ModifyInstanceAttributeRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The ModifyInstanceAttributeRequest type exposes the following members

Constructors

	Name	Description
	ModifyInstanceAttributeRequest()	Empty constructor used to set properties independently even when a simple constructor is available
	ModifyInstanceAttributeRequest(string, InstanceAttributeName)	Instantiates ModifyInstanceAttributeRequest with the parameterized properties

Properties

Name	Type	Description
Attribute	Amazon.EC2.InstanceAttributeName	Gets and sets the property 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`
BlockDeviceMappings	System.Collections.Generic.List<Amazon.EC2.Model.InstanceBlockDeviceMappingSpecification>	Gets and sets the property BlockDeviceMappings. 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. You can't modify the `DeleteOnTermination` attribute for volumes that are attached to Fargate tasks. 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.
DisableApiStop	System.Boolean	Gets and sets the property DisableApiStop. Indicates whether an instance is enabled for stop protection. For more information, see Stop Protection.
DisableApiTermination	System.Boolean	Gets and sets the property 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.
EbsOptimized	System.Boolean	Gets and sets the property 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.
EnaSupport	System.Boolean	Gets and sets the property 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.
Groups	System.Collections.Generic.List<System.String>	Gets and sets the property Groups. 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.
InstanceId	System.String	Gets and sets the property InstanceId. The ID of the instance.
InstanceInitiatedShutdownBehavior	System.String	Gets and sets the property InstanceInitiatedShutdownBehavior. Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
InstanceType	System.String	Gets and sets the property 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`.
Kernel	System.String	Gets and sets the property 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.
Ramdisk	System.String	Gets and sets the property 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.
SourceDestCheck	System.Boolean	Gets and sets the property 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.
SriovNetSupport	System.String	Gets and sets the property 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.
UserData	System.String	Gets and sets the property 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.
Value	System.String	Gets and sets the property Value. A new value for the attribute. Use only with the `kernel`, `ramdisk`, `userData`, `disableApiTermination`, or `instanceInitiatedShutdownBehavior` attribute.

Examples

This example modifies the instance type of the specified stopped instance.

To modify the instance type


var client = new AmazonEC2Client();
var response = client.ModifyInstanceAttribute(new ModifyInstanceAttributeRequest 
{
    InstanceId = "i-1234567890abcdef0",
    InstanceType = <data>
});

This example enables enhanced networking for the specified stopped instance.

To enable enhanced networking


var client = new AmazonEC2Client();
var response = client.ModifyInstanceAttribute(new ModifyInstanceAttributeRequest 
{
    EnaSupport = jsondata object,
    InstanceId = "i-1234567890abcdef0"
});

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5