Menu
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

ModifyInstanceAttribute

Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.

To modify some attributes, the instance must be stopped. For more information, see Modifying Attributes of a Stopped Instance in the Amazon Elastic Compute Cloud User Guide.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

Attribute

The name of the attribute.

Type: String

Valid Values: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport | enaSupport

Required: No

BlockDeviceMapping.N

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 Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide.

Type: array of InstanceBlockDeviceMappingSpecification objects

Required: No

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 paramater for Spot Instances.

Type: AttributeBooleanValue object

Required: No

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Type: Boolean

Required: No

EbsOptimized

Specifies whether the instance is optimized for 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.

Type: AttributeBooleanValue object

Required: No

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.

Type: AttributeBooleanValue object

Required: No

GroupId.N

[EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name.

Type: array of Strings

Required: No

InstanceId

The ID of the instance.

Type: String

Required: Yes

InstanceInitiatedShutdownBehavior

Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Type: AttributeValue object

Required: No

InstanceType

Changes the instance type to the specified value. For more information, see Instance Types. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.

Type: AttributeValue object

Required: No

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.

Type: AttributeValue object

Required: No

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.

Type: AttributeValue object

Required: No

SourceDestCheck

Specifies whether source/destination checking is enabled. A value of true means that checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

Type: AttributeBooleanValue object

Required: No

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.

Type: AttributeValue object

Required: No

UserData

Changes the instance's user data to the specified value. If you are using an AWS 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.

Type: BlobAttributeValue object

Required: No

Value

A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.

Type: String

Required: No

Response Elements

The following elements are returned by the service.

requestId

The ID of the request.

Type: String

return

Is true if the request succeeds, and an error otherwise.

Type: Boolean

Errors

For information about the errors that are common to all actions, see Common Errors.

Examples

Example 1

This example changes the instance type of the specified instance. The instance must be in the stopped state.

Sample Request

Copy
https://ec2.amazonaws.com/?Action=ModifyInstanceAttribute &InstanceId=i-1234567890abcdef0 &InstanceType.Value=m1.small &AUTHPARAMS

Sample Response

Copy
<ModifyInstanceAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> <return>true</return> </ModifyInstanceAttributeResponse>

Example 2

This example changes the InstanceInitiatedShutdownBehavior attribute of the specified instance.

Sample Request

Copy
https://ec2.amazonaws.com/?Action=ModifyInstanceAttribute &InstanceId=i-1234567890abcdef0 &InstanceInitiatedShutdownBehavior.Value=terminate &AUTHPARAMS

Sample Response

Copy
<ModifyInstanceAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> <return>true</return> </ModifyInstanceAttributeResponse>

Example 3

This example changes the DisableApiTermination attribute of the specified instance.

Sample Request

Copy
https://ec2.amazonaws.com/?Action=ModifyInstanceAttribute &InstanceId=i-1234567890abcdef0 &DisableApiTermination.Value=true &AUTHPARAMS

Sample Response

Copy
<ModifyInstanceAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> <return>true</return> </ModifyInstanceAttributeResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: