Skip to content

aws.ec2.describe_instance_attribute

Example SQL Queries

SELECT * FROM
aws.ec2.describe_instance_attribute
WHERE
"attribute" = 'VALUE'
AND "instance_id" = 'VALUE';

Description

Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport

Table Definition

Column NameColumn Data Type
attribute Required Input Column

The instance attribute.

Note: The enaSupport attribute is not supported at this time.

VARCHAR
instance_id Required Input Column

The ID of the instance.

VARCHAR
dry_run Input Column

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.

BOOLEAN
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
block_device_mappings

The block device mapping of the instance.

STRUCT(
"device_name" VARCHAR,
"ebs" STRUCT(
"attach_time" TIMESTAMP_S,
"delete_on_termination" BOOLEAN,
"status" VARCHAR,
"volume_id" VARCHAR,
"associated_resource" VARCHAR,
"volume_owner_id" VARCHAR
)
)[]
Show child fields
block_device_mappings[]
Show child fields
block_device_mappings[].device_name

The device name (for example, /dev/sdh or xvdh).

block_device_mappings[].ebs

Parameters used to automatically set up EBS volumes when the instance is launched.

Show child fields
block_device_mappings[].ebs.associated_resource

The ARN of the Amazon ECS or Fargate task to which the volume is attached.

block_device_mappings[].ebs.attach_time

The time stamp when the attachment initiated.

block_device_mappings[].ebs.delete_on_termination

Indicates whether the volume is deleted on instance termination.

block_device_mappings[].ebs.status

The attachment state.

block_device_mappings[].ebs.volume_id

The ID of the EBS volume.

block_device_mappings[].ebs.volume_owner_id

The ID of the Amazon Web Services account that owns the volume.

This parameter is returned only for volumes that are attached to Fargate tasks.

disable_api_stop

To enable the instance for Amazon Web Services Stop Protection, set this parameter to true; otherwise, set it to false.

STRUCT(
"value" BOOLEAN
)
Show child fields
disable_api_stop.value

The attribute value. The valid values are true or false.

disable_api_termination

If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.

STRUCT(
"value" BOOLEAN
)
Show child fields
disable_api_termination.value

The attribute value. The valid values are true or false.

ebs_optimized

Indicates whether the instance is optimized for Amazon EBS I/O.

STRUCT(
"value" BOOLEAN
)
Show child fields
ebs_optimized.value

The attribute value. The valid values are true or false.

ena_support

Indicates whether enhanced networking with ENA is enabled.

STRUCT(
"value" BOOLEAN
)
Show child fields
ena_support.value

The attribute value. The valid values are true or false.

enclave_options

To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true; otherwise, set it to false.

STRUCT(
"enabled" BOOLEAN
)
Show child fields
enclave_options.enabled

If this parameter is set to true, the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.

groups

The security groups associated with the instance.

STRUCT(
"group_name" VARCHAR,
"group_id" VARCHAR
)[]
Show child fields
groups[]
Show child fields
groups[].group_id

The ID of the security group.

groups[].group_name

The name of the security group.

instance_initiated_shutdown_behavior

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

STRUCT(
"value" VARCHAR
)
Show child fields
instance_initiated_shutdown_behavior.value

The attribute value. The value is case-sensitive.

instance_type

The instance type.

STRUCT(
"value" VARCHAR
)
Show child fields
instance_type.value

The attribute value. The value is case-sensitive.

kernel_id

The kernel ID.

STRUCT(
"value" VARCHAR
)
Show child fields
kernel_id.value

The attribute value. The value is case-sensitive.

product_codes

A list of product codes.

STRUCT(
"product_code_id" VARCHAR,
"product_code_type" VARCHAR
)[]
Show child fields
product_codes[]
Show child fields
product_codes[].product_code_id

The product code.

product_codes[].product_code_type

The type of product code.

ramdisk_id

The RAM disk ID.

STRUCT(
"value" VARCHAR
)
Show child fields
ramdisk_id.value

The attribute value. The value is case-sensitive.

root_device_name

The device name of the root device volume (for example, /dev/sda1).

STRUCT(
"value" VARCHAR
)
Show child fields
root_device_name.value

The attribute value. The value is case-sensitive.

source_dest_check

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.

STRUCT(
"value" BOOLEAN
)
Show child fields
source_dest_check.value

The attribute value. The valid values are true or false.

sriov_net_support

Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

STRUCT(
"value" VARCHAR
)
Show child fields
sriov_net_support.value

The attribute value. The value is case-sensitive.

user_data

The user data.

STRUCT(
"value" VARCHAR
)
Show child fields
user_data.value

The attribute value. The value is case-sensitive.