AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::ECS::Types::DescribeClustersRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb

Overview

Note:

When making an API call, you may pass DescribeClustersRequest data as a hash:

{
  clusters: ["String"],
  include: ["ATTACHMENTS"], # accepts ATTACHMENTS, SETTINGS, STATISTICS, TAGS
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#clustersArray<String>

A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

Returns:

  • (Array<String>)


3904
3905
3906
3907
3908
3909
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3904

class DescribeClustersRequest < Struct.new(
  :clusters,
  :include)
  SENSITIVE = []
  include Aws::Structure
end

#includeArray<String>

Whether to include additional information about your clusters in the response. If this field is omitted, the attachments, statistics, and tags are not included.

If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included.

If SETTINGS is specified, the settings for the cluster are included.

If STATISTICS is specified, the following additional information, separated by launch type, is included:

  • runningEC2TasksCount

  • runningFargateTasksCount

  • pendingEC2TasksCount

  • pendingFargateTasksCount

  • activeEC2ServiceCount

  • activeFargateServiceCount

  • drainingEC2ServiceCount

  • drainingFargateServiceCount

If TAGS is specified, the metadata tags associated with the cluster are included.

Returns:

  • (Array<String>)


3904
3905
3906
3907
3908
3909
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3904

class DescribeClustersRequest < Struct.new(
  :clusters,
  :include)
  SENSITIVE = []
  include Aws::Structure
end