instance_attributes

Creates, updates, deletes, gets or lists an instance_attributes resource.

Overview

Name	instance_attributes
Type	Resource
Id	aws.ec2.instance_attributes

Fields

The following fields are returned by SELECT queries:

describe_instance_attribute

Name	Datatype	Description
block_device_mappings	string	The block device mapping of the instance.
disable_api_stop	string	Indicates whether stop protection is enabled for the instance.
disable_api_termination	string	Indicates whether termination protection is enabled. If the value is true, you can't terminate the instance using the Amazon EC2 console, command line tools, or API.
ebs_optimized	string	Indicates whether the instance is optimized for Amazon EBS I/O.
ena_support	string	Indicates whether enhanced networking with ENA is enabled.
enclave_options	string	Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
groups	string	The security groups associated with the instance.
instance_id	string	The ID of the instance.
instance_initiated_shutdown_behavior	string	Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
instance_type	string	The instance type.
kernel_id	string	The kernel ID.
product_codes	string	The product codes.
ramdisk_id	string	The RAM disk ID.
root_device_name	string	The device name of the root device volume (for example, /dev/sda1).
source_dest_check	string	Indicates whether source/destination checks are enabled.
sriov_net_support	string	Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
user_data	string	The user data.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_instance_attribute	select	InstanceId, Attribute, region	DryRun	Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Available attributes include SQL license exemption configuration for instances registered with the SQL LE service.
modify_instance_attribute	update	InstanceId, region	SourceDestCheck, EnclaveOptions, DisableApiStop, DryRun, Attribute, Value, BlockDeviceMapping, DisableApiTermination, InstanceType, Kernel, Ramdisk, UserData, InstanceInitiatedShutdownBehavior, GroupId, EbsOptimized, SriovNetSupport, EnaSupport	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

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
Attribute	string	The instance attribute. Note that the enaSupport attribute is not supported.
InstanceId	string	The ID of the instance.
region	string	AWS region (default: us-east-1)
Attribute	string	The name of the attribute to modify. 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. You can modify the following attributes only: disableApiTermination | instanceType | kernel | ramdisk | instanceInitiatedShutdownBehavior | blockDeviceMapping | userData | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport | enaSupport | nvmeSupport | disableApiStop | enclaveOptions
BlockDeviceMapping	array	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.
DisableApiStop	object	Indicates whether an instance is enabled for stop protection. For more information, see Enable stop protection for your instance.
DisableApiTermination	object	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.
DryRun	boolean	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.
EbsOptimized	object	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	object	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.
EnclaveOptions	object	Enables or disables the instance for Amazon Web Services Nitro Enclaves. For more information, see the Amazon Web Services Nitro Enclaves User Guide.
GroupId	array	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	object	Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
InstanceType	object	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	object	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	object	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	object	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	object	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	object	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	A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.

SELECT examples

describe_instance_attribute

Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Available attributes include SQL license exemption configuration for instances registered with the SQL LE service.

SELECT
block_device_mappings,
disable_api_stop,
disable_api_termination,
ebs_optimized,
ena_support,
enclave_options,
groups,
instance_id,
instance_initiated_shutdown_behavior,
instance_type,
kernel_id,
product_codes,
ramdisk_id,
root_device_name,
source_dest_check,
sriov_net_support,
user_data
FROM aws.ec2.instance_attributes
WHERE InstanceId = '{{ InstanceId }}' -- required
AND Attribute = '{{ Attribute }}' -- required
AND region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
;

UPDATE examples

modify_instance_attribute

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.

UPDATE aws.ec2.instance_attributes
SET 
-- No updatable properties
WHERE 
InstanceId = '{{ InstanceId }}' --required
AND region = '{{ region }}' --required
AND SourceDestCheck = '{{ SourceDestCheck}}'
AND EnclaveOptions = '{{ EnclaveOptions}}'
AND DisableApiStop = '{{ DisableApiStop}}'
AND DryRun = {{ DryRun}}
AND Attribute = '{{ Attribute}}'
AND Value = '{{ Value}}'
AND BlockDeviceMapping = '{{ BlockDeviceMapping}}'
AND DisableApiTermination = '{{ DisableApiTermination}}'
AND InstanceType = '{{ InstanceType}}'
AND Kernel = '{{ Kernel}}'
AND Ramdisk = '{{ Ramdisk}}'
AND UserData = '{{ UserData}}'
AND InstanceInitiatedShutdownBehavior = '{{ InstanceInitiatedShutdownBehavior}}'
AND GroupId = '{{ GroupId}}'
AND EbsOptimized = '{{ EbsOptimized}}'
AND SriovNetSupport = '{{ SriovNetSupport}}'
AND EnaSupport = '{{ EnaSupport}}';