Container for the parameters to the DescribeInstanceTopology operation. 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 instance topology in the Amazon EC2 User Guide.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.EC2.AmazonEC2Request
Amazon.EC2.Model.DescribeInstanceTopologyRequest
Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z
Syntax
public class DescribeInstanceTopologyRequest : AmazonEC2Request IAmazonWebServiceRequest
The DescribeInstanceTopologyRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
DescribeInstanceTopologyRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
DryRun | System.Nullable<System.Boolean> |
Gets and sets the property DryRun.
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 |
|
|
Filters | System.Collections.Generic.List<Amazon.EC2.Model.Filter> |
Gets and sets the property Filters. The filters.
|
|
|
GroupNames | System.Collections.Generic.List<System.String> |
Gets and sets the property GroupNames. The name of the placement group that each instance is in. Constraints: Maximum 100 explicitly specified placement group names. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. |
|
|
InstanceIds | System.Collections.Generic.List<System.String> |
Gets and sets the property InstanceIds. The instance IDs. Default: Describes all your instances. Constraints: Maximum 100 explicitly specified instance IDs. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. |
|
|
MaxResults | System.Nullable<System.Int32> |
Gets and sets the property MaxResults. 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: |
|
|
NextToken | System.String |
Gets and sets the property NextToken. The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer