1. Docs
  2. Reference
  3. API
  4. AWS
  5. ecs
  6. GetCluster

GetCluster

The ECS Cluster data source allows access to details of a specific cluster within an AWS ECS service.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var ecs_mongo = Output.Create(Aws.Ecs.GetCluster.InvokeAsync(new Aws.Ecs.GetClusterArgs
        {
            ClusterName = "ecs-mongo-production",
        }));
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/ecs"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := ecs.LookupCluster(ctx, &ecs.LookupClusterArgs{
            ClusterName: "ecs-mongo-production",
        }, nil)
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_aws as aws

ecs_mongo = aws.ecs.get_cluster(cluster_name="ecs-mongo-production")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const ecs_mongo = pulumi.output(aws.ecs.getCluster({
    clusterName: "ecs-mongo-production",
}, { async: true }));

Using GetCluster

function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function  get_cluster(cluster_name=None, opts=None)
func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)

Note: This function is named LookupCluster in the Go SDK.

public static class GetCluster {
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

ClusterName string

The name of the ECS Cluster

ClusterName string

The name of the ECS Cluster

clusterName string

The name of the ECS Cluster

cluster_name str

The name of the ECS Cluster

GetCluster Result

The following output properties are available:

Arn string

The ARN of the ECS Cluster

ClusterName string
Id string

The provider-assigned unique ID for this managed resource.

PendingTasksCount int

The number of pending tasks for the ECS Cluster

RegisteredContainerInstancesCount int

The number of registered container instances for the ECS Cluster

RunningTasksCount int

The number of running tasks for the ECS Cluster

Settings List<GetClusterSetting>

The settings associated with the ECS Cluster.

Status string

The status of the ECS Cluster

Arn string

The ARN of the ECS Cluster

ClusterName string
Id string

The provider-assigned unique ID for this managed resource.

PendingTasksCount int

The number of pending tasks for the ECS Cluster

RegisteredContainerInstancesCount int

The number of registered container instances for the ECS Cluster

RunningTasksCount int

The number of running tasks for the ECS Cluster

Settings []GetClusterSetting

The settings associated with the ECS Cluster.

Status string

The status of the ECS Cluster

arn string

The ARN of the ECS Cluster

clusterName string
id string

The provider-assigned unique ID for this managed resource.

pendingTasksCount number

The number of pending tasks for the ECS Cluster

registeredContainerInstancesCount number

The number of registered container instances for the ECS Cluster

runningTasksCount number

The number of running tasks for the ECS Cluster

settings GetClusterSetting[]

The settings associated with the ECS Cluster.

status string

The status of the ECS Cluster

arn str

The ARN of the ECS Cluster

cluster_name str
id str

The provider-assigned unique ID for this managed resource.

pending_tasks_count float

The number of pending tasks for the ECS Cluster

registered_container_instances_count float

The number of registered container instances for the ECS Cluster

running_tasks_count float

The number of running tasks for the ECS Cluster

settings List[GetClusterSetting]

The settings associated with the ECS Cluster.

status str

The status of the ECS Cluster

Supporting Types

GetClusterSetting

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

Name string
Value string
Name string
Value string
name string
value string
name str
value str

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.