ECSCluster | Praxis resources

Resource definition

What this resource looks like

This is the CUE shape a Praxis template uses to declare a ECSCluster. The resource key is local to the template; metadata.name supplies its stable Praxis identity.

resources: compute: {
  apiVersion: "praxis.io/alpha"
  kind: "ECSCluster"
  metadata: {name: "payments", labels: {}}
  spec: {
    region: "us-west-2"
    containerInsights: "enabled"
    capacityProviders: ["FARGATE", "FARGATE_SPOT"]
    tags: environment: "prod"
  }
}

Complete examples in the repository

stacks foundation services

Desired state

Configuration

The spec block accepts 4 fields. 3 are required by the schema; fields with defaults can be omitted.

regionRequired

Region.

string

String

containerInsightsOptional

Mutable — CloudWatch Container Insights for the cluster. Maps to the cluster setting named "containerInsights". Defaults to disabled.

*"disabled" | "enabled"

EnumDefault "disabled"

capacityProvidersRequired

Mutable — the capacity providers associated with the cluster, e.g. FARGATE and FARGATE_SPOT. Converged in place via PutClusterCapacityProviders.

[...string]

List

tagsRequired

Tags.

[string]: string

Map

Observed values

Outputs

Praxis records these values after observation. A dependent resource can read one with ${resources.<name>.outputs.<field>}.

arnString

nameString

statusString

Read without ownership

Data-source lookup

A data block reads an existing ECSCluster and exposes its outputs without storing lifecycle state. The generic filter surface accepts id, name, and tag; supported combinations depend on the AWS identity used by this resource.

data: existing: {
  kind: "ECSCluster"
  region: "us-west-2"
  filter: {
    name: "replace-with-provider-name"
  }
}

Documented selectorsidnameid/name + tag

Understand data sources and filters →

Adopt existing infrastructure

Import

Import persists Praxis state for an existing AWS resource. For this kind, supply: Cluster name or ARN and region. The example starts in observed mode so Praxis reports drift without correcting it.

praxis import ECSCluster \
  --id <provider-identifier> \
  --region us-west-2 \
  --account production \
  --observe

Choose managed or observed ownership →

Canonical contract

Complete CUE schema

The field guide above is derived from this definition. The schema remains the source of truth for accepted values, defaults, validation constraints, and outputs in the current alpha revision.

Show the complete schema

package ecs

#ECSCluster: {
	apiVersion: "praxis.io/alpha"
	kind:       "ECSCluster"

	metadata: {
		// Cluster names are up to 255 chars: letters, digits, hyphens, underscores.
		name: string & =~"^[a-zA-Z0-9][a-zA-Z0-9_-]{0,254}$"
		labels: [string]: string
	}

	spec: {
		region: string

		// Mutable — CloudWatch Container Insights for the cluster. Maps to the
		// cluster setting named "containerInsights". Defaults to disabled.
		containerInsights: *"disabled" | "enabled"

		// Mutable — the capacity providers associated with the cluster, e.g.
		// FARGATE and FARGATE_SPOT. Converged in place via
		// PutClusterCapacityProviders.
		capacityProviders: [...string]

		tags: [string]: string
	}

	outputs?: {
		arn:    string
		name:   string
		status: string
	}
}

View this schema on GitHub →