Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ECS.Types.Cluster

Description

Synopsis

data Cluster = Cluster' {
- status :: Maybe Text
- clusterArn :: Maybe Text
- attachments :: Maybe [Attachment]
- runningTasksCount :: Maybe Int
- defaultCapacityProviderStrategy :: Maybe [CapacityProviderStrategyItem]
- settings :: Maybe [ClusterSetting]
- registeredContainerInstancesCount :: Maybe Int
- pendingTasksCount :: Maybe Int
- clusterName :: Maybe Text
- statistics :: Maybe [KeyValuePair]
- configuration :: Maybe ClusterConfiguration
- attachmentsStatus :: Maybe Text
- capacityProviders :: Maybe [Text]
- activeServicesCount :: Maybe Int
- tags :: Maybe [Tag]
}
newCluster :: Cluster
cluster_status :: Lens' Cluster (Maybe Text)
cluster_clusterArn :: Lens' Cluster (Maybe Text)
cluster_attachments :: Lens' Cluster (Maybe [Attachment])
cluster_runningTasksCount :: Lens' Cluster (Maybe Int)
cluster_defaultCapacityProviderStrategy :: Lens' Cluster (Maybe [CapacityProviderStrategyItem])
cluster_settings :: Lens' Cluster (Maybe [ClusterSetting])
cluster_registeredContainerInstancesCount :: Lens' Cluster (Maybe Int)
cluster_pendingTasksCount :: Lens' Cluster (Maybe Int)
cluster_clusterName :: Lens' Cluster (Maybe Text)
cluster_statistics :: Lens' Cluster (Maybe [KeyValuePair])
cluster_configuration :: Lens' Cluster (Maybe ClusterConfiguration)
cluster_attachmentsStatus :: Lens' Cluster (Maybe Text)
cluster_capacityProviders :: Lens' Cluster (Maybe [Text])
cluster_activeServicesCount :: Lens' Cluster (Maybe Int)
cluster_tags :: Lens' Cluster (Maybe [Tag])

Documentation

data Cluster Source #

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.

See: newCluster smart constructor.

Constructors

Cluster'

Fields

status :: Maybe Text
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.
clusterArn :: Maybe Text
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 Amazon Web Services account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.
attachments :: Maybe [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.
runningTasksCount :: Maybe Int
The number of tasks in the cluster that are in the RUNNING state.
defaultCapacityProviderStrategy :: Maybe [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.
settings :: Maybe [ClusterSetting]
The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.
registeredContainerInstancesCount :: Maybe Int
The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.
pendingTasksCount :: Maybe Int
The number of tasks in the cluster that are in the PENDING state.
clusterName :: Maybe Text
A user-generated string that you use to identify your cluster.
statistics :: Maybe [KeyValuePair]
Additional information about your clusters that are separated by launch type, including:
- runningEC2TasksCount
- RunningFargateTasksCount
- pendingEC2TasksCount
- pendingFargateTasksCount
- activeEC2ServiceCount
- activeFargateServiceCount
- drainingEC2ServiceCount
- drainingFargateServiceCount
configuration :: Maybe ClusterConfiguration
The execute command configuration for the cluster.
attachmentsStatus :: Maybe Text
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.
capacityProviders :: Maybe [Text]
The capacity providers associated with the cluster.
activeServicesCount :: Maybe Int
The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.
tags :: Maybe [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 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.

Instances

Instances details

Eq Cluster Source #
Instance details Defined in Amazonka.ECS.Types.Cluster Methods (==) :: Cluster -> Cluster -> Bool # (/=) :: Cluster -> Cluster -> Bool #
Read Cluster Source #
Instance details Defined in Amazonka.ECS.Types.Cluster Methods readsPrec :: Int -> ReadS Cluster # readList :: ReadS [Cluster] # readPrec :: ReadPrec Cluster # readListPrec :: ReadPrec [Cluster] #
Show Cluster Source #
Instance details Defined in Amazonka.ECS.Types.Cluster Methods showsPrec :: Int -> Cluster -> ShowS # show :: Cluster -> String # showList :: [Cluster] -> ShowS #
Generic Cluster Source #
Instance details Defined in Amazonka.ECS.Types.Cluster Associated Types type Rep Cluster :: Type -> Type # Methods from :: Cluster -> Rep Cluster x # to :: Rep Cluster x -> Cluster #
NFData Cluster Source #
Instance details Defined in Amazonka.ECS.Types.Cluster Methods rnf :: Cluster -> () #
Hashable Cluster Source #
Instance details Defined in Amazonka.ECS.Types.Cluster Methods hashWithSalt :: Int -> Cluster -> Int # hash :: Cluster -> Int #
FromJSON Cluster Source #
Instance details Defined in Amazonka.ECS.Types.Cluster Methods parseJSON :: Value -> Parser Cluster # parseJSONList :: Value -> Parser [Cluster] #
type Rep Cluster Source #
Instance details Defined in Amazonka.ECS.Types.Cluster type Rep Cluster = D1 ('MetaData "Cluster" "Amazonka.ECS.Types.Cluster" "libZSservicesZSamazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "Cluster'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "clusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "attachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Attachment])))) :: ((S1 ('MetaSel ('Just "runningTasksCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "defaultCapacityProviderStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CapacityProviderStrategyItem]))) :: (S1 ('MetaSel ('Just "settings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ClusterSetting])) :: S1 ('MetaSel ('Just "registeredContainerInstancesCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :: (((S1 ('MetaSel ('Just "pendingTasksCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "clusterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "statistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [KeyValuePair])) :: S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClusterConfiguration)))) :: ((S1 ('MetaSel ('Just "attachmentsStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "capacityProviders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "activeServicesCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))))))

newCluster :: Cluster Source #

Create a value of Cluster with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:Cluster', cluster_status - 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.

$sel:clusterArn:Cluster', cluster_clusterArn - 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 Amazon Web Services account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.

$sel:attachments:Cluster', cluster_attachments - 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.

$sel:runningTasksCount:Cluster', cluster_runningTasksCount - The number of tasks in the cluster that are in the RUNNING state.

$sel:defaultCapacityProviderStrategy:Cluster', cluster_defaultCapacityProviderStrategy - 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.

$sel:settings:Cluster', cluster_settings - The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.

$sel:registeredContainerInstancesCount:Cluster', cluster_registeredContainerInstancesCount - The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.

$sel:pendingTasksCount:Cluster', cluster_pendingTasksCount - The number of tasks in the cluster that are in the PENDING state.

$sel:clusterName:Cluster', cluster_clusterName - A user-generated string that you use to identify your cluster.

$sel:statistics:Cluster', cluster_statistics - Additional information about your clusters that are separated by launch type, including:

runningEC2TasksCount
RunningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount

$sel:configuration:Cluster', cluster_configuration - The execute command configuration for the cluster.

$sel:attachmentsStatus:Cluster', cluster_attachmentsStatus - 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.

$sel:capacityProviders:Cluster', cluster_capacityProviders - The capacity providers associated with the cluster.

$sel:activeServicesCount:Cluster', cluster_activeServicesCount - The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.

$sel:tags:Cluster', cluster_tags - 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 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.

cluster_status :: Lens' Cluster (Maybe Text) Source #

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.

cluster_clusterArn :: Lens' Cluster (Maybe Text) Source #

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 Amazon Web Services account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.

cluster_attachments :: Lens' Cluster (Maybe [Attachment]) Source #

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.

cluster_runningTasksCount :: Lens' Cluster (Maybe Int) Source #

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

cluster_defaultCapacityProviderStrategy :: Lens' Cluster (Maybe [CapacityProviderStrategyItem]) Source #

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.

cluster_settings :: Lens' Cluster (Maybe [ClusterSetting]) Source #

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

cluster_registeredContainerInstancesCount :: Lens' Cluster (Maybe Int) Source #

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

cluster_pendingTasksCount :: Lens' Cluster (Maybe Int) Source #

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

cluster_clusterName :: Lens' Cluster (Maybe Text) Source #

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

cluster_statistics :: Lens' Cluster (Maybe [KeyValuePair]) Source #

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

runningEC2TasksCount
RunningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount

cluster_configuration :: Lens' Cluster (Maybe ClusterConfiguration) Source #

The execute command configuration for the cluster.

cluster_attachmentsStatus :: Lens' Cluster (Maybe Text) Source #

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.

cluster_capacityProviders :: Lens' Cluster (Maybe [Text]) Source #

The capacity providers associated with the cluster.

cluster_activeServicesCount :: Lens' Cluster (Maybe Int) Source #

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

cluster_tags :: Lens' Cluster (Maybe [Tag]) Source #

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