Package software.amazon.awssdk.services.ecs.model

Interface ListContainerInstancesRequest.Builder

    • Method Detail

      • cluster

        ListContainerInstancesRequest.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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • filter

        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 Elastic Container Service Developer Guide.

        Parameters:
        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 Elastic Container Service Developer Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nextToken

        ListContainerInstancesRequest.Builder nextToken​(String nextToken)

        The nextToken value returned from a ListContainerInstances request indicating that more results are available to fulfill the request and further calls are needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.

        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.

        Parameters:
        nextToken - The nextToken value returned from a ListContainerInstances request indicating that more results are available to fulfill the request and further calls are needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.

        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxResults

        ListContainerInstancesRequest.Builder maxResults​(Integer maxResults)

        The maximum number of container instance results that ListContainerInstances returned 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 isn't used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.

        Parameters:
        maxResults - The maximum number of container instance results that ListContainerInstances returned 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 isn't used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        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 don't specify this parameter, the default is to include container instances set to all states other than INACTIVE.

        Parameters:
        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 don't specify this parameter, the default is to include container instances set to all states other than INACTIVE.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ContainerInstanceStatus, ContainerInstanceStatus

      • status

        ListContainerInstancesRequest.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 don't specify this parameter, the default is to include container instances set to all states other than INACTIVE.

        Parameters:
        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 don't specify this parameter, the default is to include container instances set to all states other than INACTIVE.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ContainerInstanceStatus, ContainerInstanceStatus