instance_topologies

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

Overview

Name	instance_topologies
Type	Resource
Id	aws.ec2.instance_topologies

Fields

The following fields are returned by SELECT queries:

describe_instance_topology

Name	Datatype	Description
availability_zone	string	The name of the Availability Zone or Local Zone that the instance is in.
capacity_block_id	string	The ID of the Capacity Block. This parameter is only supported for UltraServer instances and identifies instances within the UltraServer domain.
group_name	string	The name of the placement group that the instance is in.
instance_id	string	The instance ID.
instance_type	string	The instance type.
network_nodes	string	The network nodes. The nodes are hashed based on your account. Instances from different accounts running under the same server will return a different hashed list of strings. The value is null or empty if: The instance type is not supported. The instance is in a state other than running.
zone_id	string	The ID of the Availability Zone or Local Zone that the instance is in.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_instance_topology	select	region	DryRun, NextToken, MaxResults, InstanceId, GroupName, Filter	Describes a tree-based hierarchy that represents the physical host placement of your EC2 instances within an Availability Zone or Local Zone. You can use this information to determine the relative proximity of your EC2 instances within the Amazon Web Services network to support your tightly coupled workloads. Instance topology is supported for specific instance types only. For more information, see Prerequisites for Amazon EC2 instance topology in the Amazon EC2 User Guide. The Amazon EC2 API follows an eventual consistency model due to the distributed nature of the system supporting it. As a result, when you call the DescribeInstanceTopology API command immediately after launching instances, the response might return a null value for capacityBlockId because the data might not have fully propagated across all subsystems. For more information, see Eventual consistency in the Amazon EC2 API in the Amazon EC2 Developer Guide. For more information, see Amazon EC2 topology 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
region	string	AWS region (default: us-east-1)
DryRun	boolean	Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Filter	array	The filters. availability-zone - The name of the Availability Zone (for example, us-west-2a) or Local Zone (for example, us-west-2-lax-1b) that the instance is in. instance-type - The instance type (for example, p4d.24xlarge) or instance family (for example, p4d*). You can use the * wildcard to match zero or more characters, or the ? wildcard to match zero or one character. zone-id - The ID of the Availability Zone (for example, usw2-az2) or Local Zone (for example, usw2-lax1-az1) that the instance is in.
GroupName	array	The name of the placement group that each instance is in. Constraints: Maximum 100 explicitly specified placement group names.
InstanceId	array	The instance IDs. Default: Describes all your instances. Constraints: Maximum 100 explicitly specified instance IDs.
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. You can't specify this parameter and the instance IDs parameter in the same request. Default: 20
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_instance_topology

Describes a tree-based hierarchy that represents the physical host placement of your EC2 instances within an Availability Zone or Local Zone. You can use this information to determine the relative proximity of your EC2 instances within the Amazon Web Services network to support your tightly coupled workloads. Instance topology is supported for specific instance types only. For more information, see Prerequisites for Amazon EC2 instance topology in the Amazon EC2 User Guide. The Amazon EC2 API follows an eventual consistency model due to the distributed nature of the system supporting it. As a result, when you call the DescribeInstanceTopology API command immediately after launching instances, the response might return a null value for capacityBlockId because the data might not have fully propagated across all subsystems. For more information, see Eventual consistency in the Amazon EC2 API in the Amazon EC2 Developer Guide. For more information, see Amazon EC2 topology in the Amazon EC2 User Guide.

SELECT
availability_zone,
capacity_block_id,
group_name,
instance_id,
instance_type,
network_nodes,
zone_id
FROM aws.ec2.instance_topologies
WHERE region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
AND InstanceId = '{{ InstanceId }}'
AND GroupName = '{{ GroupName }}'
AND Filter = '{{ Filter }}'
;