1. Pulumi Registry
  2. AWS Native
  3. API Docs
  4. ecs
  5. getCluster
aws-native logo
AWS Native v0.54.0, Mar 21 23

aws-native.ecs.getCluster

Create an Elastic Container Service (ECS) cluster.

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,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(cluster_name: Optional[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-native:ecs:getCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

ClusterName string

A user-generated string that you use to identify your cluster. If you don't specify a name, AWS CloudFormation generates a unique physical ID for the name.

ClusterName string

A user-generated string that you use to identify your cluster. If you don't specify a name, AWS CloudFormation generates a unique physical ID for the name.

clusterName String

A user-generated string that you use to identify your cluster. If you don't specify a name, AWS CloudFormation generates a unique physical ID for the name.

clusterName string

A user-generated string that you use to identify your cluster. If you don't specify a name, AWS CloudFormation generates a unique physical ID for the name.

cluster_name str

A user-generated string that you use to identify your cluster. If you don't specify a name, AWS CloudFormation generates a unique physical ID for the name.

clusterName String

A user-generated string that you use to identify your cluster. If you don't specify a name, AWS CloudFormation generates a unique physical ID for the name.

getCluster Result

The following output properties are available:

Arn string

The Amazon Resource Name (ARN) of the Amazon ECS cluster, such as arn:aws:ecs:us-east-2:123456789012:cluster/MyECSCluster.

CapacityProviders []string
ClusterSettings []ClusterSettings
Configuration ClusterConfiguration
DefaultCapacityProviderStrategy []ClusterCapacityProviderStrategyItem
Tags []ClusterTag
arn String

The Amazon Resource Name (ARN) of the Amazon ECS cluster, such as arn:aws:ecs:us-east-2:123456789012:cluster/MyECSCluster.

capacityProviders List<String>
clusterSettings List<ClusterSettings>
configuration ClusterConfiguration
defaultCapacityProviderStrategy List<ClusterCapacityProviderStrategyItem>
tags List<ClusterTag>
arn string

The Amazon Resource Name (ARN) of the Amazon ECS cluster, such as arn:aws:ecs:us-east-2:123456789012:cluster/MyECSCluster.

capacityProviders string[]
clusterSettings ClusterSettings[]
configuration ClusterConfiguration
defaultCapacityProviderStrategy ClusterCapacityProviderStrategyItem[]
tags ClusterTag[]
arn str

The Amazon Resource Name (ARN) of the Amazon ECS cluster, such as arn:aws:ecs:us-east-2:123456789012:cluster/MyECSCluster.

capacity_providers Sequence[str]
cluster_settings Sequence[ClusterSettings]
configuration ClusterConfiguration
default_capacity_provider_strategy Sequence[ClusterCapacityProviderStrategyItem]
tags Sequence[ClusterTag]
arn String

The Amazon Resource Name (ARN) of the Amazon ECS cluster, such as arn:aws:ecs:us-east-2:123456789012:cluster/MyECSCluster.

capacityProviders List<String>
clusterSettings List<Property Map>
configuration Property Map
defaultCapacityProviderStrategy List<Property Map>
tags List<Property Map>

Supporting Types

ClusterCapacityProviderStrategyItem

base Integer
capacityProvider String
weight Integer
base number
capacityProvider string
weight number
base Number
capacityProvider String
weight Number

ClusterConfiguration

ClusterExecuteCommandConfiguration

ClusterExecuteCommandLogConfiguration

ClusterSettings

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

ClusterTag

Key string
Value string
Key string
Value string
key String
value String
key string
value string
key str
value str
key String
value String

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0