aws_ec2_instance

account_id

Type: STRING

ami_launch_index

Type: INT32
Provider name: AmiLaunchIndex
Description: The AMI launch index, which can be used to find this instance in the launch group.

architecture

Type: STRING
Provider name: Architecture
Description: The architecture of the image.

block_device_mappings

Type: UNORDERED_LIST_STRUCT
Provider name: BlockDeviceMappings
Description: Any block device mapping entries for the instance.

  • device_name
    Type: STRING
    Provider name: DeviceName
    Description: The device name (for example, /dev/sdh or xvdh).
  • ebs
    Type: STRUCT
    Provider name: Ebs
    Description: Parameters used to automatically set up EBS volumes when the instance is launched.
    • attach_time
      Type: TIMESTAMP
      Provider name: AttachTime
      Description: The time stamp when the attachment initiated.
    • delete_on_termination
      Type: BOOLEAN
      Provider name: DeleteOnTermination
      Description: Indicates whether the volume is deleted on instance termination.
    • status
      Type: STRING
      Provider name: Status
      Description: The attachment state.
    • volume_id
      Type: STRING
      Provider name: VolumeId
      Description: The ID of the EBS volume.

boot_mode

Type: STRING
Provider name: BootMode
Description: The boot mode of the instance. For more information, see Boot modes in the Amazon EC2 User Guide.

capacity_reservation_id

Type: STRING
Provider name: CapacityReservationId
Description: The ID of the Capacity Reservation.

capacity_reservation_specification

Type: STRUCT
Provider name: CapacityReservationSpecification
Description: Information about the Capacity Reservation targeting option.

  • capacity_reservation_preference
    Type: STRING
    Provider name: CapacityReservationPreference
    Description: Describes the instance’s Capacity Reservation preferences. Possible preferences include:
    • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
    • none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.
  • capacity_reservation_target
    Type: STRUCT
    Provider name: CapacityReservationTarget
    Description: Information about the targeted Capacity Reservation or Capacity Reservation group.
    • capacity_reservation_id
      Type: STRING
      Provider name: CapacityReservationId
      Description: The ID of the targeted Capacity Reservation.
    • capacity_reservation_resource_group_arn
      Type: STRING
      Provider name: CapacityReservationResourceGroupArn
      Description: The ARN of the targeted Capacity Reservation group.

client_token

Type: STRING
Provider name: ClientToken
Description: The idempotency token you provided when you launched the instance, if applicable.

cpu_options

Type: STRUCT
Provider name: CpuOptions
Description: The CPU options for the instance.

  • core_count
    Type: INT32
    Provider name: CoreCount
    Description: The number of CPU cores for the instance.
  • threads_per_core
    Type: INT32
    Provider name: ThreadsPerCore
    Description: The number of threads per CPU core.

ebs_optimized

Type: BOOLEAN
Provider name: EbsOptimized
Description: Indicates 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 I/O performance. This optimization isn’t available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

elastic_gpu_associations

Type: UNORDERED_LIST_STRUCT
Provider name: ElasticGpuAssociations
Description: The Elastic GPU associated with the instance.

  • elastic_gpu_association_id
    Type: STRING
    Provider name: ElasticGpuAssociationId
    Description: The ID of the association.
  • elastic_gpu_association_state
    Type: STRING
    Provider name: ElasticGpuAssociationState
    Description: The state of the association between the instance and the Elastic Graphics accelerator.
  • elastic_gpu_association_time
    Type: STRING
    Provider name: ElasticGpuAssociationTime
    Description: The time the Elastic Graphics accelerator was associated with the instance.
  • elastic_gpu_id
    Type: STRING
    Provider name: ElasticGpuId
    Description: The ID of the Elastic Graphics accelerator.

elastic_inference_accelerator_associations

Type: UNORDERED_LIST_STRUCT
Provider name: ElasticInferenceAcceleratorAssociations
Description: The elastic inference accelerator associated with the instance.

  • elastic_inference_accelerator_arn
    Type: STRING
    Provider name: ElasticInferenceAcceleratorArn
    Description: The Amazon Resource Name (ARN) of the elastic inference accelerator.
  • elastic_inference_accelerator_association_id
    Type: STRING
    Provider name: ElasticInferenceAcceleratorAssociationId
    Description: The ID of the association.
  • elastic_inference_accelerator_association_state
    Type: STRING
    Provider name: ElasticInferenceAcceleratorAssociationState
    Description: The state of the elastic inference accelerator.
  • elastic_inference_accelerator_association_time
    Type: TIMESTAMP
    Provider name: ElasticInferenceAcceleratorAssociationTime
    Description: The time at which the elastic inference accelerator is associated with an instance.

ena_support

Type: BOOLEAN
Provider name: EnaSupport
Description: Specifies whether enhanced networking with ENA is enabled.

enclave_options

Type: STRUCT
Provider name: EnclaveOptions
Description: Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.

  • enabled
    Type: BOOLEAN
    Provider name: Enabled
    Description: 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.

hibernation_options

Type: STRUCT
Provider name: HibernationOptions
Description: Indicates whether the instance is enabled for hibernation.

  • configured
    Type: BOOLEAN
    Provider name: Configured
    Description: If this parameter is set to true, your instance is enabled for hibernation; otherwise, it is not enabled for hibernation.

hypervisor

Type: STRING
Provider name: Hypervisor
Description: The hypervisor type of the instance. The value xen is used for both Xen and Nitro hypervisors.

iam_instance_profile

Type: STRUCT
Provider name: IamInstanceProfile
Description: The IAM instance profile associated with the instance, if applicable.

  • arn
    Type: STRING
    Provider name: Arn
    Description: The Amazon Resource Name (ARN) of the instance profile.
  • id
    Type: STRING
    Provider name: Id
    Description: The ID of the instance profile.

image_id

Type: STRING
Provider name: ImageId
Description: The ID of the AMI used to launch the instance.

instance_arn

Type: STRING

instance_id

Type: STRING
Provider name: InstanceId
Description: The ID of the instance.

instance_lifecycle

Type: STRING
Provider name: InstanceLifecycle
Description: Indicates whether this is a Spot Instance or a Scheduled Instance.

instance_type

Type: STRING
Provider name: InstanceType
Description: The instance type.

ipv6_address

Type: STRING
Provider name: Ipv6Address
Description: The IPv6 address assigned to the instance.

kernel_id

Type: STRING
Provider name: KernelId
Description: The kernel associated with this instance, if applicable.

key_name

Type: STRING
Provider name: KeyName
Description: The name of the key pair, if this instance was launched with an associated key pair.

launch_time

Type: TIMESTAMP
Provider name: LaunchTime
Description: The time the instance was launched.

licenses

Type: UNORDERED_LIST_STRUCT
Provider name: Licenses
Description: The license configurations for the instance.

  • license_configuration_arn
    Type: STRING
    Provider name: LicenseConfigurationArn
    Description: The Amazon Resource Name (ARN) of the license configuration.

maintenance_options

Type: STRUCT
Provider name: MaintenanceOptions
Description: Provides information on the recovery and maintenance options of your instance.

  • auto_recovery
    Type: STRING
    Provider name: AutoRecovery
    Description: Provides information on the current automatic recovery behavior of your instance.

metadata_options

Type: STRUCT
Provider name: MetadataOptions
Description: The metadata options for the instance.

  • http_endpoint
    Type: STRING
    Provider name: HttpEndpoint
    Description: Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled. If the value is disabled, you cannot access your instance metadata.
  • http_protocol_ipv6
    Type: STRING
    Provider name: HttpProtocolIpv6
    Description: Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.
  • http_put_response_hop_limit
    Type: INT32
    Provider name: HttpPutResponseHopLimit
    Description: The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
    Default: 1

    Possible values: Integers from 1 to 64

  • http_tokens
    Type: STRING
    Provider name: HttpTokens
    Description: IMDSv2 uses token-backed sessions. Indicates whether the use of HTTP tokens is optional (in other words, indicates whether the use of IMDSv2 is optional) or required (in other words, indicates whether the use of IMDSv2 is required).
    • optional - When IMDSv2 is optional, you can choose to retrieve instance metadata with or without a session token in your request. If you retrieve the IAM role credentials without a token, the IMDSv1 role credentials are returned. If you retrieve the IAM role credentials using a valid session token, the IMDSv2 role credentials are returned.
    • required - When IMDSv2 is required, you must send a session token with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.
    Default: optional
  • instance_metadata_tags
    Type: STRING
    Provider name: InstanceMetadataTags
    Description: Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.
  • state
    Type: STRING
    Provider name: State
    Description: The state of the metadata option changes. pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection. applied - The metadata options have been successfully applied on the instance.

monitoring

Type: STRUCT
Provider name: Monitoring
Description: The monitoring for the instance.

  • state
    Type: STRING
    Provider name: State
    Description: Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.

network_interfaces

Type: UNORDERED_LIST_STRUCT
Provider name: NetworkInterfaces
Description: [EC2-VPC] The network interfaces for the instance.

  • association
    Type: STRUCT
    Provider name: Association
    Description: The association information for an Elastic IPv4 associated with the network interface.
    • carrier_ip
      Type: STRING
      Provider name: CarrierIp
      Description: The carrier IP address associated with the network interface.
    • customer_owned_ip
      Type: STRING
      Provider name: CustomerOwnedIp
      Description: The customer-owned IP address associated with the network interface.
    • ip_owner_id
      Type: STRING
      Provider name: IpOwnerId
      Description: The ID of the owner of the Elastic IP address.
    • public_dns_name
      Type: STRING
      Provider name: PublicDnsName
      Description: The public DNS name.
    • public_ip
      Type: STRING
      Provider name: PublicIp
      Description: The public IP address or Elastic IP address bound to the network interface.
  • attachment
    Type: STRUCT
    Provider name: Attachment
    Description: The network interface attachment.
    • attach_time
      Type: TIMESTAMP
      Provider name: AttachTime
      Description: The time stamp when the attachment initiated.
    • attachment_id
      Type: STRING
      Provider name: AttachmentId
      Description: The ID of the network interface attachment.
    • delete_on_termination
      Type: BOOLEAN
      Provider name: DeleteOnTermination
      Description: Indicates whether the network interface is deleted when the instance is terminated.
    • device_index
      Type: INT32
      Provider name: DeviceIndex
      Description: The index of the device on the instance for the network interface attachment.
    • network_card_index
      Type: INT32
      Provider name: NetworkCardIndex
      Description: The index of the network card.
    • status
      Type: STRING
      Provider name: Status
      Description: The attachment state.
  • description
    Type: STRING
    Provider name: Description
    Description: The description.
  • groups
    Type: UNORDERED_LIST_STRUCT
    Provider name: Groups
    Description: The security groups.
    • group_id
      Type: STRING
      Provider name: GroupId
      Description: The ID of the security group.
    • group_name
      Type: STRING
      Provider name: GroupName
      Description: The name of the security group.
  • interface_type
    Type: STRING
    Provider name: InterfaceType
    Description: The type of network interface. Valid values: interface | efa | trunk
  • ipv4_prefixes
    Type: UNORDERED_LIST_STRUCT
    Provider name: Ipv4Prefixes
    Description: The IPv4 delegated prefixes that are assigned to the network interface.
    • ipv4_prefix
      Type: STRING
      Provider name: Ipv4Prefix
      Description: One or more IPv4 prefixes assigned to the network interface.
  • ipv6_addresses
    Type: UNORDERED_LIST_STRUCT
    Provider name: Ipv6Addresses
    Description: The IPv6 addresses associated with the network interface.
    • ipv6_address
      Type: STRING
      Provider name: Ipv6Address
      Description: The IPv6 address.
  • ipv6_prefixes
    Type: UNORDERED_LIST_STRUCT
    Provider name: Ipv6Prefixes
    Description: The IPv6 delegated prefixes that are assigned to the network interface.
    • ipv6_prefix
      Type: STRING
      Provider name: Ipv6Prefix
      Description: One or more IPv6 prefixes assigned to the network interface.
  • mac_address
    Type: STRING
    Provider name: MacAddress
    Description: The MAC address.
  • network_interface_id
    Type: STRING
    Provider name: NetworkInterfaceId
    Description: The ID of the network interface.
  • owner_id
    Type: STRING
    Provider name: OwnerId
    Description: The ID of the Amazon Web Services account that created the network interface.
  • private_dns_name
    Type: STRING
    Provider name: PrivateDnsName
    Description: The private DNS name.
  • private_ip_address
    Type: STRING
    Provider name: PrivateIpAddress
    Description: The IPv4 address of the network interface within the subnet.
  • private_ip_addresses
    Type: UNORDERED_LIST_STRUCT
    Provider name: PrivateIpAddresses
    Description: The private IPv4 addresses associated with the network interface.
    • association
      Type: STRUCT
      Provider name: Association
      Description: The association information for an Elastic IP address for the network interface.
      • carrier_ip
        Type: STRING
        Provider name: CarrierIp
        Description: The carrier IP address associated with the network interface.
      • customer_owned_ip
        Type: STRING
        Provider name: CustomerOwnedIp
        Description: The customer-owned IP address associated with the network interface.
      • ip_owner_id
        Type: STRING
        Provider name: IpOwnerId
        Description: The ID of the owner of the Elastic IP address.
      • public_dns_name
        Type: STRING
        Provider name: PublicDnsName
        Description: The public DNS name.
      • public_ip
        Type: STRING
        Provider name: PublicIp
        Description: The public IP address or Elastic IP address bound to the network interface.
    • primary
      Type: BOOLEAN
      Provider name: Primary
      Description: Indicates whether this IPv4 address is the primary private IP address of the network interface.
    • private_dns_name
      Type: STRING
      Provider name: PrivateDnsName
      Description: The private IPv4 DNS name.
    • private_ip_address
      Type: STRING
      Provider name: PrivateIpAddress
      Description: The private IPv4 address of the network interface.
  • source_dest_check
    Type: BOOLEAN
    Provider name: SourceDestCheck
    Description: Indicates whether source/destination checking is enabled.
  • status
    Type: STRING
    Provider name: Status
    Description: The status of the network interface.
  • subnet_id
    Type: STRING
    Provider name: SubnetId
    Description: The ID of the subnet.
  • vpc_id
    Type: STRING
    Provider name: VpcId
    Description: The ID of the VPC.

outpost_arn

Type: STRING
Provider name: OutpostArn
Description: The Amazon Resource Name (ARN) of the Outpost.

placement

Type: STRUCT
Provider name: Placement
Description: The location where the instance launched, if applicable.

  • affinity
    Type: STRING
    Provider name: Affinity
    Description: The affinity setting for the instance on the Dedicated Host. This parameter is not supported for CreateFleet or ImportInstance.
  • availability_zone
    Type: STRING
    Provider name: AvailabilityZone
    Description: The Availability Zone of the instance. If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region. This parameter is not supported for CreateFleet.
  • group_id
    Type: STRING
    Provider name: GroupId
    Description: The ID of the placement group that the instance is in. If you specify GroupId, you can’t specify GroupName.
  • group_name
    Type: STRING
    Provider name: GroupName
    Description: The name of the placement group that the instance is in. If you specify GroupName, you can’t specify GroupId.
  • host_id
    Type: STRING
    Provider name: HostId
    Description: The ID of the Dedicated Host on which the instance resides. This parameter is not supported for CreateFleet or ImportInstance.
  • host_resource_group_arn
    Type: STRING
    Provider name: HostResourceGroupArn
    Description: The ARN of the host resource group in which to launch the instances. If you specify this parameter, either omit the Tenancy parameter or set it to host. This parameter is not supported for CreateFleet.
  • partition_number
    Type: INT32
    Provider name: PartitionNumber
    Description: The number of the partition that the instance is in. Valid only if the placement group strategy is set to partition. This parameter is not supported for CreateFleet.
  • spread_domain
    Type: STRING
    Provider name: SpreadDomain
    Description: Reserved for future use.
  • tenancy
    Type: STRING
    Provider name: Tenancy
    Description: The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. This parameter is not supported for CreateFleet. The host tenancy is not supported for ImportInstance or for T3 instances that are configured for the unlimited CPU credit option.

platform

Type: STRING
Provider name: Platform
Description: The value is Windows for Windows instances; otherwise blank.

platform_details

Type: STRING
Provider name: PlatformDetails
Description: The platform details value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.

private_dns_name

Type: STRING
Provider name: PrivateDnsName
Description: (IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state. [EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you’ve enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.

private_dns_name_options

Type: STRUCT
Provider name: PrivateDnsNameOptions
Description: The options for the instance hostname.

  • enable_resource_name_dns_a_record
    Type: BOOLEAN
    Provider name: EnableResourceNameDnsARecord
    Description: Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
  • enable_resource_name_dns_aaaa_record
    Type: BOOLEAN
    Provider name: EnableResourceNameDnsAAAARecord
    Description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
  • hostname_type
    Type: STRING
    Provider name: HostnameType
    Description: The type of hostname to assign to an instance.

private_ip_address

Type: STRING
Provider name: PrivateIpAddress
Description: The private IPv4 address assigned to the instance.

product_codes

Type: UNORDERED_LIST_STRUCT
Provider name: ProductCodes
Description: The product codes attached to this instance, if applicable.

  • product_code_id
    Type: STRING
    Provider name: ProductCodeId
    Description: The product code.
  • product_code_type
    Type: STRING
    Provider name: ProductCodeType
    Description: The type of product code.

public_dns_name

Type: STRING
Provider name: PublicDnsName
Description: (IPv4 only) The public DNS name assigned to the instance. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you’ve enabled DNS hostnames for your VPC.

public_ip_address

Type: STRING
Provider name: PublicIpAddress
Description: The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable. A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.

ramdisk_id

Type: STRING
Provider name: RamdiskId
Description: The RAM disk associated with this instance, if applicable.

root_device_name

Type: STRING
Provider name: RootDeviceName
Description: The device name of the root device volume (for example, /dev/sda1).

root_device_type

Type: STRING
Provider name: RootDeviceType
Description: The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.

security_groups

Type: UNORDERED_LIST_STRUCT
Provider name: SecurityGroups
Description: The security groups for the instance.

  • group_id
    Type: STRING
    Provider name: GroupId
    Description: The ID of the security group.
  • group_name
    Type: STRING
    Provider name: GroupName
    Description: The name of the security group.

source_dest_check

Type: BOOLEAN
Provider name: SourceDestCheck
Description: Indicates whether source/destination checking is enabled.

spot_instance_request_id

Type: STRING
Provider name: SpotInstanceRequestId
Description: If the request is a Spot Instance request, the ID of the request.

sriov_net_support

Type: STRING
Provider name: SriovNetSupport
Description: Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

state

Type: STRUCT
Provider name: State
Description: The current state of the instance.

  • code
    Type: INT32
    Provider name: Code
    Description: The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are:
    • 0 : pending
    • 16 : running
    • 32 : shutting-down
    • 48 : terminated
    • 64 : stopping
    • 80 : stopped
    You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
  • name
    Type: STRING
    Provider name: Name
    Description: The current state of the instance.

state_reason

Type: STRUCT
Provider name: StateReason
Description: The reason for the most recent state transition.

  • code
    Type: STRING
    Provider name: Code
    Description: The reason code for the state change.
  • message
    Type: STRING
    Provider name: Message
    Description: The message for the state change.
    • Server.InsufficientInstanceCapacity: There was insufficient capacity available to satisfy the launch request.
    • Server.InternalError: An internal error caused the instance to terminate during launch.
    • Server.ScheduledStop: The instance was stopped due to a scheduled retirement.
    • Server.SpotInstanceShutdown: The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.
    • Server.SpotInstanceTermination: The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.
    • Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.
    • Client.InstanceTerminated: The instance was terminated or rebooted during AMI creation.
    • Client.InternalError: A client error caused the instance to terminate during launch.
    • Client.InvalidSnapshot.NotFound: The specified snapshot was not found.
    • Client.UserInitiatedHibernate: Hibernation was initiated on the instance.
    • Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.
    • Client.VolumeLimitExceeded: The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits.

state_transition_reason

Type: STRING
Provider name: StateTransitionReason
Description: The reason for the most recent state transition. This might be an empty string.

subnet_id

Type: STRING
Provider name: SubnetId
Description: [EC2-VPC] The ID of the subnet in which the instance is running.

tags

Type: UNORDERED_LIST_STRING

tpm_support

Type: STRING
Provider name: TpmSupport
Description: If the instance is configured for NitroTPM support, the value is v2.0. For more information, see NitroTPM in the Amazon EC2 User Guide.

usage_operation

Type: STRING
Provider name: UsageOperation
Description: The usage operation value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.

usage_operation_update_time

Type: TIMESTAMP
Provider name: UsageOperationUpdateTime
Description: The time that the usage operation was last updated.

virtualization_type

Type: STRING
Provider name: VirtualizationType
Description: The virtualization type of the instance.

vpc_id

Type: STRING
Provider name: VpcId
Description: [EC2-VPC] The ID of the VPC in which the instance is running.