fleet_instances
Creates, updates, deletes, gets or lists a fleet_instances resource.
Overview
| Name | fleet_instances |
| Type | Resource |
| Id | aws.ec2.fleet_instances |
Fields
The following fields are returned by SELECT queries:
- describe_fleet_instances
| Name | Datatype | Description |
|---|---|---|
instance_health | string | The health status of the instance. If the status of either the instance status check or the system status check is impaired, the health status of the instance is unhealthy. Otherwise, the health status is healthy. |
instance_id | string | The ID of the instance. |
instance_type | string | The instance type. |
spot_instance_request_id | string | The ID of the Spot Instance request. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_fleet_instances | select | FleetId, region | DryRun, MaxResults, NextToken, Filter | Describes the running instances for the specified EC2 Fleet. Currently, DescribeFleetInstances does not support fleets of type instant. Instead, use DescribeFleets, specifying the instant fleet ID in the request. For more information, see Describe your EC2 Fleet in the Amazon EC2 User Guide. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
FleetId | string | The ID of the EC2 Fleet. |
region | string | AWS region (default: us-east-1) |
DryRun | boolean | Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. |
Filter | array | The filters. instance-type - The instance type. |
MaxResults | integer | The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. |
NextToken | string | The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. |
SELECT examples
- describe_fleet_instances
Describes the running instances for the specified EC2 Fleet. Currently, DescribeFleetInstances does not support fleets of type instant. Instead, use DescribeFleets, specifying the instant fleet ID in the request. For more information, see Describe your EC2 Fleet in the Amazon EC2 User Guide.
SELECT
instance_health,
instance_id,
instance_type,
spot_instance_request_id
FROM aws.ec2.fleet_instances
WHERE FleetId = '{{ FleetId }}' -- required
AND region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND Filter = '{{ Filter }}'
;