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

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

Overview

A regional grouping of one or more container instances on which 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#active_services_countInteger

The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.

Returns:

  • (Integer)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 572

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#attachmentsArray<Types::Attachment>

The resources attached to a cluster. When using a capacity provider with a cluster, the Auto Scaling plan that is created will be returned as a cluster attachment.

Returns:



572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 572

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#attachments_statusString

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

UPDATE_IN_PROGRESS

The available capacity providers for the cluster are updating. This occurs when the Auto Scaling plan is provisioning or deprovisioning.

UPDATE_COMPLETE

The capacity providers have successfully updated.

UPDATE_FAILED

The capacity provider updates failed.

Returns:

  • (String)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 572

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#capacity_providersArray<String>

The capacity providers associated with the cluster.

Returns:

  • (Array<String>)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 572

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_arnString

The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.

Returns:

  • (String)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 572

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_nameString

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

Returns:

  • (String)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 572

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#default_capacity_provider_strategyArray<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.



572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 572

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#pending_tasks_countInteger

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

Returns:

  • (Integer)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 572

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#registered_container_instances_countInteger

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

Returns:

  • (Integer)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 572

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#running_tasks_countInteger

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

Returns:

  • (Integer)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 572

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#settingsArray<Types::ClusterSetting>

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

Returns:



572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 572

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#statisticsArray<Types::KeyValuePair>

Additional information about your clusters that are separated by launch type, including:

  • runningEC2TasksCount

  • RunningFargateTasksCount

  • pendingEC2TasksCount

  • pendingFargateTasksCount

  • activeEC2ServiceCount

  • activeFargateServiceCount

  • drainingEC2ServiceCount

  • drainingFargateServiceCount

Returns:



572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 572

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The status of the cluster. The following are the possible states that will be 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 associated with it and the resources needed for the capacity provider are being created.

DEPROVISIONING

The cluster has capacity providers associated with it and the resources needed for the capacity provider are being deleted.

FAILED

The cluster has capacity providers 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, so you should not rely on INACTIVE clusters persisting.

Returns:

  • (String)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 572

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<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, both of which you define.

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 AWS 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:



572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 572

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :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)
  SENSITIVE = []
  include Aws::Structure
end