AWS SDK Version 3 for .NET
API Reference

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.

Container for the parameters to the DescribeClusters operation. Describes one or more of your clusters.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ECS.AmazonECSRequest
      Amazon.ECS.Model.DescribeClustersRequest

Namespace: Amazon.ECS.Model
Assembly: AWSSDK.ECS.dll
Version: 3.x.y.z

Syntax

C# 
public class DescribeClustersRequest : AmazonECSRequest
         IAmazonWebServiceRequest

The DescribeClustersRequest type exposes the following members

Constructors

NameDescription
Public Method DescribeClustersRequest()

Properties

NameTypeDescription
Public Property Clusters System.Collections.Generic.List<System.String>

Gets and sets the property Clusters.

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.

Public Property Include System.Collections.Generic.List<System.String>

Gets and sets the property Include.

Determines whether to include additional information about the clusters in the response. If this field is omitted, this information isn't included.

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

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

If CONFIGURATIONS is specified, the configuration for the cluster is included.

If STATISTICS is specified, the task and service count is included, separated by launch type.

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

Examples

This example provides a description of the specified cluster in your default region.

To describe a cluster


var client = new AmazonECSClient();
var response = client.DescribeClusters(new DescribeClustersRequest 
{
    Clusters = new List<string> {
        "default"
    }
});

List<Cluster> clusters = response.Clusters;
List<Failure> failures = response.Failures;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5