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.
associated_resource
Type: STRING
Provider name: AssociatedResource
Description: The ARN of the Amazon ECS or Fargate task to which the volume is attached.
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.
operator
Type: STRUCT
Provider name: Operator
Description: The service provider that manages the EBS volume.
managed
Type: BOOLEAN
Provider name: Managed
Description: If true, the resource is managed by an service provider.
principal
Type: STRING
Provider name: Principal
Description: If managed is true, then the principal is returned. The principal is the service provider that manages the resource.
status
Type: STRING
Provider name: Status
Description: The attachment state.
volume_id
Type: STRING
Provider name: VolumeId
Description: The ID of the EBS volume.
volume_owner_id
Type: STRING
Provider name: VolumeOwnerId
Description: 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.
boot_mode
Type: STRING
Provider name: BootMode
Description: The boot mode that was specified by the AMI. If the value is uefi-preferred, the AMI supports both UEFI and Legacy BIOS. The currentInstanceBootMode parameter is the boot mode that is used to boot the instance at launch or start. The operating system contained in the AMI must be configured to support the specified boot mode. 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.
amd_sev_snp
Type: STRING
Provider name: AmdSevSnp
Description: Indicates whether the instance is enabled for AMD SEV-SNP. For more information, see AMD SEV-SNP.
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.
current_instance_boot_mode
Type: STRING
Provider name: CurrentInstanceBootMode
Description: The boot mode that is used to boot the instance at launch or start. For more information, see Boot modes in the Amazon EC2 User Guide.
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: Deprecated. Amazon Elastic Graphics reached end of life on January 8, 2024.
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: Deprecated Amazon Elastic Inference is no longer available.
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 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_template_data
Type: STRUCT
Provider name: LaunchTemplateData
Description: The instance data.
block_device_mappings
Type: UNORDERED_LIST_STRUCT
Provider name: BlockDeviceMappings
Description: The block device mappings.
device_name
Type: STRING
Provider name: DeviceName
Description: The device name.
ebs
Type: STRUCT
Provider name: Ebs
Description: Information about the block device for an EBS volume.
delete_on_termination
Type: BOOLEAN
Provider name: DeleteOnTermination
Description: Indicates whether the EBS volume is deleted on instance termination.
encrypted
Type: BOOLEAN
Provider name: Encrypted
Description: Indicates whether the EBS volume is encrypted.
iops
Type: INT32
Provider name: Iops
Description: The number of I/O operations per second (IOPS) that the volume supports.
kms_key_id
Type: STRING
Provider name: KmsKeyId
Description: Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption.
snapshot_id
Type: STRING
Provider name: SnapshotId
Description: The ID of the snapshot.
throughput
Type: INT32
Provider name: Throughput
Description: The throughput that the volume supports, in MiB/s.
volume_size
Type: INT32
Provider name: VolumeSize
Description: The size of the volume, in GiB.
volume_type
Type: STRING
Provider name: VolumeType
Description: The volume type.
no_device
Type: STRING
Provider name: NoDevice
Description: To omit the device from the block device mapping, specify an empty string.
virtual_name
Type: STRING
Provider name: VirtualName
Description: The virtual device name (ephemeralN).
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: Indicates 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 target 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.
cpu_options
Type: STRUCT
Provider name: CpuOptions
Description: The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.
amd_sev_snp
Type: STRING
Provider name: AmdSevSnp
Description: Indicates whether the instance is enabled for AMD SEV-SNP. For more information, see AMD SEV-SNP.
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.
credit_specification
Type: STRUCT
Provider name: CreditSpecification
Description: The credit option for CPU usage of the instance.
cpu_credits
Type: STRING
Provider name: CpuCredits
Description: The credit option for CPU usage of a T instance. Valid values: standard | unlimited
disable_api_stop
Type: BOOLEAN
Provider name: DisableApiStop
Description: Indicates whether the instance is enabled for stop protection. For more information, see Enable stop protection for your instance in the Amazon EC2 User Guide.
disable_api_termination
Type: BOOLEAN
Provider name: DisableApiTermination
Description: If set to true, indicates that the instance cannot be terminated using the Amazon EC2 console, command line tool, or API.
ebs_optimized
Type: BOOLEAN
Provider name: EbsOptimized
Description: Indicates whether the instance is optimized for Amazon EBS I/O.
elastic_gpu_specifications
Type: UNORDERED_LIST_STRUCT
Provider name: ElasticGpuSpecifications
Description: Deprecated. Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.
type
Type: STRING
Provider name: Type
Description: Deprecated. Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.
elastic_inference_accelerators
Type: UNORDERED_LIST_STRUCT
Provider name: ElasticInferenceAccelerators
Description: Amazon Elastic Inference is no longer available. An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. You cannot specify accelerators from different generations in the same request. Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
count
Type: INT32
Provider name: Count
Description: The number of elastic inference accelerators to attach to the instance.
Default: 1type
Type: STRING
Provider name: Type
Description: The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.
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 an instance is configured for hibernation. For more information, see Hibernate your Amazon EC2 instance in the Amazon EC2 User Guide.
configured
Type: BOOLEAN
Provider name: Configured
Description: If this parameter is set to true, the instance is enabled for hibernation; otherwise, it is not enabled for hibernation.
iam_instance_profile
Type: STRUCT
Provider name: IamInstanceProfile
Description: The IAM instance profile.
arn
Type: STRING
Provider name: Arn
Description: The Amazon Resource Name (ARN) of the instance profile.
name
Type: STRING
Provider name: Name
Description: The name of the instance profile.
image_id
Type: STRING
Provider name: ImageId
Description: The ID of the AMI or a Systems Manager parameter. The Systems Manager parameter will resolve to the ID of the AMI at instance launch. The value depends on what you specified in the request. The possible values are:- If an AMI ID was specified in the request, then this is the AMI ID.
- If a Systems Manager parameter was specified in the request, and
ResolveAlias was configured as true, then this is the AMI ID that the parameter is mapped to in the Parameter Store. - If a Systems Manager parameter was specified in the request, and
ResolveAlias was configured as false, then this is the parameter value.
For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon EC2 User Guide.
instance_initiated_shutdown_behavior
Type: STRING
Provider name: InstanceInitiatedShutdownBehavior
Description: Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
instance_market_options
Type: STRUCT
Provider name: InstanceMarketOptions
Description: The market (purchasing) option for the instances.
market_type
Type: STRING
Provider name: MarketType
Description: The market type.
spot_options
Type: STRUCT
Provider name: SpotOptions
Description: The options for Spot Instances.
block_duration_minutes
Type: INT32
Provider name: BlockDurationMinutes
Description: The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
instance_interruption_behavior
Type: STRING
Provider name: InstanceInterruptionBehavior
Description: The behavior when a Spot Instance is interrupted.
max_price
Type: STRING
Provider name: MaxPrice
Description: The maximum hourly price you’re willing to pay for the Spot Instances. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price. If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
spot_instance_type
Type: STRING
Provider name: SpotInstanceType
Description: The Spot Instance request type.
valid_until
Type: TIMESTAMP
Provider name: ValidUntil
Description: The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.
instance_requirements
Type: STRUCT
Provider name: InstanceRequirements
Description: The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes. If you specify InstanceRequirements, you can’t specify InstanceTypes.
accelerator_count
Type: STRUCT
Provider name: AcceleratorCount
Description: The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance. To exclude accelerator-enabled instance types, set Max to 0.
Default: No minimum or maximum limitsmax
Type: INT32
Provider name: Max
Description: The maximum number of accelerators. If this parameter is not specified, there is no maximum limit.
min
Type: INT32
Provider name: Min
Description: The minimum number of accelerators. If this parameter is not specified, there is no minimum limit.
accelerator_manufacturers
Type: UNORDERED_LIST_STRING
Provider name: AcceleratorManufacturers
Description: Indicates whether instance types must have accelerators by specific manufacturers.- For instance types with Amazon Web Services devices, specify
amazon-web-services. - For instance types with AMD devices, specify
amd. - For instance types with Habana devices, specify
habana. - For instance types with NVIDIA devices, specify
nvidia. - For instance types with Xilinx devices, specify
xilinx.
Default: Any manufactureraccelerator_names
Type: UNORDERED_LIST_STRING
Provider name: AcceleratorNames
Description: The accelerators that must be on the instance type.- For instance types with NVIDIA A10G GPUs, specify
a10g. - For instance types with NVIDIA A100 GPUs, specify
a100. - For instance types with NVIDIA H100 GPUs, specify
h100. - For instance types with Amazon Web Services Inferentia chips, specify
inferentia. - For instance types with NVIDIA GRID K520 GPUs, specify
k520. - For instance types with NVIDIA K80 GPUs, specify
k80. - For instance types with NVIDIA M60 GPUs, specify
m60. - For instance types with AMD Radeon Pro V520 GPUs, specify
radeon-pro-v520. - For instance types with NVIDIA T4 GPUs, specify
t4. - For instance types with NVIDIA T4G GPUs, specify
t4g. - For instance types with Xilinx VU9P FPGAs, specify
vu9p. - For instance types with NVIDIA V100 GPUs, specify
v100.
Default: Any acceleratoraccelerator_total_memory_mib
Type: STRUCT
Provider name: AcceleratorTotalMemoryMiB
Description: The minimum and maximum amount of total accelerator memory, in MiB.
Default: No minimum or maximum limitsmax
Type: INT32
Provider name: Max
Description: The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit.
min
Type: INT32
Provider name: Min
Description: The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit.
accelerator_types
Type: UNORDERED_LIST_STRING
Provider name: AcceleratorTypes
Description: The accelerator types that must be on the instance type.- For instance types with GPU accelerators, specify
gpu. - For instance types with FPGA accelerators, specify
fpga.
Default: Any accelerator typeallowed_instance_types
Type: UNORDERED_LIST_STRING
Provider name: AllowedInstanceTypes
Description: The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. You can use strings with one or more wild cards, represented by an asterisk (m5.8xlarge, c5., m5a., r*, 3. For example, if you specify c5*,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 will allow all the M5a instance types, but not the M5n instance types. If you specify AllowedInstanceTypes, you can’t specify ExcludedInstanceTypes.
Default: All instance typesbare_metal
Type: STRING
Provider name: BareMetal
Description: Indicates whether bare metal instance types must be included, excluded, or required.- To include bare metal instance types, specify
included. - To require only bare metal instance types, specify
required. - To exclude bare metal instance types, specify
excluded.
Default: excludedbaseline_ebs_bandwidth_mbps
Type: STRUCT
Provider name: BaselineEbsBandwidthMbps
Description: The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.
Default: No minimum or maximum limitsmax
Type: INT32
Provider name: Max
Description: The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit.
min
Type: INT32
Provider name: Min
Description: The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit.
baseline_performance_factors
Type: STRUCT
Provider name: BaselinePerformanceFactors
Description: The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see Performance protection in the Amazon EC2 User Guide.
cpu
Type: STRUCT
Provider name: Cpu
Description: The CPU performance to consider, using an instance family as the baseline reference.
references
Type: UNORDERED_LIST_STRUCT
Provider name: References
Description: Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences. Currently, only one instance family can be specified in the list.
instance_family
Type: STRING
Provider name: InstanceFamily
Description: The instance family to use as a baseline reference. Ensure that you specify the correct value for the instance family. The instance family is everything before the period (.) in the instance type name. For example, in the instance type c6i.large, the instance family is c6i, not c6. For more information, see Amazon EC2 instance type naming conventions in Amazon EC2 Instance Types. The following instance families are not supported for performance protection:c1g3 | g3shpc7gm1 | m2mac1 | mac2 | mac2-m1ultra | mac2-m2 | mac2-m2prop3dn | p4d | p5t1u-12tb1 | u-18tb1 | u-24tb1 | u-3tb1 | u-6tb1 | u-9tb1 | u7i-12tb | u7in-16tb | u7in-24tb | u7in-32tb
If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families. If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for and an exception for , , , and .
burstable_performance
Type: STRING
Provider name: BurstablePerformance
Description: Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances.- To include burstable performance instance types, specify
included. - To require only burstable performance instance types, specify
required. - To exclude burstable performance instance types, specify
excluded.
Default: excludedcpu_manufacturers
Type: UNORDERED_LIST_STRING
Provider name: CpuManufacturers
Description: The CPU manufacturers to include.- For instance types with Intel CPUs, specify
intel. - For instance types with AMD CPUs, specify
amd. - For instance types with Amazon Web Services CPUs, specify
amazon-web-services. - For instance types with Apple CPUs, specify
apple.
Don’t confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
Default: Any manufacturerexcluded_instance_types
Type: UNORDERED_LIST_STRING
Provider name: ExcludedInstanceTypes
Description: The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (m5.8xlarge, c5., m5a., r*, 3. For example, if you specify c5*,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types. If you specify ExcludedInstanceTypes, you can’t specify AllowedInstanceTypes.
Default: No excluded instance typesinstance_generations
Type: UNORDERED_LIST_STRING
Provider name: InstanceGenerations
Description: Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the Amazon EC2 User Guide. For current generation instance types, specify current. For previous generation instance types, specify previous.
Default: Current and previous generation instance typeslocal_storage
Type: STRING
Provider name: LocalStorage
Description: Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the Amazon EC2 User Guide.- To include instance types with instance store volumes, specify
included. - To require only instance types with instance store volumes, specify
required. - To exclude instance types with instance store volumes, specify
excluded.
Default: includedlocal_storage_types
Type: UNORDERED_LIST_STRING
Provider name: LocalStorageTypes
Description: The type of local storage that is required.- For instance types with hard disk drive (HDD) storage, specify
hdd. - For instance types with solid state drive (SSD) storage, specify
ssd.
Default: hdd and ssdmax_spot_price_as_percentage_of_optimal_on_demand_price
Type: INT32
Provider name: MaxSpotPriceAsPercentageOfOptimalOnDemandPrice
Description: [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is based on the per vCPU or per memory price instead of the per instance price. Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don’t specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as 999999.
memory_gib_per_v_cpu
Type: STRUCT
Provider name: MemoryGiBPerVCpu
Description: The minimum and maximum amount of memory per vCPU, in GiB.
Default: No minimum or maximum limitsmax
Type: DOUBLE
Provider name: Max
Description: The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit.
min
Type: DOUBLE
Provider name: Min
Description: The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit.
memory_mib
Type: STRUCT
Provider name: MemoryMiB
Description: The minimum and maximum amount of memory, in MiB.
max
Type: INT32
Provider name: Max
Description: The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit.
min
Type: INT32
Provider name: Min
Description: The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit.
network_bandwidth_gbps
Type: STRUCT
Provider name: NetworkBandwidthGbps
Description: The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
Default: No minimum or maximum limitsmax
Type: DOUBLE
Provider name: Max
Description: The maximum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no maximum limit.
min
Type: DOUBLE
Provider name: Min
Description: The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit.
network_interface_count
Type: STRUCT
Provider name: NetworkInterfaceCount
Description: The minimum and maximum number of network interfaces.
Default: No minimum or maximum limitsmax
Type: INT32
Provider name: Max
Description: The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit.
min
Type: INT32
Provider name: Min
Description: The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit.
on_demand_max_price_percentage_over_lowest_price
Type: INT32
Provider name: OnDemandMaxPricePercentageOverLowestPrice
Description: [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. To turn off price protection, specify a high value, such as 999999. This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
Default: 20require_hibernate_support
Type: BOOLEAN
Provider name: RequireHibernateSupport
Description: Indicates whether instance types must support hibernation for On-Demand Instances. This parameter is not supported for GetSpotPlacementScores.
Default: falsespot_max_price_percentage_over_lowest_price
Type: INT32
Provider name: SpotMaxPricePercentageOverLowestPrice
Description: [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don’t specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as 999999.
Default: 100total_local_storage_gb
Type: STRUCT
Provider name: TotalLocalStorageGB
Description: The minimum and maximum amount of total local storage, in GB.
Default: No minimum or maximum limitsmax
Type: DOUBLE
Provider name: Max
Description: The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit.
min
Type: DOUBLE
Provider name: Min
Description: The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit.
v_cpu_count
Type: STRUCT
Provider name: VCpuCount
Description: The minimum and maximum number of vCPUs.
max
Type: INT32
Provider name: Max
Description: The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit.
min
Type: INT32
Provider name: Min
Description: The minimum number of vCPUs. If the value is 0, there is no minimum limit.
instance_type
Type: STRING
Provider name: InstanceType
Description: The instance type.
kernel_id
Type: STRING
Provider name: KernelId
Description: The ID of the kernel, if applicable.
key_name
Type: STRING
Provider name: KeyName
Description: The name of the key pair.
license_specifications
Type: UNORDERED_LIST_STRUCT
Provider name: LicenseSpecifications
Description: The license configurations.
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: The maintenance options for your instance.
auto_recovery
Type: STRING
Provider name: AutoRecovery
Description: Disables the automatic recovery behavior of your instance or sets it to default.
metadata_options
Type: STRUCT
Provider name: MetadataOptions
Description: The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.
monitoring
Type: STRUCT
Provider name: Monitoring
Description: The monitoring for the instance.
enabled
Type: BOOLEAN
Provider name: Enabled
Description: Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
network_interfaces
Type: UNORDERED_LIST_STRUCT
Provider name: NetworkInterfaces
Description: The network interfaces.
associate_carrier_ip_address
Type: BOOLEAN
Provider name: AssociateCarrierIpAddress
Description: Indicates whether to associate a Carrier IP address with eth0 for a new network interface. Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses in the Wavelength Developer Guide.
associate_public_ip_address
Type: BOOLEAN
Provider name: AssociatePublicIpAddress
Description: Indicates whether to associate a public IPv4 address with eth0 for a new network interface. Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.
connection_tracking_specification
Type: STRUCT
Provider name: ConnectionTrackingSpecification
Description: A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Idle connection tracking timeout in the Amazon EC2 User Guide.
tcp_established_timeout
Type: INT32
Provider name: TcpEstablishedTimeout
Description: Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.
udp_stream_timeout
Type: INT32
Provider name: UdpStreamTimeout
Description: Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.
udp_timeout
Type: INT32
Provider name: UdpTimeout
Description: Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.
delete_on_termination
Type: BOOLEAN
Provider name: DeleteOnTermination
Description: Indicates whether the network interface is deleted when the instance is terminated.
description
Type: STRING
Provider name: Description
Description: A description for the network interface.
device_index
Type: INT32
Provider name: DeviceIndex
Description: The device index for the network interface attachment.
ena_srd_specification
Type: STRUCT
Provider name: EnaSrdSpecification
Description: Contains the ENA Express settings for instances launched from your launch template.
ena_srd_enabled
Type: BOOLEAN
Provider name: EnaSrdEnabled
Description: Indicates whether ENA Express is enabled for the network interface.
ena_srd_udp_specification
Type: STRUCT
Provider name: EnaSrdUdpSpecification
Description: Configures ENA Express for UDP network traffic.
ena_srd_udp_enabled
Type: BOOLEAN
Provider name: EnaSrdUdpEnabled
Description: Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.
groups
Type: UNORDERED_LIST_STRING
Provider name: Groups
Description: The IDs of one or more security groups.
interface_type
Type: STRING
Provider name: InterfaceType
Description: The type of network interface.
ipv4_prefix_count
Type: INT32
Provider name: Ipv4PrefixCount
Description: The number of IPv4 prefixes that Amazon Web Services automatically assigned to the network interface.
ipv4_prefixes
Type: UNORDERED_LIST_STRUCT
Provider name: Ipv4Prefixes
Description: One or more IPv4 prefixes assigned to the network interface.
ipv4_prefix
Type: STRING
Provider name: Ipv4Prefix
Description: The IPv4 delegated prefixes assigned to the network interface.
ipv6_address_count
Type: INT32
Provider name: Ipv6AddressCount
Description: The number of IPv6 addresses for the network interface.
ipv6_addresses
Type: UNORDERED_LIST_STRUCT
Provider name: Ipv6Addresses
Description: The IPv6 addresses for the network interface.
ipv6_address
Type: STRING
Provider name: Ipv6Address
Description: The IPv6 address.
is_primary_ipv6
Type: BOOLEAN
Provider name: IsPrimaryIpv6
Description: Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see RunInstances.
ipv6_prefix_count
Type: INT32
Provider name: Ipv6PrefixCount
Description: The number of IPv6 prefixes that Amazon Web Services automatically assigned to the network interface.
ipv6_prefixes
Type: UNORDERED_LIST_STRUCT
Provider name: Ipv6Prefixes
Description: One or more IPv6 prefixes assigned to the network interface.
ipv6_prefix
Type: STRING
Provider name: Ipv6Prefix
Description: The IPv6 delegated prefixes assigned to the network interface.
network_card_index
Type: INT32
Provider name: NetworkCardIndex
Description: The index of the network card.
network_interface_id
Type: STRING
Provider name: NetworkInterfaceId
Description: The ID of the network interface.
primary_ipv6
Type: BOOLEAN
Provider name: PrimaryIpv6
Description: The primary IPv6 address of the network interface. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see RunInstances.
private_ip_address
Type: STRING
Provider name: PrivateIpAddress
Description: The primary private IPv4 address of the network interface.
private_ip_addresses
Type: UNORDERED_LIST_STRUCT
Provider name: PrivateIpAddresses
Description: One or more private IPv4 addresses.
primary
Type: BOOLEAN
Provider name: Primary
Description: Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
private_ip_address
Type: STRING
Provider name: PrivateIpAddress
Description: The private IPv4 address.
secondary_private_ip_address_count
Type: INT32
Provider name: SecondaryPrivateIpAddressCount
Description: The number of secondary private IPv4 addresses for the network interface.
subnet_id
Type: STRING
Provider name: SubnetId
Description: The ID of the subnet for the network interface.
network_performance_options
Type: STRUCT
Provider name: NetworkPerformanceOptions
Description: Contains the launch template settings for network performance options for your instance.
bandwidth_weighting
Type: STRING
Provider name: BandwidthWeighting
Description: When you configure network bandwidth weighting, you can boost baseline bandwidth for either networking or EBS by up to 25%. The total available baseline bandwidth for your instance remains the same. The default option uses the standard bandwidth configuration for your instance type.
operator
Type: STRUCT
Provider name: Operator
Description: The entity that manages the launch template.
managed
Type: BOOLEAN
Provider name: Managed
Description: If true, the resource is managed by an service provider.
principal
Type: STRING
Provider name: Principal
Description: If managed is true, then the principal is returned. The principal is the service provider that manages the resource.
placement
Type: STRUCT
Provider name: Placement
Description: The placement of the instance.
affinity
Type: STRING
Provider name: Affinity
Description: The affinity setting for the instance on the Dedicated Host.
availability_zone
Type: STRING
Provider name: AvailabilityZone
Description: The Availability Zone of the instance.
group_id
Type: STRING
Provider name: GroupId
Description: The Group ID of the placement group. You must specify the Placement Group Group ID to launch an instance in a shared placement group.
group_name
Type: STRING
Provider name: GroupName
Description: The name of the placement group for the instance.
host_id
Type: STRING
Provider name: HostId
Description: The ID of the Dedicated Host for the instance.
host_resource_group_arn
Type: STRING
Provider name: HostResourceGroupArn
Description: The ARN of the host resource group in which to launch the instances.
partition_number
Type: INT32
Provider name: PartitionNumber
Description: The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition.
spread_domain
Type: STRING
Provider name: SpreadDomain
Description: Reserved for future use.
tenancy
Type: STRING
Provider name: Tenancy
Description: The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.
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.
ram_disk_id
Type: STRING
Provider name: RamDiskId
Description: The ID of the RAM disk, if applicable.
security_group_ids
Type: UNORDERED_LIST_STRING
Provider name: SecurityGroupIds
Description: The security group IDs.
security_groups
Type: UNORDERED_LIST_STRING
Provider name: SecurityGroups
Description: The security group names.
tag_specifications
Type: UNORDERED_LIST_STRUCT
Provider name: TagSpecifications
Description: The tags that are applied to the resources that are created during instance launch.
resource_type
Type: STRING
Provider name: ResourceType
Description: The type of resource to tag.
user_data
Type: STRING
Provider name: UserData
Description: The user data for the instance.
launch_time
Type: TIMESTAMP
Provider name: LaunchTime
Description: The time that the instance was last launched. To determine the time that instance was first launched, see the attachment time for the primary network interface.
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.
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.
Default: disabledhttp_put_response_hop_limit
Type: INT32
Provider name: HttpPutResponseHopLimit
Description: The maximum number of hops that the metadata token can travel. Possible values: Integers from 1 to 64
http_tokens
Type: STRING
Provider name: HttpTokens
Description: Indicates whether IMDSv2 is required.optional - IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1.required - IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2.
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: 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.
ena_srd_specification
Type: STRUCT
Provider name: EnaSrdSpecification
Description: Contains the ENA Express settings for the network interface that’s attached to the instance.
ena_srd_enabled
Type: BOOLEAN
Provider name: EnaSrdEnabled
Description: Indicates whether ENA Express is enabled for the network interface.
ena_srd_udp_specification
Type: STRUCT
Provider name: EnaSrdUdpSpecification
Description: Configures ENA Express for UDP network traffic.
ena_srd_udp_enabled
Type: BOOLEAN
Provider name: EnaSrdUdpEnabled
Description: Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.
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.
connection_tracking_configuration
Type: STRUCT
Provider name: ConnectionTrackingConfiguration
Description: A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
tcp_established_timeout
Type: INT32
Provider name: TcpEstablishedTimeout
Description: Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.
udp_stream_timeout
Type: INT32
Provider name: UdpStreamTimeout
Description: Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.
udp_timeout
Type: INT32
Provider name: UdpTimeout
Description: Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.
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 | efa-only | 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.
is_primary_ipv6
Type: BOOLEAN
Provider name: IsPrimaryIpv6
Description: Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see RunInstances.
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.
operator
Type: STRUCT
Provider name: Operator
Description: The service provider that manages the network interface.
managed
Type: BOOLEAN
Provider name: Managed
Description: If true, the resource is managed by an service provider.
principal
Type: STRING
Provider name: Principal
Description: If managed is true, then the principal is returned. The principal is the service provider that manages the resource.
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.
Type: STRUCT
Provider name: NetworkPerformanceOptions
Description: Contains settings for the network performance options for your instance.
bandwidth_weighting
Type: STRING
Provider name: BandwidthWeighting
Description: When you configure network bandwidth weighting, you can boost your baseline bandwidth for either networking or EBS by up to 25%. The total available baseline bandwidth for your instance remains the same. The default option uses the standard bandwidth configuration for your instance type.
operator
Type: STRUCT
Provider name: Operator
Description: The service provider that manages the instance.
managed
Type: BOOLEAN
Provider name: Managed
Description: If true, the resource is managed by an service provider.
principal
Type: STRING
Provider name: Principal
Description: If managed is true, then the principal is returned. The principal is the service provider that manages the resource.
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. 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.
Type: STRING
Provider name: Platform
Description: The platform. This value is windows for Windows instances; otherwise, it is empty.
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. 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. 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 : pending16 : running32 : shutting-down48 : terminated64 : stopping80 : 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 from the operating system of 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: The ID of the subnet in which the instance is running.
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: The ID of the VPC in which the instance is running.
