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 DescribeEcsClusters operation. Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the MaxResults and NextToken parameters to paginate the response. However, AWS OpsWorks Stacks currently supports only one cluster per layer, so the result set has a maximum of one element.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information on user permissions, see Managing User Permissions.

This call accepts only one resource-identifying parameter.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.OpsWorks.AmazonOpsWorksRequest
      Amazon.OpsWorks.Model.DescribeEcsClustersRequest

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

Syntax

C#
public class DescribeEcsClustersRequest : AmazonOpsWorksRequest
         IAmazonWebServiceRequest

The DescribeEcsClustersRequest type exposes the following members

Constructors

Properties

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

Gets and sets the property EcsClusterArns.

A list of ARNs, one for each cluster to be described.

Public Property MaxResults System.Int32

Gets and sets the property MaxResults.

To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

Public Property NextToken System.String

Gets and sets the property NextToken.

If the previous paginated request did not return all of the remaining results, the response object'sNextToken parameter value is set to a token. To retrieve the next set of results, call DescribeEcsClusters again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Public Property StackId System.String

Gets and sets the property StackId.

A stack ID. DescribeEcsClusters returns a description of the cluster that is registered with the stack.

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms