Class: Aws::ECS::Types::Cluster

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ecs/types.rb

Overview

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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#active_services_count ⇒ Integer

The number of services that are running on the cluster in an ‘ACTIVE` state. You can view these services with [PListServices].

[1]: docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html

Returns:

  • (Integer) 


692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'lib/aws-sdk-ecs/types.rb', line 692

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :configuration,
  :status,
  :registered_container_instances_count,
  :running_tasks_count,
  :pending_tasks_count,
  :active_services_count,
  :statistics,
  :tags,
  :settings,
  :capacity_providers,
  :default_capacity_provider_strategy,
  :attachments,
  :attachments_status,
  :service_connect_defaults)
  SENSITIVE = []
  include Aws::Structure
end

#attachments ⇒ Array<Types::Attachment>

The resources attached to a cluster. When using a capacity provider with a cluster, the capacity provider and associated resources are returned as cluster attachments.

Returns:



692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'lib/aws-sdk-ecs/types.rb', line 692

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :configuration,
  :status,
  :registered_container_instances_count,
  :running_tasks_count,
  :pending_tasks_count,
  :active_services_count,
  :statistics,
  :tags,
  :settings,
  :capacity_providers,
  :default_capacity_provider_strategy,
  :attachments,
  :attachments_status,
  :service_connect_defaults)
  SENSITIVE = []
  include Aws::Structure
end

#attachments_status ⇒ String

The status of the capacity providers associated with the cluster. The following are the states that are returned.

UPDATE_IN_PROGRESS

: The available capacity providers for the cluster are updating.

UPDATE_COMPLETE

: The capacity providers have successfully updated.

UPDATE_FAILED

: The capacity provider updates failed.

Returns:

  • (String) 


692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'lib/aws-sdk-ecs/types.rb', line 692

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :configuration,
  :status,
  :registered_container_instances_count,
  :running_tasks_count,
  :pending_tasks_count,
  :active_services_count,
  :statistics,
  :tags,
  :settings,
  :capacity_providers,
  :default_capacity_provider_strategy,
  :attachments,
  :attachments_status,
  :service_connect_defaults)
  SENSITIVE = []
  include Aws::Structure
end

#capacity_providers ⇒ Array<String>

The capacity providers associated with the cluster.

Returns:

  • (Array<String>) 


692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'lib/aws-sdk-ecs/types.rb', line 692

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :configuration,
  :status,
  :registered_container_instances_count,
  :running_tasks_count,
  :pending_tasks_count,
  :active_services_count,
  :statistics,
  :tags,
  :settings,
  :capacity_providers,
  :default_capacity_provider_strategy,
  :attachments,
  :attachments_status,
  :service_connect_defaults)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_arn ⇒ String

The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN format, see [Amazon Resource Name (ARN)] in the *Amazon ECS Developer Guide*.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids

Returns:

  • (String) 


692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'lib/aws-sdk-ecs/types.rb', line 692

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :configuration,
  :status,
  :registered_container_instances_count,
  :running_tasks_count,
  :pending_tasks_count,
  :active_services_count,
  :statistics,
  :tags,
  :settings,
  :capacity_providers,
  :default_capacity_provider_strategy,
  :attachments,
  :attachments_status,
  :service_connect_defaults)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_name ⇒ String

A user-generated string that you use to identify your cluster.

Returns:

  • (String) 


692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'lib/aws-sdk-ecs/types.rb', line 692

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :configuration,
  :status,
  :registered_container_instances_count,
  :running_tasks_count,
  :pending_tasks_count,
  :active_services_count,
  :statistics,
  :tags,
  :settings,
  :capacity_providers,
  :default_capacity_provider_strategy,
  :attachments,
  :attachments_status,
  :service_connect_defaults)
  SENSITIVE = []
  include Aws::Structure
end

#configuration ⇒ Types::ClusterConfiguration

The execute command configuration for the cluster.

Returns:



692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'lib/aws-sdk-ecs/types.rb', line 692

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :configuration,
  :status,
  :registered_container_instances_count,
  :running_tasks_count,
  :pending_tasks_count,
  :active_services_count,
  :statistics,
  :tags,
  :settings,
  :capacity_providers,
  :default_capacity_provider_strategy,
  :attachments,
  :attachments_status,
  :service_connect_defaults)
  SENSITIVE = []
  include Aws::Structure
end

#default_capacity_provider_strategy ⇒ Array<Types::CapacityProviderStrategyItem>

The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.

Returns:



692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'lib/aws-sdk-ecs/types.rb', line 692

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :configuration,
  :status,
  :registered_container_instances_count,
  :running_tasks_count,
  :pending_tasks_count,
  :active_services_count,
  :statistics,
  :tags,
  :settings,
  :capacity_providers,
  :default_capacity_provider_strategy,
  :attachments,
  :attachments_status,
  :service_connect_defaults)
  SENSITIVE = []
  include Aws::Structure
end

#pending_tasks_count ⇒ Integer

The number of tasks in the cluster that are in the ‘PENDING` state.

Returns:

  • (Integer) 


692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'lib/aws-sdk-ecs/types.rb', line 692

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :configuration,
  :status,
  :registered_container_instances_count,
  :running_tasks_count,
  :pending_tasks_count,
  :active_services_count,
  :statistics,
  :tags,
  :settings,
  :capacity_providers,
  :default_capacity_provider_strategy,
  :attachments,
  :attachments_status,
  :service_connect_defaults)
  SENSITIVE = []
  include Aws::Structure
end

#registered_container_instances_count ⇒ Integer

The number of container instances registered into the cluster. This includes container instances in both ‘ACTIVE` and `DRAINING` status.

Returns:

  • (Integer) 


692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'lib/aws-sdk-ecs/types.rb', line 692

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :configuration,
  :status,
  :registered_container_instances_count,
  :running_tasks_count,
  :pending_tasks_count,
  :active_services_count,
  :statistics,
  :tags,
  :settings,
  :capacity_providers,
  :default_capacity_provider_strategy,
  :attachments,
  :attachments_status,
  :service_connect_defaults)
  SENSITIVE = []
  include Aws::Structure
end

#running_tasks_count ⇒ Integer

The number of tasks in the cluster that are in the ‘RUNNING` state.

Returns:

  • (Integer) 


692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'lib/aws-sdk-ecs/types.rb', line 692

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :configuration,
  :status,
  :registered_container_instances_count,
  :running_tasks_count,
  :pending_tasks_count,
  :active_services_count,
  :statistics,
  :tags,
  :settings,
  :capacity_providers,
  :default_capacity_provider_strategy,
  :attachments,
  :attachments_status,
  :service_connect_defaults)
  SENSITIVE = []
  include Aws::Structure
end

#service_connect_defaults ⇒ Types::ClusterServiceConnectDefaults

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*.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html

Returns:



692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'lib/aws-sdk-ecs/types.rb', line 692

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :configuration,
  :status,
  :registered_container_instances_count,
  :running_tasks_count,
  :pending_tasks_count,
  :active_services_count,
  :statistics,
  :tags,
  :settings,
  :capacity_providers,
  :default_capacity_provider_strategy,
  :attachments,
  :attachments_status,
  :service_connect_defaults)
  SENSITIVE = []
  include Aws::Structure
end

#settings ⇒ Array<Types::ClusterSetting>

The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is on or off for a cluster.

Returns:



692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'lib/aws-sdk-ecs/types.rb', line 692

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :configuration,
  :status,
  :registered_container_instances_count,
  :running_tasks_count,
  :pending_tasks_count,
  :active_services_count,
  :statistics,
  :tags,
  :settings,
  :capacity_providers,
  :default_capacity_provider_strategy,
  :attachments,
  :attachments_status,
  :service_connect_defaults)
  SENSITIVE = []
  include Aws::Structure
end

#statistics ⇒ Array<Types::KeyValuePair>

Additional information about your clusters that are separated by launch type. They include the following:

  • runningEC2TasksCount

  • RunningFargateTasksCount

  • pendingEC2TasksCount

  • pendingFargateTasksCount

  • activeEC2ServiceCount

  • activeFargateServiceCount

  • drainingEC2ServiceCount

  • drainingFargateServiceCount

Returns:



692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'lib/aws-sdk-ecs/types.rb', line 692

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :configuration,
  :status,
  :registered_container_instances_count,
  :running_tasks_count,
  :pending_tasks_count,
  :active_services_count,
  :statistics,
  :tags,
  :settings,
  :capacity_providers,
  :default_capacity_provider_strategy,
  :attachments,
  :attachments_status,
  :service_connect_defaults)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the cluster. The following are the possible states that are returned.

ACTIVE

: The cluster is ready to accept tasks and if applicable you can

register container instances with the cluster.

PROVISIONING

: The cluster has capacity providers that are associated with it and

the resources needed for the capacity provider are being created.

DEPROVISIONING

: The cluster has capacity providers that are associated with it and

the resources needed for the capacity provider are being deleted.

FAILED

: The cluster has capacity providers that are associated with it and

the resources needed for the capacity provider have failed to
create.

INACTIVE

: The cluster has been deleted. Clusters with an ‘INACTIVE` status

may 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.

Returns:

  • (String) 


692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'lib/aws-sdk-ecs/types.rb', line 692

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :configuration,
  :status,
  :registered_container_instances_count,
  :running_tasks_count,
  :pending_tasks_count,
  :active_services_count,
  :statistics,
  :tags,
  :settings,
  :capacity_providers,
  :default_capacity_provider_strategy,
  :attachments,
  :attachments_status,
  :service_connect_defaults)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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.

Returns:



692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'lib/aws-sdk-ecs/types.rb', line 692

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :configuration,
  :status,
  :registered_container_instances_count,
  :running_tasks_count,
  :pending_tasks_count,
  :active_services_count,
  :statistics,
  :tags,
  :settings,
  :capacity_providers,
  :default_capacity_provider_strategy,
  :attachments,
  :attachments_status,
  :service_connect_defaults)
  SENSITIVE = []
  include Aws::Structure
end