Cluster

ecs.services.k8s.aws/v1alpha1

Metadata#

A regional grouping of one or more container instances where you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.

Spec#

capacityProviders:
- string
configuration: 
  executeCommandConfiguration: 
    kmsKeyID: string
    logConfiguration: 
      cloudWatchEncryptionEnabled: boolean
      cloudWatchLogGroupName: string
      s3BucketName: string
      s3EncryptionEnabled: boolean
      s3KeyPrefix: string
    logging: string
defaultCapacityProviderStrategy:
- base: integer
  capacityProvider: string
  weight: integer
name: string
serviceConnectDefaults: 
  namespace: string
settings:
- name: string
  value: string
tags:
- key: string
  value: string

Only capacity providers that are already associated with a cluster and have an ACTIVE or UPDATING status can be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. 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 in a capacity provider strategy.

A capacity provider strategy may contain a maximum of 6 capacity providers. || defaultCapacityProviderStrategy.[].base
Optional | integer
| | defaultCapacityProviderStrategy.[].capacityProvider
Optional | string
| | defaultCapacityProviderStrategy.[].weight
Optional | integer
| | name
Optional | string
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. | | serviceConnectDefaults
Optional | object
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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)
in the Amazon Elastic Container Service Developer Guide. | | serviceConnectDefaults.namespace
Optional | string
| | settings
Optional | array
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. | | settings.[]
Required | object
The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster. || settings.[].name
Optional | string
| | settings.[].value
Optional | string
| | tags
Optional | array
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. | | tags.[]
Required | object
The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.

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. || tags.[].key
  Optional | string
  | | tags.[].value
  Optional | string
  |

Status#

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
activeServicesCount: integer
attachments:
  details:
  - name: string
    value: string
  id: string
  status: string
  type: string
attachmentsStatus: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
pendingTasksCount: integer
registeredContainerInstancesCount: integer
runningTasksCount: integer
statistics:
- name: string
  value: string
status: string