clusters

Creates, updates, deletes, gets or lists a clusters resource.

Overview

Name	clusters
Type	Resource
Id	aws.ecs.clusters

Fields

The following fields are returned by SELECT queries:

describe_clusters

Name	Datatype	Description
clusters	array	The list of clusters.
failures	array	Any failures associated with the call.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_clusters	select	region		Describes one or more of your clusters. For CLI examples, see describe-clusters.rst on GitHub.
create_cluster	insert	region		Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name. When you call the CreateCluster API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account. This is so that it can manage required resources in other Amazon Web Services services on your behalf. However, if the user that makes the call doesn't have permissions to create the service-linked role, it isn't created. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
update_cluster_settings	update	region, cluster, settings		Modifies the settings to use for a cluster.
update_cluster	update	region, cluster		Updates the cluster.
delete_cluster	delete	region		Deletes the specified cluster. The cluster transitions to the INACTIVE state. Clusters with an INACTIVE status might remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don't recommend that you rely on INACTIVE clusters persisting. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
list_clusters	exec	region		Returns a list of existing clusters.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_clusters

Describes one or more of your clusters. For CLI examples, see describe-clusters.rst on GitHub.

SELECT
clusters,
failures
FROM aws.ecs.clusters
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_cluster

Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name. When you call the CreateCluster API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account. This is so that it can manage required resources in other Amazon Web Services services on your behalf. However, if the user that makes the call doesn't have permissions to create the service-linked role, it isn't created. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

INSERT INTO aws.ecs.clusters (
clusterName,
tags,
settings,
configuration,
capacityProviders,
defaultCapacityProviderStrategy,
serviceConnectDefaults,
region
)
SELECT 
'{{ clusterName }}',
'{{ tags }}',
'{{ settings }}',
'{{ configuration }}',
'{{ capacityProviders }}',
'{{ defaultCapacityProviderStrategy }}',
'{{ serviceConnectDefaults }}',
'{{ region }}'
RETURNING
cluster
;

Manifest

# Description fields are for documentation purposes
- name: clusters
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the clusters resource.
  - name: clusterName
    value: "{{ clusterName }}"
    description: |
      The name of your cluster. If you don't specify a name for your cluster, you create a cluster that's named default. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
  - name: tags
    description: |
      The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both. The following basic restrictions apply to tags: Maximum number of tags per resource - 50 For each resource, each tag key must be unique, and each tag key can have only one value. Maximum key length - 128 Unicode characters in UTF-8 Maximum value length - 256 Unicode characters in UTF-8 If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
    value:
      - key: "{{ key }}"
        value: "{{ value }}"
  - name: settings
    description: |
      The setting to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster. If this value is specified, it overrides the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.
    value:
      - name: "{{ name }}"
        value: "{{ value }}"
  - name: configuration
    description: |
      The execute command configuration for the cluster.
    value:
      executeCommandConfiguration:
        kmsKeyId: "{{ kmsKeyId }}"
        logging: "{{ logging }}"
        logConfiguration:
          cloudWatchLogGroupName: "{{ cloudWatchLogGroupName }}"
          cloudWatchEncryptionEnabled: {{ cloudWatchEncryptionEnabled }}
          s3BucketName: "{{ s3BucketName }}"
          s3EncryptionEnabled: {{ s3EncryptionEnabled }}
          s3KeyPrefix: "{{ s3KeyPrefix }}"
      managedStorageConfiguration:
        kmsKeyId: "{{ kmsKeyId }}"
        fargateEphemeralStorageKmsKeyId: "{{ fargateEphemeralStorageKmsKeyId }}"
  - name: capacityProviders
    value:
      - "{{ capacityProviders }}"
    description: |
      The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the CreateService or RunTask actions. If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation. To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used. The PutCapacityProvider API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
  - name: defaultCapacityProviderStrategy
    description: |
      The capacity provider strategy to set as the default for the cluster. After a default capacity provider strategy is set for a cluster, when you call the CreateService or RunTask APIs with no capacity provider strategy or launch type specified, the default capacity provider strategy for the cluster is used. If a default capacity provider strategy isn't defined for a cluster when it was created, it can be defined later with the PutClusterCapacityProviders API operation.
    value:
      - capacityProvider: "{{ capacityProvider }}"
        weight: {{ weight }}
        base: {{ base }}
  - name: serviceConnectDefaults
    description: |
      Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration. You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
    value:
      namespace: "{{ namespace }}"

UPDATE examples

update_cluster_settings

Modifies the settings to use for a cluster.

UPDATE aws.ecs.clusters
SET 
cluster = '{{ cluster }}',
settings = '{{ settings }}'
WHERE 
region = '{{ region }}' --required
AND cluster = '{{ cluster }}' --required
AND settings = '{{ settings }}' --required
RETURNING
cluster;

update_cluster

Updates the cluster.

UPDATE aws.ecs.clusters
SET 
cluster = '{{ cluster }}',
settings = '{{ settings }}',
configuration = '{{ configuration }}',
serviceConnectDefaults = '{{ serviceConnectDefaults }}'
WHERE 
region = '{{ region }}' --required
AND cluster = '{{ cluster }}' --required
RETURNING
cluster;

DELETE examples

delete_cluster

Deletes the specified cluster. The cluster transitions to the INACTIVE state. Clusters with an INACTIVE status might remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don't recommend that you rely on INACTIVE clusters persisting. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.

DELETE FROM aws.ecs.clusters
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

list_clusters

Returns a list of existing clusters.

EXEC aws.ecs.clusters.list_clusters 
@region='{{ region }}' --required 
@@json=
'{
"nextToken": "{{ nextToken }}", 
"maxResults": {{ maxResults }}
}'
;