/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace ECS { namespace Model { /** */ class AWS_ECS_API DescribeClustersRequest : public ECSRequest { public: DescribeClustersRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "DescribeClusters"; } Aws::String SerializePayload() const override; Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

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.

*/ inline const Aws::Vector& GetClusters() const{ return m_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.

*/ inline bool ClustersHasBeenSet() const { return m_clustersHasBeenSet; } /** *

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.

*/ inline void SetClusters(const Aws::Vector& value) { m_clustersHasBeenSet = true; m_clusters = value; } /** *

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.

*/ inline void SetClusters(Aws::Vector&& value) { m_clustersHasBeenSet = true; m_clusters = std::move(value); } /** *

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.

*/ inline DescribeClustersRequest& WithClusters(const Aws::Vector& value) { SetClusters(value); return *this;} /** *

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.

*/ inline DescribeClustersRequest& WithClusters(Aws::Vector&& value) { SetClusters(std::move(value)); return *this;} /** *

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.

*/ inline DescribeClustersRequest& AddClusters(const Aws::String& value) { m_clustersHasBeenSet = true; m_clusters.push_back(value); return *this; } /** *

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.

*/ inline DescribeClustersRequest& AddClusters(Aws::String&& value) { m_clustersHasBeenSet = true; m_clusters.push_back(std::move(value)); return *this; } /** *

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.

*/ inline DescribeClustersRequest& AddClusters(const char* value) { m_clustersHasBeenSet = true; m_clusters.push_back(value); return *this; } /** *

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.

*/ inline const Aws::Vector& GetInclude() const{ return m_include; } /** *

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.

*/ inline bool IncludeHasBeenSet() const { return m_includeHasBeenSet; } /** *

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.

*/ inline void SetInclude(const Aws::Vector& value) { m_includeHasBeenSet = true; m_include = value; } /** *

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.

*/ inline void SetInclude(Aws::Vector&& value) { m_includeHasBeenSet = true; m_include = std::move(value); } /** *

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.

*/ inline DescribeClustersRequest& WithInclude(const Aws::Vector& value) { SetInclude(value); return *this;} /** *

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.

*/ inline DescribeClustersRequest& WithInclude(Aws::Vector&& value) { SetInclude(std::move(value)); return *this;} /** *

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.

*/ inline DescribeClustersRequest& AddInclude(const ClusterField& value) { m_includeHasBeenSet = true; m_include.push_back(value); return *this; } /** *

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.

*/ inline DescribeClustersRequest& AddInclude(ClusterField&& value) { m_includeHasBeenSet = true; m_include.push_back(std::move(value)); return *this; } private: Aws::Vector m_clusters; bool m_clustersHasBeenSet; Aws::Vector m_include; bool m_includeHasBeenSet; }; } // namespace Model } // namespace ECS } // namespace Aws