Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data Cluster = Cluster' {
- activeServicesCount :: Maybe Int
- attachments :: Maybe [Attachment]
- attachmentsStatus :: Maybe Text
- capacityProviders :: Maybe [Text]
- clusterArn :: Maybe Text
- clusterName :: Maybe Text
- configuration :: Maybe ClusterConfiguration
- defaultCapacityProviderStrategy :: Maybe [CapacityProviderStrategyItem]
- pendingTasksCount :: Maybe Int
- registeredContainerInstancesCount :: Maybe Int
- runningTasksCount :: Maybe Int
- serviceConnectDefaults :: Maybe ClusterServiceConnectDefaults
- settings :: Maybe [ClusterSetting]
- statistics :: Maybe [KeyValuePair]
- status :: Maybe Text
- tags :: Maybe [Tag]
- newCluster :: Cluster
- cluster_activeServicesCount :: Lens' Cluster (Maybe Int)
- cluster_attachments :: Lens' Cluster (Maybe [Attachment])
- cluster_attachmentsStatus :: Lens' Cluster (Maybe Text)
- cluster_capacityProviders :: Lens' Cluster (Maybe [Text])
- cluster_clusterArn :: Lens' Cluster (Maybe Text)
- cluster_clusterName :: Lens' Cluster (Maybe Text)
- cluster_configuration :: Lens' Cluster (Maybe ClusterConfiguration)
- cluster_defaultCapacityProviderStrategy :: Lens' Cluster (Maybe [CapacityProviderStrategyItem])
- cluster_pendingTasksCount :: Lens' Cluster (Maybe Int)
- cluster_registeredContainerInstancesCount :: Lens' Cluster (Maybe Int)
- cluster_runningTasksCount :: Lens' Cluster (Maybe Int)
- cluster_serviceConnectDefaults :: Lens' Cluster (Maybe ClusterServiceConnectDefaults)
- cluster_settings :: Lens' Cluster (Maybe [ClusterSetting])
- cluster_statistics :: Lens' Cluster (Maybe [KeyValuePair])
- cluster_status :: Lens' Cluster (Maybe Text)
- cluster_tags :: Lens' Cluster (Maybe [Tag])
Documentation
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: newCluster
smart constructor.
Cluster' | |
|
Instances
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: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:attachments:Cluster'
, cluster_attachments
- 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.
$sel:attachmentsStatus:Cluster'
, cluster_attachmentsStatus
- 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.
$sel:capacityProviders:Cluster'
, cluster_capacityProviders
- The capacity providers associated with the cluster.
$sel:clusterArn:Cluster'
, cluster_clusterArn
- 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.
$sel:clusterName:Cluster'
, cluster_clusterName
- A user-generated string that you use to identify your cluster.
$sel:configuration:Cluster'
, cluster_configuration
- The execute command configuration for the cluster.
$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:pendingTasksCount:Cluster'
, cluster_pendingTasksCount
- The number of tasks in the cluster that are in the PENDING
state.
$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:runningTasksCount:Cluster'
, cluster_runningTasksCount
- The number of tasks in the cluster that are in the RUNNING
state.
$sel:serviceConnectDefaults:Cluster'
, cluster_serviceConnectDefaults
- 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.
$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:statistics:Cluster'
, cluster_statistics
- Additional information about your clusters that are separated by launch
type. They include the following:
- runningEC2TasksCount
- RunningFargateTasksCount
- pendingEC2TasksCount
- pendingFargateTasksCount
- activeEC2ServiceCount
- activeFargateServiceCount
- drainingEC2ServiceCount
- drainingFargateServiceCount
Cluster
, cluster_status
- 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 onINACTIVE
clusters persisting.
$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. 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.
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_attachments :: Lens' Cluster (Maybe [Attachment]) Source #
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.
cluster_attachmentsStatus :: Lens' Cluster (Maybe Text) Source #
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.
cluster_capacityProviders :: Lens' Cluster (Maybe [Text]) Source #
The capacity providers associated with the cluster.
cluster_clusterArn :: Lens' Cluster (Maybe Text) Source #
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.
cluster_clusterName :: Lens' Cluster (Maybe Text) Source #
A user-generated string that you use to identify your cluster.
cluster_configuration :: Lens' Cluster (Maybe ClusterConfiguration) Source #
The execute command configuration for the cluster.
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_pendingTasksCount :: Lens' Cluster (Maybe Int) Source #
The number of tasks in the cluster that are in the PENDING
state.
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_runningTasksCount :: Lens' Cluster (Maybe Int) Source #
The number of tasks in the cluster that are in the RUNNING
state.
cluster_serviceConnectDefaults :: Lens' Cluster (Maybe ClusterServiceConnectDefaults) Source #
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.
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_statistics :: Lens' Cluster (Maybe [KeyValuePair]) Source #
Additional information about your clusters that are separated by launch type. They include the following:
- runningEC2TasksCount
- RunningFargateTasksCount
- pendingEC2TasksCount
- pendingFargateTasksCount
- activeEC2ServiceCount
- activeFargateServiceCount
- drainingEC2ServiceCount
- drainingFargateServiceCount
cluster_status :: Lens' Cluster (Maybe Text) Source #
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 onINACTIVE
clusters persisting.
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. 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.