CopyableBuilder<ListContainerInstancesRequest.Builder,ListContainerInstancesRequest>, SdkBuilder<ListContainerInstancesRequest.Builder,ListContainerInstancesRequest>public static interface ListContainerInstancesRequest.Builder extends CopyableBuilder<ListContainerInstancesRequest.Builder,ListContainerInstancesRequest>
| Modifier and Type | Method | Description |
|---|---|---|
ListContainerInstancesRequest.Builder |
cluster(String cluster) |
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list.
|
ListContainerInstancesRequest.Builder |
filter(String filter) |
You can filter the results of a
ListContainerInstances operation with cluster query language
statements. |
ListContainerInstancesRequest.Builder |
maxResults(Integer maxResults) |
The maximum number of container instance results returned by
ListContainerInstances in paginated
output. |
ListContainerInstancesRequest.Builder |
nextToken(String nextToken) |
The
nextToken value returned from a previous paginated ListContainerInstances
request where maxResults was used and the results exceeded the value of that parameter. |
ListContainerInstancesRequest.Builder |
status(String status) |
Filters the container instances by status.
|
ListContainerInstancesRequest.Builder |
status(ContainerInstanceStatus status) |
Filters the container instances by status.
|
copyapply, buildListContainerInstancesRequest.Builder cluster(String cluster)
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.
cluster - The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to
list. If you do not specify a cluster, the default cluster is assumed.ListContainerInstancesRequest.Builder filter(String filter)
You can filter the results of a ListContainerInstances operation with cluster query language
statements. For more information, see Cluster Query
Language in the Amazon EC2 Container Service Developer Guide.
filter - You can filter the results of a ListContainerInstances operation with cluster query
language statements. For more information, see Cluster
Query Language in the Amazon EC2 Container Service Developer Guide.ListContainerInstancesRequest.Builder nextToken(String nextToken)
The nextToken value returned from a previous paginated ListContainerInstances
request where maxResults was used and the results exceeded the value of that parameter.
Pagination continues from the end of the previous results that returned the nextToken value.
This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
nextToken - The nextToken value returned from a previous paginated
ListContainerInstances request where maxResults was used and the results
exceeded the value of that parameter. Pagination continues from the end of the previous results that
returned the nextToken value. This value is null when there are no more
results to return. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
ListContainerInstancesRequest.Builder maxResults(Integer maxResults)
The maximum number of container instance results returned by ListContainerInstances in paginated
output. When this parameter is used, ListContainerInstances only returns maxResults
results in a single page along with a nextToken response element. The remaining results of the
initial request can be seen by sending another ListContainerInstances request with the returned
nextToken value. This value can be between 1 and 100. If this parameter is not used, then
ListContainerInstances returns up to 100 results and a nextToken value if
applicable.
maxResults - The maximum number of container instance results returned by ListContainerInstances in
paginated output. When this parameter is used, ListContainerInstances only returns
maxResults results in a single page along with a nextToken response element.
The remaining results of the initial request can be seen by sending another
ListContainerInstances request with the returned nextToken value. This value
can be between 1 and 100. If this parameter is not used, then ListContainerInstances
returns up to 100 results and a nextToken value if applicable.ListContainerInstancesRequest.Builder status(String status)
Filters the container instances by status. For example, if you specify the DRAINING status, the
results include only container instances that have been set to DRAINING using
UpdateContainerInstancesState. If you do not specify this parameter, the default is to include
container instances set to ACTIVE and DRAINING.
status - Filters the container instances by status. For example, if you specify the DRAINING
status, the results include only container instances that have been set to DRAINING using
UpdateContainerInstancesState. If you do not specify this parameter, the default is to include
container instances set to ACTIVE and DRAINING.ContainerInstanceStatusListContainerInstancesRequest.Builder status(ContainerInstanceStatus status)
Filters the container instances by status. For example, if you specify the DRAINING status, the
results include only container instances that have been set to DRAINING using
UpdateContainerInstancesState. If you do not specify this parameter, the default is to include
container instances set to ACTIVE and DRAINING.
status - Filters the container instances by status. For example, if you specify the DRAINING
status, the results include only container instances that have been set to DRAINING using
UpdateContainerInstancesState. If you do not specify this parameter, the default is to include
container instances set to ACTIVE and DRAINING.ContainerInstanceStatusCopyright © 2017 Amazon Web Services, Inc. All Rights Reserved.