- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ModifyInstanceAttributeCommand
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.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { EC2Client, ModifyInstanceAttributeCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, ModifyInstanceAttributeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // ModifyInstanceAttributeRequest
SourceDestCheck: { // AttributeBooleanValue
Value: true || false,
},
DisableApiStop: {
Value: true || false,
},
DryRun: true || false,
InstanceId: "STRING_VALUE", // required
Attribute: "instanceType" || "kernel" || "ramdisk" || "userData" || "disableApiTermination" || "instanceInitiatedShutdownBehavior" || "rootDeviceName" || "blockDeviceMapping" || "productCodes" || "sourceDestCheck" || "groupSet" || "ebsOptimized" || "sriovNetSupport" || "enaSupport" || "enclaveOptions" || "disableApiStop",
Value: "STRING_VALUE",
BlockDeviceMappings: [ // InstanceBlockDeviceMappingSpecificationList
{ // InstanceBlockDeviceMappingSpecification
DeviceName: "STRING_VALUE",
Ebs: { // EbsInstanceBlockDeviceSpecification
VolumeId: "STRING_VALUE",
DeleteOnTermination: true || false,
},
VirtualName: "STRING_VALUE",
NoDevice: "STRING_VALUE",
},
],
DisableApiTermination: {
Value: true || false,
},
InstanceType: { // AttributeValue
Value: "STRING_VALUE",
},
Kernel: {
Value: "STRING_VALUE",
},
Ramdisk: {
Value: "STRING_VALUE",
},
UserData: { // BlobAttributeValue
Value: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
},
InstanceInitiatedShutdownBehavior: {
Value: "STRING_VALUE",
},
Groups: [ // GroupIdStringList
"STRING_VALUE",
],
EbsOptimized: {
Value: true || false,
},
SriovNetSupport: {
Value: "STRING_VALUE",
},
EnaSupport: {
Value: true || false,
},
};
const command = new ModifyInstanceAttributeCommand(input);
const response = await client.send(command);
// {};
Example Usage
ModifyInstanceAttributeCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
InstanceId Required | string | undefined | The ID of the instance. |
Attribute | InstanceAttributeName | undefined | The name of the attribute to modify. You can modify the following attributes only: |
BlockDeviceMappings | InstanceBlockDeviceMappingSpecification[] | undefined | Modifies the 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 | AttributeBooleanValue | undefined | Indicates whether an instance is enabled for stop protection. For more information, see Enable stop protection for your instance . |
DisableApiTermination | AttributeBooleanValue | undefined | If the value is |
DryRun | boolean | undefined | Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
EbsOptimized | AttributeBooleanValue | undefined | 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 | AttributeBooleanValue | undefined | Set to This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable. |
Groups | string[] | undefined | 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. |
InstanceInitiatedShutdownBehavior | AttributeValue | undefined | Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). |
InstanceType | AttributeValue | undefined | 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 |
Kernel | AttributeValue | undefined | 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 | AttributeValue | undefined | 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 | AttributeBooleanValue | undefined | 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 |
SriovNetSupport | AttributeValue | undefined | Set to 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 | BlobAttributeValue | undefined | Changes the instance's user data to the specified value. User data must be base64-encoded. Depending on the tool or SDK that you're using, the base64-encoding might be performed for you. For more information, see Work with instance user data . |
Value | string | undefined | A new value for the attribute. Use only with the |
ModifyInstanceAttributeCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
EC2ServiceException | Base exception class for all service exceptions from EC2 service. |