modify_instance_attribute¶
Operation¶
async
¶
modify_instance_attribute(input: ModifyInstanceAttributeInput, plugins: list[Plugin] | None = None) -> ModifyInstanceAttributeOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ModifyInstanceAttributeInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
ModifyInstanceAttributeOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyInstanceAttributeInput structure.
Attributes¶
class-attribute
instance-attribute
¶
attribute: str | None = ...
The name of the attribute to modify.
Note
When changing the instance type: If the original instance type is
configured for configurable bandwidth, and the desired instance type
doesn't support configurable bandwidth, first set the existing
bandwidth configuration to default using the
ModifyInstanceNetworkPerformanceOptions operation.
Warning:
You can modify the following attributes only: disableApiTermination |
instanceType | kernel | ramdisk |
instanceInitiatedShutdownBehavior | blockDeviceMapping |
userData | sourceDestCheck | groupSet | ebsOptimized |
sriovNetSupport | enaSupport | nvmeSupport | disableApiStop
| enclaveOptions
class-attribute
instance-attribute
¶
block_device_mappings: list[InstanceBlockDeviceMappingSpecification] | None = ...
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 Amazon
Web Services-managed resources.
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.
class-attribute
instance-attribute
¶
Indicates whether an instance is enabled for stop protection. For more information, see Enable stop protection for your instance.
class-attribute
instance-attribute
¶
Enable or disable termination protection for the instance. If the value
is true, you can't terminate the instance using the Amazon EC2
console, command line interface, or API. You can't enable termination
protection for Spot Instances.
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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
DryRunOperation. Otherwise, it is UnauthorizedOperation.
class-attribute
instance-attribute
¶
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.
class-attribute
instance-attribute
¶
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.
class-attribute
instance-attribute
¶
Enables or disables the instance for Amazon Web Services Nitro Enclaves. For more information, see the Amazon Web Services Nitro Enclaves User Guide.
class-attribute
instance-attribute
¶
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.
class-attribute
instance-attribute
¶
instance_id: str | None = ...
The ID of the instance.
class-attribute
instance-attribute
¶
Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
class-attribute
instance-attribute
¶
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.
class-attribute
instance-attribute
¶
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.
class-attribute
instance-attribute
¶
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.
class-attribute
instance-attribute
¶
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.
class-attribute
instance-attribute
¶
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.
class-attribute
instance-attribute
¶
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.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyInstanceAttributeOutput structure.