AWS v6.55.0 published on Monday, Oct 7, 2024 by Pulumi
aws.ecs.getCluster
Explore with Pulumi AI
The ECS Cluster data source allows access to details of a specific cluster within an AWS ECS service.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const ecs-mongo = aws.ecs.getCluster({
clusterName: "ecs-mongo-production",
});
import pulumi
import pulumi_aws as aws
ecs_mongo = aws.ecs.get_cluster(cluster_name="ecs-mongo-production")
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ecs"
"github.com/pulumi/pulumi/sdk/v3/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
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var ecs_mongo = Aws.Ecs.GetCluster.Invoke(new()
{
ClusterName = "ecs-mongo-production",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ecs.EcsFunctions;
import com.pulumi.aws.ecs.inputs.GetClusterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var ecs-mongo = EcsFunctions.getCluster(GetClusterArgs.builder()
.clusterName("ecs-mongo-production")
.build());
}
}
variables:
ecs-mongo:
fn::invoke:
Function: aws:ecs:getCluster
Arguments:
clusterName: ecs-mongo-production
Using getCluster
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>
def get_cluster(cluster_name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(cluster_name: Optional[pulumi.Input[str]] = None,
tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]
func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput
> Note: This function is named LookupCluster
in the Go SDK.
public static class GetCluster
{
public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws:ecs/getCluster:getCluster
arguments:
# arguments dictionary
The following arguments are supported:
- Cluster
Name string - Name of the ECS Cluster
- Dictionary<string, string>
- Key-value map of resource tags
- Cluster
Name string - Name of the ECS Cluster
- map[string]string
- Key-value map of resource tags
- cluster
Name String - Name of the ECS Cluster
- Map<String,String>
- Key-value map of resource tags
- cluster
Name string - Name of the ECS Cluster
- {[key: string]: string}
- Key-value map of resource tags
- cluster_
name str - Name of the ECS Cluster
- Mapping[str, str]
- Key-value map of resource tags
- cluster
Name String - Name of the ECS Cluster
- Map<String>
- Key-value map of resource tags
getCluster Result
The following output properties are available:
- Arn string
- ARN of the ECS Cluster
- Cluster
Name string - Id string
- The provider-assigned unique ID for this managed resource.
- Pending
Tasks intCount - Number of pending tasks for the ECS Cluster
- Registered
Container intInstances Count - The number of registered container instances for the ECS Cluster
- Running
Tasks intCount - Number of running tasks for the ECS Cluster
- Service
Connect List<GetDefaults Cluster Service Connect Default> - The default Service Connect namespace
- Settings
List<Get
Cluster Setting> - Settings associated with the ECS Cluster
- Status string
- Status of the ECS Cluster
- Dictionary<string, string>
- Key-value map of resource tags
- Arn string
- ARN of the ECS Cluster
- Cluster
Name string - Id string
- The provider-assigned unique ID for this managed resource.
- Pending
Tasks intCount - Number of pending tasks for the ECS Cluster
- Registered
Container intInstances Count - The number of registered container instances for the ECS Cluster
- Running
Tasks intCount - Number of running tasks for the ECS Cluster
- Service
Connect []GetDefaults Cluster Service Connect Default - The default Service Connect namespace
- Settings
[]Get
Cluster Setting - Settings associated with the ECS Cluster
- Status string
- Status of the ECS Cluster
- map[string]string
- Key-value map of resource tags
- arn String
- ARN of the ECS Cluster
- cluster
Name String - id String
- The provider-assigned unique ID for this managed resource.
- pending
Tasks IntegerCount - Number of pending tasks for the ECS Cluster
- registered
Container IntegerInstances Count - The number of registered container instances for the ECS Cluster
- running
Tasks IntegerCount - Number of running tasks for the ECS Cluster
- service
Connect List<GetDefaults Cluster Service Connect Default> - The default Service Connect namespace
- settings
List<Get
Cluster Setting> - Settings associated with the ECS Cluster
- status String
- Status of the ECS Cluster
- Map<String,String>
- Key-value map of resource tags
- arn string
- ARN of the ECS Cluster
- cluster
Name string - id string
- The provider-assigned unique ID for this managed resource.
- pending
Tasks numberCount - Number of pending tasks for the ECS Cluster
- registered
Container numberInstances Count - The number of registered container instances for the ECS Cluster
- running
Tasks numberCount - Number of running tasks for the ECS Cluster
- service
Connect GetDefaults Cluster Service Connect Default[] - The default Service Connect namespace
- settings
Get
Cluster Setting[] - Settings associated with the ECS Cluster
- status string
- Status of the ECS Cluster
- {[key: string]: string}
- Key-value map of resource tags
- arn str
- ARN of the ECS Cluster
- cluster_
name str - id str
- The provider-assigned unique ID for this managed resource.
- pending_
tasks_ intcount - Number of pending tasks for the ECS Cluster
- registered_
container_ intinstances_ count - The number of registered container instances for the ECS Cluster
- running_
tasks_ intcount - Number of running tasks for the ECS Cluster
- service_
connect_ Sequence[Getdefaults Cluster Service Connect Default] - The default Service Connect namespace
- settings
Sequence[Get
Cluster Setting] - Settings associated with the ECS Cluster
- status str
- Status of the ECS Cluster
- Mapping[str, str]
- Key-value map of resource tags
- arn String
- ARN of the ECS Cluster
- cluster
Name String - id String
- The provider-assigned unique ID for this managed resource.
- pending
Tasks NumberCount - Number of pending tasks for the ECS Cluster
- registered
Container NumberInstances Count - The number of registered container instances for the ECS Cluster
- running
Tasks NumberCount - Number of running tasks for the ECS Cluster
- service
Connect List<Property Map>Defaults - The default Service Connect namespace
- settings List<Property Map>
- Settings associated with the ECS Cluster
- status String
- Status of the ECS Cluster
- Map<String>
- Key-value map of resource tags
Supporting Types
GetClusterServiceConnectDefault
- Namespace string
- Namespace string
- namespace String
- namespace string
- namespace str
- namespace String
GetClusterSetting
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.