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::OpsWorks::Types::DescribeEcsClustersRequest

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

Overview

Note:

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

{
  ecs_cluster_arns: ["String"],
  stack_id: "String",
  next_token: "String",
  max_results: 1,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#ecs_cluster_arnsArray<String>

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

Returns:

  • (Array<String>)


2919
2920
2921
2922
2923
2924
2925
2926
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2919

class DescribeEcsClustersRequest < Struct.new(
  :ecs_cluster_arns,
  :stack_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

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.

Returns:

  • (Integer)


2919
2920
2921
2922
2923
2924
2925
2926
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2919

class DescribeEcsClustersRequest < Struct.new(
  :ecs_cluster_arns,
  :stack_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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.

Returns:

  • (String)


2919
2920
2921
2922
2923
2924
2925
2926
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2919

class DescribeEcsClustersRequest < Struct.new(
  :ecs_cluster_arns,
  :stack_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#stack_idString

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

Returns:

  • (String)


2919
2920
2921
2922
2923
2924
2925
2926
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2919

class DescribeEcsClustersRequest < Struct.new(
  :ecs_cluster_arns,
  :stack_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end