Amazonka.ECS.Lens

Operations

CreateCapacityProvider

createCapacityProvider_tags :: Lens' CreateCapacityProvider (Maybe [Tag])

The metadata that you apply to the capacity provider to categorize and organize them more conveniently. Each tag consists of a key and an optional value. You define both of 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.

createCapacityProvider_name :: Lens' CreateCapacityProvider Text

The name of the capacity provider. Up to 255 characters are allowed. They include letters (both upper and lowercase letters), numbers, underscores (_), and hyphens (-). The name can't be prefixed with "aws", "ecs", or "fargate".

createCapacityProvider_autoScalingGroupProvider :: Lens' CreateCapacityProvider AutoScalingGroupProvider

The details of the Auto Scaling group for the capacity provider.

createCapacityProviderResponse_capacityProvider :: Lens' CreateCapacityProviderResponse (Maybe CapacityProvider)

The full description of the new capacity provider.

createCapacityProviderResponse_httpStatus :: Lens' CreateCapacityProviderResponse Int

The response's http status code.

CreateCluster

createCluster_capacityProviders :: Lens' CreateCluster (Maybe [Text])

The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the CreateService or RunTask actions.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster. 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.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

createCluster_clusterName :: Lens' CreateCluster (Maybe Text)

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.

createCluster_configuration :: Lens' CreateCluster (Maybe ClusterConfiguration)

The execute command configuration for the cluster.

createCluster_defaultCapacityProviderStrategy :: Lens' CreateCluster (Maybe [CapacityProviderStrategyItem])

The capacity provider strategy to set as the default for the cluster. After a default capacity provider strategy is set for a cluster, when you call the RunTask or CreateService APIs with no capacity provider strategy or launch type specified, the default capacity provider strategy for the cluster is used.

If a default capacity provider strategy isn't defined for a cluster when it was created, it can be defined later with the PutClusterCapacityProviders API operation.

createCluster_serviceConnectDefaults :: Lens' CreateCluster (Maybe ClusterServiceConnectDefaultsRequest)

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.

createCluster_settings :: Lens' CreateCluster (Maybe [ClusterSetting])

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.

createCluster_tags :: Lens' CreateCluster (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. 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.

createClusterResponse_cluster :: Lens' CreateClusterResponse (Maybe Cluster)

The full description of your new cluster.

createClusterResponse_httpStatus :: Lens' CreateClusterResponse Int

The response's http status code.

CreateService

createService_capacityProviderStrategy :: Lens' CreateService (Maybe [CapacityProviderStrategyItem])

The capacity provider strategy to use for the service.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

A capacity provider strategy may contain a maximum of 6 capacity providers.

createService_clientToken :: Lens' CreateService (Maybe Text)

An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 32 ASCII characters are allowed.

createService_cluster :: Lens' CreateService (Maybe Text)

The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.

createService_deploymentConfiguration :: Lens' CreateService (Maybe DeploymentConfiguration)

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

createService_deploymentController :: Lens' CreateService (Maybe DeploymentController)

The deployment controller to use for the service. If no deployment controller is specified, the default value of ECS is used.

createService_desiredCount :: Lens' CreateService (Maybe Int)

The number of instantiations of the specified task definition to place and keep running on your cluster.

This is required if schedulingStrategy is REPLICA or isn't specified. If schedulingStrategy is DAEMON then this isn't required.

createService_enableECSManagedTags :: Lens' CreateService (Maybe Bool)

Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see Tagging your Amazon ECS resources in the Amazon Elastic Container Service Developer Guide.

createService_enableExecuteCommand :: Lens' CreateService (Maybe Bool)

Determines whether the execute command functionality is enabled for the service. If true, this enables execute command functionality on all containers in the service tasks.

createService_healthCheckGracePeriodSeconds :: Lens' CreateService (Maybe Int)

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of 0 is used.

If you do not use an Elastic Load Balancing, we recommend that you use the startPeriod in the task definition health check parameters. For more information, see Health check.

If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

createService_launchType :: Lens' CreateService (Maybe LaunchType)

The infrastructure that you run your service on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

The FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.

Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate.

The EC2 launch type runs your tasks on Amazon EC2 instances registered to your cluster.

The EXTERNAL launch type runs your tasks on your on-premises server or virtual machine (VM) capacity registered to your cluster.

A service can use either a launch type or a capacity provider strategy. If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

createService_loadBalancers :: Lens' CreateService (Maybe [LoadBalancer])

A load balancer object representing the load balancers to use with your service. For more information, see Service load balancing in the Amazon Elastic Container Service Developer Guide.

If the service uses the rolling update (ECS) deployment controller and using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach to the service. The service-linked role is required for services that use multiple target groups. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

If the service uses the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, CodeDeploy determines which task set in your service has the status PRIMARY, and it associates one target group with it. Then, it also associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that you can use to perform validation tests with Lambda functions before routing production traffic to it.

If you use the CODE_DEPLOY deployment controller, these values can be changed when updating the service.

For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name, and the container port to access from the load balancer. The container name must be as it appears in a container definition. The load balancer name parameter must be omitted. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group that's specified here.

For Classic Load Balancers, this object must contain the load balancer name, the container name , and the container port to access from the load balancer. The container name must be as it appears in a container definition. The target group ARN parameter must be omitted. When a task from this service is placed on a container instance, the container instance is registered with the load balancer that's specified here.

Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers aren't supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance. This is because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

createService_networkConfiguration :: Lens' CreateService (Maybe NetworkConfiguration)

The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it isn't supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.

createService_placementConstraints :: Lens' CreateService (Maybe [PlacementConstraint])

An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.

createService_placementStrategy :: Lens' CreateService (Maybe [PlacementStrategy])

The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.

createService_platformVersion :: Lens' CreateService (Maybe Text)

The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

createService_propagateTags :: Lens' CreateService (Maybe PropagateTags)

Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

createService_role :: Lens' CreateService (Maybe Text)

The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.

If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide.

createService_schedulingStrategy :: Lens' CreateService (Maybe SchedulingStrategy)

The scheduling strategy to use for the service. For more information, see Services.

There are two service scheduler strategies available:

• REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the CODE_DEPLOY or EXTERNAL deployment controller types.

• DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.

  Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy.

createService_serviceConnectConfiguration :: Lens' CreateService (Maybe ServiceConnectConfiguration)

The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

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.

createService_serviceRegistries :: Lens' CreateService (Maybe [ServiceRegistry])

The details of the service discovery registry to associate with this service. For more information, see Service discovery.

Each service may be associated with one service registry. Multiple service registries for each service isn't supported.

createService_tags :: Lens' CreateService (Maybe [Tag])

The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.

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.

createService_taskDefinition :: Lens' CreateService (Maybe Text)

The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision isn't specified, the latest ACTIVE revision is used.

A task definition must be specified if the service uses either the ECS or CODE_DEPLOY deployment controllers.

createService_serviceName :: Lens' CreateService Text

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

createServiceResponse_service :: Lens' CreateServiceResponse (Maybe ContainerService)

The full description of your service following the create call.

A service will return either a capacityProviderStrategy or launchType parameter, but not both, depending where one was specified when it was created.

If a service is using the ECS deployment controller, the deploymentController and taskSets parameters will not be returned.

if the service uses the CODE_DEPLOY deployment controller, the deploymentController, taskSets and deployments parameters will be returned, however the deployments parameter will be an empty list.

createServiceResponse_httpStatus :: Lens' CreateServiceResponse Int

The response's http status code.

CreateTaskSet

createTaskSet_capacityProviderStrategy :: Lens' CreateTaskSet (Maybe [CapacityProviderStrategyItem])

The capacity provider strategy to use for the task set.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

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

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

createTaskSet_clientToken :: Lens' CreateTaskSet (Maybe Text)

The identifier that you provide to ensure the idempotency of the request. It's case sensitive and must be unique. It can be up to 32 ASCII characters are allowed.

createTaskSet_externalId :: Lens' CreateTaskSet (Maybe Text)

An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute set to the provided value.

createTaskSet_launchType :: Lens' CreateTaskSet (Maybe LaunchType)

The launch type that new tasks in the task set uses. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

createTaskSet_loadBalancers :: Lens' CreateTaskSet (Maybe [LoadBalancer])

A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.

createTaskSet_networkConfiguration :: Lens' CreateTaskSet (Maybe NetworkConfiguration)

An object representing the network configuration for a task set.

createTaskSet_platformVersion :: Lens' CreateTaskSet (Maybe Text)

The platform version that the tasks in the task set uses. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used.

createTaskSet_scale :: Lens' CreateTaskSet (Maybe Scale)

A floating-point percentage of the desired number of tasks to place and keep running in the task set.

createTaskSet_serviceRegistries :: Lens' CreateTaskSet (Maybe [ServiceRegistry])

The details of the service discovery registries to assign to this task set. For more information, see Service discovery.

createTaskSet_tags :: Lens' CreateTaskSet (Maybe [Tag])

The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both. When a service is deleted, the tags are deleted.

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.

createTaskSet_service :: Lens' CreateTaskSet Text

The short name or full Amazon Resource Name (ARN) of the service to create the task set in.

createTaskSet_cluster :: Lens' CreateTaskSet Text

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.

createTaskSet_taskDefinition :: Lens' CreateTaskSet Text

The task definition for the tasks in the task set to use.

createTaskSetResponse_taskSet :: Lens' CreateTaskSetResponse (Maybe TaskSet)

Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL deployment. A task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.

createTaskSetResponse_httpStatus :: Lens' CreateTaskSetResponse Int

The response's http status code.

DeleteAccountSetting

deleteAccountSetting_principalArn :: Lens' DeleteAccountSetting (Maybe Text)

The Amazon Resource Name (ARN) of the principal. It can be an IAM user, IAM role, or the root user. If you specify the root user, it disables the account setting for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.

deleteAccountSetting_name :: Lens' DeleteAccountSetting SettingName

The resource name to disable the account setting for. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected. If awsvpcTrunking is specified, the ENI limit for your Amazon ECS container instances is affected.

deleteAccountSettingResponse_setting :: Lens' DeleteAccountSettingResponse (Maybe Setting)

The account setting for the specified principal ARN.

deleteAccountSettingResponse_httpStatus :: Lens' DeleteAccountSettingResponse Int

The response's http status code.

DeleteAttributes

deleteAttributes_cluster :: Lens' DeleteAttributes (Maybe Text)

The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete attributes. If you do not specify a cluster, the default cluster is assumed.

deleteAttributes_attributes :: Lens' DeleteAttributes [Attribute]

The attributes to delete from your resource. You can specify up to 10 attributes for each request. For custom attributes, specify the attribute name and target ID, but don't specify the value. If you specify the target ID using the short form, you must also specify the target type.

deleteAttributesResponse_attributes :: Lens' DeleteAttributesResponse (Maybe [Attribute])

A list of attribute objects that were successfully deleted from your resource.

deleteAttributesResponse_httpStatus :: Lens' DeleteAttributesResponse Int

The response's http status code.

DeleteCapacityProvider

deleteCapacityProvider_capacityProvider :: Lens' DeleteCapacityProvider Text

The short name or full Amazon Resource Name (ARN) of the capacity provider to delete.

deleteCapacityProviderResponse_capacityProvider :: Lens' DeleteCapacityProviderResponse (Maybe CapacityProvider)

The details of the capacity provider.

deleteCapacityProviderResponse_httpStatus :: Lens' DeleteCapacityProviderResponse Int

The response's http status code.

DeleteCluster

deleteCluster_cluster :: Lens' DeleteCluster Text

The short name or full Amazon Resource Name (ARN) of the cluster to delete.

deleteClusterResponse_cluster :: Lens' DeleteClusterResponse (Maybe Cluster)

The full description of the deleted cluster.

deleteClusterResponse_httpStatus :: Lens' DeleteClusterResponse Int

The response's http status code.

DeleteService

deleteService_cluster :: Lens' DeleteService (Maybe Text)

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed.

deleteService_force :: Lens' DeleteService (Maybe Bool)

If true, allows you to delete a service even if it wasn't scaled down to zero tasks. It's only necessary to use this if the service uses the REPLICA scheduling strategy.

deleteService_service :: Lens' DeleteService Text

The name of the service to delete.

deleteServiceResponse_service :: Lens' DeleteServiceResponse (Maybe ContainerService)

The full description of the deleted service.

deleteServiceResponse_httpStatus :: Lens' DeleteServiceResponse Int

The response's http status code.

DeleteTaskSet

deleteTaskSet_force :: Lens' DeleteTaskSet (Maybe Bool)

If true, you can delete a task set even if it hasn't been scaled down to zero.

deleteTaskSet_cluster :: Lens' DeleteTaskSet Text

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set found in to delete.

deleteTaskSet_service :: Lens' DeleteTaskSet Text

The short name or full Amazon Resource Name (ARN) of the service that hosts the task set to delete.

deleteTaskSet_taskSet :: Lens' DeleteTaskSet Text

The task set ID or full Amazon Resource Name (ARN) of the task set to delete.

deleteTaskSetResponse_taskSet :: Lens' DeleteTaskSetResponse (Maybe TaskSet)

Details about the task set.

deleteTaskSetResponse_httpStatus :: Lens' DeleteTaskSetResponse Int

The response's http status code.

DeregisterContainerInstance

deregisterContainerInstance_cluster :: Lens' DeregisterContainerInstance (Maybe Text)

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.

deregisterContainerInstance_force :: Lens' DeregisterContainerInstance (Maybe Bool)

Forces the container instance to be deregistered. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they're orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible.

Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group.

deregisterContainerInstance_containerInstance :: Lens' DeregisterContainerInstance Text

The container instance ID or full ARN of the container instance to deregister. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

deregisterContainerInstanceResponse_containerInstance :: Lens' DeregisterContainerInstanceResponse (Maybe ContainerInstance)

The container instance that was deregistered.

deregisterContainerInstanceResponse_httpStatus :: Lens' DeregisterContainerInstanceResponse Int

The response's http status code.

DeregisterTaskDefinition

deregisterTaskDefinition_taskDefinition :: Lens' DeregisterTaskDefinition Text

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to deregister. You must specify a revision.

deregisterTaskDefinitionResponse_taskDefinition :: Lens' DeregisterTaskDefinitionResponse (Maybe TaskDefinition)

The full description of the deregistered task.

deregisterTaskDefinitionResponse_httpStatus :: Lens' DeregisterTaskDefinitionResponse Int

The response's http status code.

DescribeCapacityProviders

describeCapacityProviders_capacityProviders :: Lens' DescribeCapacityProviders (Maybe [Text])

The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100 capacity providers can be described in an action.

describeCapacityProviders_include :: Lens' DescribeCapacityProviders (Maybe [CapacityProviderField])

Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.

describeCapacityProviders_maxResults :: Lens' DescribeCapacityProviders (Maybe Int)

The maximum number of account setting results returned by DescribeCapacityProviders in paginated output. When this parameter is used, DescribeCapacityProviders only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeCapacityProviders request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then DescribeCapacityProviders returns up to 10 results and a nextToken value if applicable.

describeCapacityProviders_nextToken :: Lens' DescribeCapacityProviders (Maybe Text)

The nextToken value returned from a previous paginated DescribeCapacityProviders request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

describeCapacityProvidersResponse_capacityProviders :: Lens' DescribeCapacityProvidersResponse (Maybe [CapacityProvider])

The list of capacity providers.

describeCapacityProvidersResponse_failures :: Lens' DescribeCapacityProvidersResponse (Maybe [Failure])

Any failures associated with the call.

describeCapacityProvidersResponse_nextToken :: Lens' DescribeCapacityProvidersResponse (Maybe Text)

The nextToken value to include in a future DescribeCapacityProviders request. When the results of a DescribeCapacityProviders request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

describeCapacityProvidersResponse_httpStatus :: Lens' DescribeCapacityProvidersResponse Int

The response's http status code.

DescribeClusters

describeClusters_clusters :: Lens' DescribeClusters (Maybe [Text])

A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

describeClusters_include :: Lens' DescribeClusters (Maybe [ClusterField])

Determines whether to include additional information about the clusters in the response. If this field is omitted, this information isn't included.

If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included, for example the capacity providers.

If SETTINGS is specified, the settings for the cluster are included.

If CONFIGURATIONS is specified, the configuration for the cluster is included.

If STATISTICS is specified, the task and service count is included, separated by launch type.

If TAGS is specified, the metadata tags associated with the cluster are included.

describeClustersResponse_clusters :: Lens' DescribeClustersResponse (Maybe [Cluster])

The list of clusters.

describeClustersResponse_failures :: Lens' DescribeClustersResponse (Maybe [Failure])

Any failures associated with the call.

describeClustersResponse_httpStatus :: Lens' DescribeClustersResponse Int

The response's http status code.

DescribeContainerInstances

describeContainerInstances_cluster :: Lens' DescribeContainerInstances (Maybe Text)

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance or container instances you are describing were launched in any cluster other than the default cluster.

describeContainerInstances_include :: Lens' DescribeContainerInstances (Maybe [ContainerInstanceField])

Specifies whether you want to see the resource tags for the container instance. If TAGS is specified, the tags are included in the response. If CONTAINER_INSTANCE_HEALTH is specified, the container instance health is included in the response. If this field is omitted, tags and container instance health status aren't included in the response.

describeContainerInstances_containerInstances :: Lens' DescribeContainerInstances [Text]

A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.

describeContainerInstancesResponse_containerInstances :: Lens' DescribeContainerInstancesResponse (Maybe [ContainerInstance])

The list of container instances.

describeContainerInstancesResponse_failures :: Lens' DescribeContainerInstancesResponse (Maybe [Failure])

Any failures associated with the call.

describeContainerInstancesResponse_httpStatus :: Lens' DescribeContainerInstancesResponse Int

The response's http status code.

DescribeServices

describeServices_cluster :: Lens' DescribeServices (Maybe Text)

The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the service or services you are describing were launched in any cluster other than the default cluster.

describeServices_include :: Lens' DescribeServices (Maybe [ServiceField])

Determines whether you want to see the resource tags for the service. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.

describeServices_services :: Lens' DescribeServices [Text]

A list of services to describe. You may specify up to 10 services to describe in a single operation.

describeServicesResponse_failures :: Lens' DescribeServicesResponse (Maybe [Failure])

Any failures associated with the call.

describeServicesResponse_services :: Lens' DescribeServicesResponse (Maybe [ContainerService])

The list of services described.

describeServicesResponse_httpStatus :: Lens' DescribeServicesResponse Int

The response's http status code.

DescribeTaskDefinition

describeTaskDefinition_include :: Lens' DescribeTaskDefinition (Maybe [TaskDefinitionField])

Determines whether to see the resource tags for the task definition. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.

describeTaskDefinition_taskDefinition :: Lens' DescribeTaskDefinition Text

The family for the latest ACTIVE revision, family and revision (family:revision) for a specific revision in the family, or full Amazon Resource Name (ARN) of the task definition to describe.

describeTaskDefinitionResponse_tags :: Lens' DescribeTaskDefinitionResponse (Maybe [Tag])

The metadata that's applied to the task definition 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.

describeTaskDefinitionResponse_taskDefinition :: Lens' DescribeTaskDefinitionResponse (Maybe TaskDefinition)

The full task definition description.

describeTaskDefinitionResponse_httpStatus :: Lens' DescribeTaskDefinitionResponse Int

The response's http status code.

DescribeTaskSets

describeTaskSets_include :: Lens' DescribeTaskSets (Maybe [TaskSetField])

Specifies whether to see the resource tags for the task set. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.

describeTaskSets_taskSets :: Lens' DescribeTaskSets (Maybe [Text])

The ID or full Amazon Resource Name (ARN) of task sets to describe.

describeTaskSets_cluster :: Lens' DescribeTaskSets Text

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.

describeTaskSets_service :: Lens' DescribeTaskSets Text

The short name or full Amazon Resource Name (ARN) of the service that the task sets exist in.

describeTaskSetsResponse_failures :: Lens' DescribeTaskSetsResponse (Maybe [Failure])

Any failures associated with the call.

describeTaskSetsResponse_taskSets :: Lens' DescribeTaskSetsResponse (Maybe [TaskSet])

The list of task sets described.

describeTaskSetsResponse_httpStatus :: Lens' DescribeTaskSetsResponse Int

The response's http status code.

DescribeTasks

describeTasks_cluster :: Lens' DescribeTasks (Maybe Text)

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are describing were launched in any cluster other than the default cluster.

describeTasks_include :: Lens' DescribeTasks (Maybe [TaskField])

Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.

describeTasks_tasks :: Lens' DescribeTasks [Text]

A list of up to 100 task IDs or full ARN entries.

describeTasksResponse_failures :: Lens' DescribeTasksResponse (Maybe [Failure])

Any failures associated with the call.

describeTasksResponse_tasks :: Lens' DescribeTasksResponse (Maybe [Task])

The list of tasks.

describeTasksResponse_httpStatus :: Lens' DescribeTasksResponse Int

The response's http status code.

DiscoverPollEndpoint

discoverPollEndpoint_cluster :: Lens' DiscoverPollEndpoint (Maybe Text)

The short name or full Amazon Resource Name (ARN) of the cluster that the container instance belongs to.

discoverPollEndpoint_containerInstance :: Lens' DiscoverPollEndpoint (Maybe Text)

The container instance ID or full ARN of the container instance. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

discoverPollEndpointResponse_endpoint :: Lens' DiscoverPollEndpointResponse (Maybe Text)

The endpoint for the Amazon ECS agent to poll.

discoverPollEndpointResponse_serviceConnectEndpoint :: Lens' DiscoverPollEndpointResponse (Maybe Text)

The endpoint for the Amazon ECS agent to poll for Service Connect configuration. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

discoverPollEndpointResponse_telemetryEndpoint :: Lens' DiscoverPollEndpointResponse (Maybe Text)

The telemetry endpoint for the Amazon ECS agent.

discoverPollEndpointResponse_httpStatus :: Lens' DiscoverPollEndpointResponse Int

The response's http status code.

ExecuteCommand

executeCommand_cluster :: Lens' ExecuteCommand (Maybe Text)

The Amazon Resource Name (ARN) or short name of the cluster the task is running in. If you do not specify a cluster, the default cluster is assumed.

executeCommand_container :: Lens' ExecuteCommand (Maybe Text)

The name of the container to execute the command on. A container name only needs to be specified for tasks containing multiple containers.

executeCommand_command :: Lens' ExecuteCommand Text

The command to run on the container.

executeCommand_interactive :: Lens' ExecuteCommand Bool

Use this flag to run your command in interactive mode.

executeCommand_task :: Lens' ExecuteCommand Text

The Amazon Resource Name (ARN) or ID of the task the container is part of.

executeCommandResponse_clusterArn :: Lens' ExecuteCommandResponse (Maybe Text)

The Amazon Resource Name (ARN) of the cluster.

executeCommandResponse_containerArn :: Lens' ExecuteCommandResponse (Maybe Text)

The Amazon Resource Name (ARN) of the container.

executeCommandResponse_containerName :: Lens' ExecuteCommandResponse (Maybe Text)

The name of the container.

executeCommandResponse_interactive :: Lens' ExecuteCommandResponse (Maybe Bool)

Determines whether the execute command session is running in interactive mode. Amazon ECS only supports initiating interactive sessions, so you must specify true for this value.

executeCommandResponse_session :: Lens' ExecuteCommandResponse (Maybe Session)

The details of the SSM session that was created for this instance of execute-command.

executeCommandResponse_taskArn :: Lens' ExecuteCommandResponse (Maybe Text)

The Amazon Resource Name (ARN) of the task.

executeCommandResponse_httpStatus :: Lens' ExecuteCommandResponse Int

The response's http status code.

GetTaskProtection

getTaskProtection_tasks :: Lens' GetTaskProtection (Maybe [Text])

A list of up to 100 task IDs or full ARN entries.

getTaskProtection_cluster :: Lens' GetTaskProtection Text

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.

getTaskProtectionResponse_failures :: Lens' GetTaskProtectionResponse (Maybe [Failure])

Any failures associated with the call.

getTaskProtectionResponse_protectedTasks :: Lens' GetTaskProtectionResponse (Maybe [ProtectedTask])

A list of tasks with the following information.

• taskArn: The task ARN.
• protectionEnabled: The protection status of the task. If scale-in protection is enabled for a task, the value is true. Otherwise, it is false.
• expirationDate: The epoch time when protection for the task will expire.

getTaskProtectionResponse_httpStatus :: Lens' GetTaskProtectionResponse Int

The response's http status code.

ListAccountSettings

listAccountSettings_effectiveSettings :: Lens' ListAccountSettings (Maybe Bool)

Determines whether to return the effective settings. If true, the account settings for the root user or the default setting for the principalArn are returned. If false, the account settings for the principalArn are returned if they're set. Otherwise, no account settings are returned.

listAccountSettings_maxResults :: Lens' ListAccountSettings (Maybe Int)

The maximum number of account setting results returned by ListAccountSettings in paginated output. When this parameter is used, ListAccountSettings only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAccountSettings request with the returned nextToken value. This value can be between 1 and 10. If this parameter isn't used, then ListAccountSettings returns up to 10 results and a nextToken value if applicable.

listAccountSettings_name :: Lens' ListAccountSettings (Maybe SettingName)

The name of the account setting you want to list the settings for.

listAccountSettings_nextToken :: Lens' ListAccountSettings (Maybe Text)

The nextToken value returned from a ListAccountSettings request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

listAccountSettings_principalArn :: Lens' ListAccountSettings (Maybe Text)

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.

Federated users assume the account setting of the root user and can't have explicit account settings set for them.

listAccountSettings_value :: Lens' ListAccountSettings (Maybe Text)

The value of the account settings to filter results with. You must also specify an account setting name to use this parameter.

listAccountSettingsResponse_nextToken :: Lens' ListAccountSettingsResponse (Maybe Text)

The nextToken value to include in a future ListAccountSettings request. When the results of a ListAccountSettings request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

listAccountSettingsResponse_settings :: Lens' ListAccountSettingsResponse (Maybe [Setting])

The account settings for the resource.

listAccountSettingsResponse_httpStatus :: Lens' ListAccountSettingsResponse Int

The response's http status code.

ListAttributes

listAttributes_attributeName :: Lens' ListAttributes (Maybe Text)

The name of the attribute to filter the results with.

listAttributes_attributeValue :: Lens' ListAttributes (Maybe Text)

The value of the attribute to filter results with. You must also specify an attribute name to use this parameter.

listAttributes_cluster :: Lens' ListAttributes (Maybe Text)

The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.

listAttributes_maxResults :: Lens' ListAttributes (Maybe Int)

The maximum number of cluster results that ListAttributes returned in paginated output. When this parameter is used, ListAttributes only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAttributes request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListAttributes returns up to 100 results and a nextToken value if applicable.

listAttributes_nextToken :: Lens' ListAttributes (Maybe Text)

The nextToken value returned from a ListAttributes request indicating that more results are available to fulfill the request and further calls are needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

listAttributes_targetType :: Lens' ListAttributes TargetType

The type of the target to list attributes with.

listAttributesResponse_attributes :: Lens' ListAttributesResponse (Maybe [Attribute])

A list of attribute objects that meet the criteria of the request.

listAttributesResponse_nextToken :: Lens' ListAttributesResponse (Maybe Text)

The nextToken value to include in a future ListAttributes request. When the results of a ListAttributes request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

listAttributesResponse_httpStatus :: Lens' ListAttributesResponse Int

The response's http status code.

ListClusters

listClusters_maxResults :: Lens' ListClusters (Maybe Int)

The maximum number of cluster results that ListClusters returned in paginated output. When this parameter is used, ListClusters only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListClusters returns up to 100 results and a nextToken value if applicable.

listClusters_nextToken :: Lens' ListClusters (Maybe Text)

The nextToken value returned from a ListClusters request indicating that more results are available to fulfill the request and further calls are needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

listClustersResponse_clusterArns :: Lens' ListClustersResponse (Maybe [Text])

The list of full Amazon Resource Name (ARN) entries for each cluster that's associated with your account.

listClustersResponse_nextToken :: Lens' ListClustersResponse (Maybe Text)

The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

listClustersResponse_httpStatus :: Lens' ListClustersResponse Int

The response's http status code.

ListContainerInstances

listContainerInstances_cluster :: Lens' ListContainerInstances (Maybe Text)

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.

listContainerInstances_filter :: Lens' ListContainerInstances (Maybe Text)

You can filter the results of a ListContainerInstances operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

listContainerInstances_maxResults :: Lens' ListContainerInstances (Maybe Int)

The maximum number of container instance results that ListContainerInstances returned in paginated output. When this parameter is used, ListContainerInstances only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.

listContainerInstances_nextToken :: Lens' ListContainerInstances (Maybe Text)

The nextToken value returned from a ListContainerInstances request indicating that more results are available to fulfill the request and further calls are needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

listContainerInstances_status :: Lens' ListContainerInstances (Maybe ContainerInstanceStatus)

Filters the container instances by status. For example, if you specify the DRAINING status, the results include only container instances that have been set to DRAINING using UpdateContainerInstancesState. If you don't specify this parameter, the default is to include container instances set to all states other than INACTIVE.

listContainerInstancesResponse_containerInstanceArns :: Lens' ListContainerInstancesResponse (Maybe [Text])

The list of container instances with full ARN entries for each container instance associated with the specified cluster.

listContainerInstancesResponse_nextToken :: Lens' ListContainerInstancesResponse (Maybe Text)

The nextToken value to include in a future ListContainerInstances request. When the results of a ListContainerInstances request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

listContainerInstancesResponse_httpStatus :: Lens' ListContainerInstancesResponse Int

The response's http status code.

ListServices

listServices_cluster :: Lens' ListServices (Maybe Text)

The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListServices results. If you do not specify a cluster, the default cluster is assumed.

listServices_launchType :: Lens' ListServices (Maybe LaunchType)

The launch type to use when filtering the ListServices results.

listServices_maxResults :: Lens' ListServices (Maybe Int)

The maximum number of service results that ListServices returned in paginated output. When this parameter is used, ListServices only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServices request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListServices returns up to 10 results and a nextToken value if applicable.

listServices_nextToken :: Lens' ListServices (Maybe Text)

The nextToken value returned from a ListServices request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

listServices_schedulingStrategy :: Lens' ListServices (Maybe SchedulingStrategy)

The scheduling strategy to use when filtering the ListServices results.

listServicesResponse_nextToken :: Lens' ListServicesResponse (Maybe Text)

The nextToken value to include in a future ListServices request. When the results of a ListServices request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

listServicesResponse_serviceArns :: Lens' ListServicesResponse (Maybe [Text])

The list of full ARN entries for each service that's associated with the specified cluster.

listServicesResponse_httpStatus :: Lens' ListServicesResponse Int

The response's http status code.

ListServicesByNamespace

listServicesByNamespace_maxResults :: Lens' ListServicesByNamespace (Maybe Int)

The maximum number of service results that ListServicesByNamespace returns in paginated output. When this parameter is used, ListServicesByNamespace only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServicesByNamespace request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListServicesByNamespace returns up to 10 results and a nextToken value if applicable.

listServicesByNamespace_nextToken :: Lens' ListServicesByNamespace (Maybe Text)

The nextToken value that's returned from a ListServicesByNamespace request. It indicates that more results are available to fulfill the request and further calls are needed. If maxResults is returned, it is possible the number of results is less than maxResults.

listServicesByNamespace_namespace :: Lens' ListServicesByNamespace Text

The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace to list the services in.

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.

listServicesByNamespaceResponse_nextToken :: Lens' ListServicesByNamespaceResponse (Maybe Text)

The nextToken value to include in a future ListServicesByNamespace request. When the results of a ListServicesByNamespace request exceed maxResults, this value can be used to retrieve the next page of results. When there are no more results to return, this value is null.

listServicesByNamespaceResponse_serviceArns :: Lens' ListServicesByNamespaceResponse (Maybe [Text])

The list of full ARN entries for each service that's associated with the specified namespace.

listServicesByNamespaceResponse_httpStatus :: Lens' ListServicesByNamespaceResponse Int

The response's http status code.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text

The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag])

The tags for the resource.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int

The response's http status code.

ListTaskDefinitionFamilies

listTaskDefinitionFamilies_familyPrefix :: Lens' ListTaskDefinitionFamilies (Maybe Text)

The familyPrefix is a string that's used to filter the results of ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family names that begin with the familyPrefix string are returned.

listTaskDefinitionFamilies_maxResults :: Lens' ListTaskDefinitionFamilies (Maybe Int)

The maximum number of task definition family results that ListTaskDefinitionFamilies returned in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitionFamilies request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken value if applicable.

listTaskDefinitionFamilies_nextToken :: Lens' ListTaskDefinitionFamilies (Maybe Text)

The nextToken value returned from a ListTaskDefinitionFamilies request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

listTaskDefinitionFamilies_status :: Lens' ListTaskDefinitionFamilies (Maybe TaskDefinitionFamilyStatus)

The task definition family status to filter the ListTaskDefinitionFamilies results with. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE, only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE, only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

listTaskDefinitionFamiliesResponse_families :: Lens' ListTaskDefinitionFamiliesResponse (Maybe [Text])

The list of task definition family names that match the ListTaskDefinitionFamilies request.

listTaskDefinitionFamiliesResponse_nextToken :: Lens' ListTaskDefinitionFamiliesResponse (Maybe Text)

The nextToken value to include in a future ListTaskDefinitionFamilies request. When the results of a ListTaskDefinitionFamilies request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

listTaskDefinitionFamiliesResponse_httpStatus :: Lens' ListTaskDefinitionFamiliesResponse Int

The response's http status code.

ListTaskDefinitions

listTaskDefinitions_familyPrefix :: Lens' ListTaskDefinitions (Maybe Text)

The full family name to filter the ListTaskDefinitions results with. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.

listTaskDefinitions_maxResults :: Lens' ListTaskDefinitions (Maybe Int)

The maximum number of task definition results that ListTaskDefinitions returned in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.

listTaskDefinitions_nextToken :: Lens' ListTaskDefinitions (Maybe Text)

The nextToken value returned from a ListTaskDefinitions request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

listTaskDefinitions_sort :: Lens' ListTaskDefinitions (Maybe SortOrder)

The order to sort the results in. Valid values are ASC and DESC. By default, (ASC) task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision. This is so that the newest task definitions in a family are listed first.

listTaskDefinitions_status :: Lens' ListTaskDefinitions (Maybe TaskDefinitionStatus)

The task definition status to filter the ListTaskDefinitions results with. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

listTaskDefinitionsResponse_nextToken :: Lens' ListTaskDefinitionsResponse (Maybe Text)

The nextToken value to include in a future ListTaskDefinitions request. When the results of a ListTaskDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

listTaskDefinitionsResponse_taskDefinitionArns :: Lens' ListTaskDefinitionsResponse (Maybe [Text])

The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefinitions request.

listTaskDefinitionsResponse_httpStatus :: Lens' ListTaskDefinitionsResponse Int

The response's http status code.

ListTasks

listTasks_cluster :: Lens' ListTasks (Maybe Text)

The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListTasks results. If you do not specify a cluster, the default cluster is assumed.

listTasks_containerInstance :: Lens' ListTasks (Maybe Text)

The container instance ID or full ARN of the container instance to use when filtering the ListTasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance.

listTasks_desiredStatus :: Lens' ListTasks (Maybe DesiredStatus)

The task desired status to use when filtering the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED. This can be useful for debugging tasks that aren't starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon ECS has set the desired status to RUNNING.

Although you can filter results based on a desired status of PENDING, this doesn't return any results. Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING).

listTasks_family :: Lens' ListTasks (Maybe Text)

The name of the task definition family to use when filtering the ListTasks results. Specifying a family limits the results to tasks that belong to that family.

listTasks_launchType :: Lens' ListTasks (Maybe LaunchType)

The launch type to use when filtering the ListTasks results.

listTasks_maxResults :: Lens' ListTasks (Maybe Int)

The maximum number of task results that ListTasks returned in paginated output. When this parameter is used, ListTasks only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTasks request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListTasks returns up to 100 results and a nextToken value if applicable.

listTasks_nextToken :: Lens' ListTasks (Maybe Text)

The nextToken value returned from a ListTasks request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

listTasks_serviceName :: Lens' ListTasks (Maybe Text)

The name of the service to use when filtering the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service.

listTasks_startedBy :: Lens' ListTasks (Maybe Text)

The startedBy value to filter the task results with. Specifying a startedBy value limits the results to tasks that were started with that value.

When you specify startedBy as the filter, it must be the only filter that you use.

listTasksResponse_nextToken :: Lens' ListTasksResponse (Maybe Text)

The nextToken value to include in a future ListTasks request. When the results of a ListTasks request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

listTasksResponse_taskArns :: Lens' ListTasksResponse (Maybe [Text])

The list of task ARN entries for the ListTasks request.

listTasksResponse_httpStatus :: Lens' ListTasksResponse Int

The response's http status code.

PutAccountSetting

putAccountSetting_principalArn :: Lens' PutAccountSetting (Maybe Text)

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it modifies the account setting for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.

Federated users assume the account setting of the root user and can't have explicit account settings set for them.

putAccountSetting_name :: Lens' PutAccountSetting SettingName

The Amazon ECS resource name for which to modify the account setting. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected. If awsvpcTrunking is specified, the elastic network interface (ENI) limit for your Amazon ECS container instances is affected. If containerInsights is specified, the default setting for CloudWatch Container Insights for your clusters is affected.

putAccountSetting_value :: Lens' PutAccountSetting Text

The account setting value for the specified principal ARN. Accepted values are enabled and disabled.

putAccountSettingResponse_setting :: Lens' PutAccountSettingResponse (Maybe Setting)

The current account setting for a resource.

putAccountSettingResponse_httpStatus :: Lens' PutAccountSettingResponse Int

The response's http status code.

PutAccountSettingDefault

putAccountSettingDefault_name :: Lens' PutAccountSettingDefault SettingName

The resource name for which to modify the account setting. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected. If awsvpcTrunking is specified, the ENI limit for your Amazon ECS container instances is affected. If containerInsights is specified, the default setting for CloudWatch Container Insights for your clusters is affected.

Fargate is transitioning from task count-based quotas to vCPU-based quotas. You can set the name to fargateVCPULimit to opt in or opt out of the vCPU-based quotas. For information about the opt in timeline, see Fargate vCPU-based quotas timeline in the Amazon ECS Developer Guide.

putAccountSettingDefault_value :: Lens' PutAccountSettingDefault Text

The account setting value for the specified principal ARN. Accepted values are enabled and disabled.

putAccountSettingDefaultResponse_setting :: Lens' PutAccountSettingDefaultResponse (Maybe Setting)

The current setting for a resource.

putAccountSettingDefaultResponse_httpStatus :: Lens' PutAccountSettingDefaultResponse Int

The response's http status code.

PutAttributes

putAttributes_cluster :: Lens' PutAttributes (Maybe Text)

The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply attributes. If you do not specify a cluster, the default cluster is assumed.

putAttributes_attributes :: Lens' PutAttributes [Attribute]

The attributes to apply to your resource. You can specify up to 10 custom attributes for each resource. You can specify up to 10 attributes in a single call.

putAttributesResponse_attributes :: Lens' PutAttributesResponse (Maybe [Attribute])

The attributes applied to your resource.

putAttributesResponse_httpStatus :: Lens' PutAttributesResponse Int

The response's http status code.

PutClusterCapacityProviders

putClusterCapacityProviders_cluster :: Lens' PutClusterCapacityProviders Text

The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you don't specify a cluster, the default cluster is assumed.

putClusterCapacityProviders_capacityProviders :: Lens' PutClusterCapacityProviders [Text]

The name of one or more capacity providers to associate with the cluster.

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

putClusterCapacityProviders_defaultCapacityProviderStrategy :: Lens' PutClusterCapacityProviders [CapacityProviderStrategyItem]

The capacity provider strategy to use by default for the cluster.

When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

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

putClusterCapacityProvidersResponse_cluster :: Lens' PutClusterCapacityProvidersResponse (Maybe Cluster)

Details about the cluster.

putClusterCapacityProvidersResponse_httpStatus :: Lens' PutClusterCapacityProvidersResponse Int

The response's http status code.

RegisterContainerInstance

registerContainerInstance_attributes :: Lens' RegisterContainerInstance (Maybe [Attribute])

The container instance attributes that this container instance supports.

registerContainerInstance_cluster :: Lens' RegisterContainerInstance (Maybe Text)

The short name or full Amazon Resource Name (ARN) of the cluster to register your container instance with. If you do not specify a cluster, the default cluster is assumed.

registerContainerInstance_containerInstanceArn :: Lens' RegisterContainerInstance (Maybe Text)

The ARN of the container instance (if it was previously registered).

registerContainerInstance_instanceIdentityDocument :: Lens' RegisterContainerInstance (Maybe Text)

The instance identity document for the EC2 instance to register. This document can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/document/

registerContainerInstance_instanceIdentityDocumentSignature :: Lens' RegisterContainerInstance (Maybe Text)

The instance identity document signature for the EC2 instance to register. This signature can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/signature/

registerContainerInstance_platformDevices :: Lens' RegisterContainerInstance (Maybe [PlatformDevice])

The devices that are available on the container instance. The only supported device type is a GPU.

registerContainerInstance_tags :: Lens' RegisterContainerInstance (Maybe [Tag])

The metadata that you apply to the container instance 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.

registerContainerInstance_totalResources :: Lens' RegisterContainerInstance (Maybe [Resource])

The resources available on the instance.

registerContainerInstance_versionInfo :: Lens' RegisterContainerInstance (Maybe VersionInfo)

The version information for the Amazon ECS container agent and Docker daemon that runs on the container instance.

registerContainerInstanceResponse_containerInstance :: Lens' RegisterContainerInstanceResponse (Maybe ContainerInstance)

The container instance that was registered.

registerContainerInstanceResponse_httpStatus :: Lens' RegisterContainerInstanceResponse Int

The response's http status code.

RegisterTaskDefinition

registerTaskDefinition_cpu :: Lens' RegisterTaskDefinition (Maybe Text)

The number of CPU units used by the task. It can be expressed as an integer using CPU units (for example, 1024) or as a string using vCPUs (for example, 1 vCPU or 1 vcpu) in a task definition. String values are converted to an integer indicating the CPU units when the task definition is registered.

Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.

If you're using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs). If you do not specify a value, the parameter is ignored.

If you're using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:

The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

• 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
• 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
• 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
• 2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
• 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)

• 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments

  This option requires Linux platform 1.4.0 or later.

• 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments

  This option requires Linux platform 1.4.0 or later.

registerTaskDefinition_ephemeralStorage :: Lens' RegisterTaskDefinition (Maybe EphemeralStorage)

The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more information, see Fargate task storage in the Amazon ECS User Guide for Fargate.

This parameter is only supported for tasks hosted on Fargate using the following platform versions:

• Linux platform version 1.4.0 or later.

registerTaskDefinition_executionRoleArn :: Lens' RegisterTaskDefinition (Maybe Text)

The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.

registerTaskDefinition_inferenceAccelerators :: Lens' RegisterTaskDefinition (Maybe [InferenceAccelerator])

The Elastic Inference accelerators to use for the containers in the task.

registerTaskDefinition_ipcMode :: Lens' RegisterTaskDefinition (Maybe IpcMode)

The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.

If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.

If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.

• For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.
• For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.

This parameter is not supported for Windows containers or tasks run on Fargate.

registerTaskDefinition_memory :: Lens' RegisterTaskDefinition (Maybe Text)

The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB (for example ,1024) or as a string using GB (for example, 1GB or 1 GB) in a task definition. String values are converted to an integer indicating the MiB when the task definition is registered.

Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.

If using the EC2 launch type, this field is optional.

If using the Fargate launch type, this field is required and you must use one of the following values. This determines your range of supported values for the cpu parameter.

The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

• 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
• 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
• 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
• Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
• Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)

• Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)

  This option requires Linux platform 1.4.0 or later.

• Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)

  This option requires Linux platform 1.4.0 or later.

registerTaskDefinition_networkMode :: Lens' RegisterTaskDefinition (Maybe NetworkMode)

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.

For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.

If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.

For more information, see Network settings in the Docker run reference.

registerTaskDefinition_pidMode :: Lens' RegisterTaskDefinition (Maybe PidMode)

The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference.

If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security.

This parameter is not supported for Windows containers or tasks run on Fargate.

registerTaskDefinition_placementConstraints :: Lens' RegisterTaskDefinition (Maybe [TaskDefinitionPlacementConstraint])

An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.

registerTaskDefinition_proxyConfiguration :: Lens' RegisterTaskDefinition (Maybe ProxyConfiguration)

The configuration details for the App Mesh proxy.

For tasks hosted on Amazon EC2 instances, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to use a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized AMI versions in the Amazon Elastic Container Service Developer Guide.

registerTaskDefinition_requiresCompatibilities :: Lens' RegisterTaskDefinition (Maybe [Compatibility])

The task launch type that Amazon ECS validates the task definition against. A client exception is returned if the task definition doesn't validate against the compatibilities specified. If no value is specified, the parameter is omitted from the response.

registerTaskDefinition_runtimePlatform :: Lens' RegisterTaskDefinition (Maybe RuntimePlatform)

The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type.

When you specify a task definition in a service, this value must match the runtimePlatform value of the service.

registerTaskDefinition_tags :: Lens' RegisterTaskDefinition (Maybe [Tag])

The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of 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.

registerTaskDefinition_taskRoleArn :: Lens' RegisterTaskDefinition (Maybe Text)

The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.

registerTaskDefinition_volumes :: Lens' RegisterTaskDefinition (Maybe [Volume])

A list of volume definitions in JSON format that containers in your task might use.

registerTaskDefinition_family :: Lens' RegisterTaskDefinition Text

You must specify a family for a task definition. You can use it track multiple versions of the same task definition. The family is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.

registerTaskDefinition_containerDefinitions :: Lens' RegisterTaskDefinition [ContainerDefinition]

A list of container definitions in JSON format that describe the different containers that make up your task.

registerTaskDefinitionResponse_tags :: Lens' RegisterTaskDefinitionResponse (Maybe [Tag])

The list of tags associated with the task definition.

registerTaskDefinitionResponse_taskDefinition :: Lens' RegisterTaskDefinitionResponse (Maybe TaskDefinition)

The full description of the registered task definition.

registerTaskDefinitionResponse_httpStatus :: Lens' RegisterTaskDefinitionResponse Int

The response's http status code.

RunTask

runTask_capacityProviderStrategy :: Lens' RunTask (Maybe [CapacityProviderStrategyItem])

The capacity provider strategy to use for the task.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

When you use cluster auto scaling, you must specify capacityProviderStrategy and not launchType.

A capacity provider strategy may contain a maximum of 6 capacity providers.

runTask_cluster :: Lens' RunTask (Maybe Text)

The short name or full Amazon Resource Name (ARN) of the cluster to run your task on. If you do not specify a cluster, the default cluster is assumed.

runTask_count :: Lens' RunTask (Maybe Int)

The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks for each call.

runTask_enableECSManagedTags :: Lens' RunTask (Maybe Bool)

Specifies whether to use Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

runTask_enableExecuteCommand :: Lens' RunTask (Maybe Bool)

Determines whether to use the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.

If true, then the task definition must have a task role, or you must provide one as an override.

runTask_group :: Lens' RunTask (Maybe Text)

The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).

runTask_launchType :: Lens' RunTask (Maybe LaunchType)

The infrastructure to run your standalone task on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

The FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.

Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate.

The EC2 launch type runs your tasks on Amazon EC2 instances registered to your cluster.

The EXTERNAL launch type runs your tasks on your on-premises server or virtual machine (VM) capacity registered to your cluster.

A task can use either a launch type or a capacity provider strategy. If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

When you use cluster auto scaling, you must specify capacityProviderStrategy and not launchType.

runTask_networkConfiguration :: Lens' RunTask (Maybe NetworkConfiguration)

The network configuration for the task. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it isn't supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.

runTask_overrides :: Lens' RunTask (Maybe TaskOverride)

A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that's specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

runTask_placementConstraints :: Lens' RunTask (Maybe [PlacementConstraint])

An array of placement constraint objects to use for the task. You can specify up to 10 constraints for each task (including constraints in the task definition and those specified at runtime).

runTask_placementStrategy :: Lens' RunTask (Maybe [PlacementStrategy])

The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules for each task.

runTask_platformVersion :: Lens' RunTask (Maybe Text)

The platform version the task uses. A platform version is only specified for tasks hosted on Fargate. If one isn't specified, the LATEST platform version is used. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

runTask_propagateTags :: Lens' RunTask (Maybe PropagateTags)

Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

An error will be received if you specify the SERVICE option when running a task.

runTask_referenceId :: Lens' RunTask (Maybe Text)

The reference ID to use for the task. The reference ID can have a maximum length of 1024 characters.

runTask_startedBy :: Lens' RunTask (Maybe Text)

An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens (-), and underscores (_) are allowed.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

runTask_tags :: Lens' RunTask (Maybe [Tag])

The metadata that you apply to the task 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.

runTask_taskDefinition :: Lens' RunTask Text

The family and revision (family:revision) or full ARN of the task definition to run. If a revision isn't specified, the latest ACTIVE revision is used.

When you create an IAM policy for run-task, you can set the resource to be the latest task definition revision, or a specific revision.

The full ARN value must match the value that you specified as the Resource of the IAM principal's permissions policy.

When you specify the policy resource as the latest task definition version (by setting the Resource in the policy to arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName), then set this value to arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName.

When you specify the policy resource as a specific task definition version (by setting the Resource in the policy to arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1 or arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*), then set this value to arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1.

For more information, see Policy Resources for Amazon ECS in the Amazon Elastic Container Service developer Guide.

runTaskResponse_failures :: Lens' RunTaskResponse (Maybe [Failure])

Any failures associated with the call.

runTaskResponse_tasks :: Lens' RunTaskResponse (Maybe [Task])

A full description of the tasks that were run. The tasks that were successfully placed on your cluster are described here.

runTaskResponse_httpStatus :: Lens' RunTaskResponse Int

The response's http status code.

StartTask

startTask_cluster :: Lens' StartTask (Maybe Text)

The short name or full Amazon Resource Name (ARN) of the cluster where to start your task. If you do not specify a cluster, the default cluster is assumed.

startTask_enableECSManagedTags :: Lens' StartTask (Maybe Bool)

Specifies whether to use Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

startTask_enableExecuteCommand :: Lens' StartTask (Maybe Bool)

Whether or not the execute command functionality is enabled for the task. If true, this enables execute command functionality on all containers in the task.

startTask_group :: Lens' StartTask (Maybe Text)

The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).

startTask_networkConfiguration :: Lens' StartTask (Maybe NetworkConfiguration)

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

startTask_overrides :: Lens' StartTask (Maybe TaskOverride)

A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it receives. You can override the default command for a container (that's specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

startTask_propagateTags :: Lens' StartTask (Maybe PropagateTags)

Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.

startTask_referenceId :: Lens' StartTask (Maybe Text)

The reference ID to use for the task.

startTask_startedBy :: Lens' StartTask (Maybe Text)

An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens (-), and underscores (_) are allowed.

If a task is started by an Amazon ECS service, the startedBy parameter contains the deployment ID of the service that starts it.

startTask_tags :: Lens' StartTask (Maybe [Tag])

The metadata that you apply to the task 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.

startTask_containerInstances :: Lens' StartTask [Text]

The container instance IDs or full ARN entries for the container instances where you would like to place your task. You can specify up to 10 container instances.

startTask_taskDefinition :: Lens' StartTask Text

The family and revision (family:revision) or full ARN of the task definition to start. If a revision isn't specified, the latest ACTIVE revision is used.

startTaskResponse_failures :: Lens' StartTaskResponse (Maybe [Failure])

Any failures associated with the call.

startTaskResponse_tasks :: Lens' StartTaskResponse (Maybe [Task])

A full description of the tasks that were started. Each task that was successfully placed on your container instances is described.

startTaskResponse_httpStatus :: Lens' StartTaskResponse Int

The response's http status code.

StopTask

stopTask_cluster :: Lens' StopTask (Maybe Text)

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.

stopTask_reason :: Lens' StopTask (Maybe Text)

An optional message specified when a task is stopped. For example, if you're using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.

stopTask_task :: Lens' StopTask Text

The task ID or full Amazon Resource Name (ARN) of the task to stop.

stopTaskResponse_task :: Lens' StopTaskResponse (Maybe Task)

The task that was stopped.

stopTaskResponse_httpStatus :: Lens' StopTaskResponse Int

The response's http status code.

SubmitAttachmentStateChanges

submitAttachmentStateChanges_cluster :: Lens' SubmitAttachmentStateChanges (Maybe Text)

The short name or full ARN of the cluster that hosts the container instance the attachment belongs to.

submitAttachmentStateChanges_attachments :: Lens' SubmitAttachmentStateChanges [AttachmentStateChange]

Any attachments associated with the state change request.

submitAttachmentStateChangesResponse_acknowledgment :: Lens' SubmitAttachmentStateChangesResponse (Maybe Text)

Acknowledgement of the state change.

submitAttachmentStateChangesResponse_httpStatus :: Lens' SubmitAttachmentStateChangesResponse Int

The response's http status code.

SubmitContainerStateChange

submitContainerStateChange_cluster :: Lens' SubmitContainerStateChange (Maybe Text)

The short name or full ARN of the cluster that hosts the container.

submitContainerStateChange_containerName :: Lens' SubmitContainerStateChange (Maybe Text)

The name of the container.

submitContainerStateChange_exitCode :: Lens' SubmitContainerStateChange (Maybe Int)

The exit code that's returned for the state change request.

submitContainerStateChange_networkBindings :: Lens' SubmitContainerStateChange (Maybe [NetworkBinding])

The network bindings of the container.

submitContainerStateChange_reason :: Lens' SubmitContainerStateChange (Maybe Text)

The reason for the state change request.

submitContainerStateChange_runtimeId :: Lens' SubmitContainerStateChange (Maybe Text)

The ID of the Docker container.

submitContainerStateChange_status :: Lens' SubmitContainerStateChange (Maybe Text)

The status of the state change request.

submitContainerStateChange_task :: Lens' SubmitContainerStateChange (Maybe Text)

The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.

submitContainerStateChangeResponse_acknowledgment :: Lens' SubmitContainerStateChangeResponse (Maybe Text)

Acknowledgement of the state change.

submitContainerStateChangeResponse_httpStatus :: Lens' SubmitContainerStateChangeResponse Int

The response's http status code.

SubmitTaskStateChange

submitTaskStateChange_attachments :: Lens' SubmitTaskStateChange (Maybe [AttachmentStateChange])

Any attachments associated with the state change request.

submitTaskStateChange_cluster :: Lens' SubmitTaskStateChange (Maybe Text)

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.

submitTaskStateChange_containers :: Lens' SubmitTaskStateChange (Maybe [ContainerStateChange])

Any containers that's associated with the state change request.

submitTaskStateChange_executionStoppedAt :: Lens' SubmitTaskStateChange (Maybe UTCTime)

The Unix timestamp for the time when the task execution stopped.

submitTaskStateChange_managedAgents :: Lens' SubmitTaskStateChange (Maybe [ManagedAgentStateChange])

The details for the managed agent that's associated with the task.

submitTaskStateChange_pullStartedAt :: Lens' SubmitTaskStateChange (Maybe UTCTime)

The Unix timestamp for the time when the container image pull started.

submitTaskStateChange_pullStoppedAt :: Lens' SubmitTaskStateChange (Maybe UTCTime)

The Unix timestamp for the time when the container image pull completed.

submitTaskStateChange_reason :: Lens' SubmitTaskStateChange (Maybe Text)

The reason for the state change request.

submitTaskStateChange_status :: Lens' SubmitTaskStateChange (Maybe Text)

The status of the state change request.

submitTaskStateChange_task :: Lens' SubmitTaskStateChange (Maybe Text)

The task ID or full ARN of the task in the state change request.

submitTaskStateChangeResponse_acknowledgment :: Lens' SubmitTaskStateChangeResponse (Maybe Text)

Acknowledgement of the state change.

submitTaskStateChangeResponse_httpStatus :: Lens' SubmitTaskStateChangeResponse Int

The response's http status code.

TagResource

tagResource_resourceArn :: Lens' TagResource Text

The Amazon Resource Name (ARN) of the resource to add tags to. Currently, the supported resources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container instances.

tagResource_tags :: Lens' TagResource [Tag]

The tags to add to the resource. A tag is an array of key-value pairs.

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.

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int

The response's http status code.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text

The Amazon Resource Name (ARN) of the resource to delete tags from. Currently, the supported resources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container instances.

untagResource_tagKeys :: Lens' UntagResource [Text]

The keys of the tags to be removed.

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int

The response's http status code.

UpdateCapacityProvider

updateCapacityProvider_name :: Lens' UpdateCapacityProvider Text

The name of the capacity provider to update.

updateCapacityProvider_autoScalingGroupProvider :: Lens' UpdateCapacityProvider AutoScalingGroupProviderUpdate

An object that represent the parameters to update for the Auto Scaling group capacity provider.

updateCapacityProviderResponse_capacityProvider :: Lens' UpdateCapacityProviderResponse (Maybe CapacityProvider)

Details about the capacity provider.

updateCapacityProviderResponse_httpStatus :: Lens' UpdateCapacityProviderResponse Int

The response's http status code.

UpdateCluster

updateCluster_configuration :: Lens' UpdateCluster (Maybe ClusterConfiguration)

The execute command configuration for the cluster.

updateCluster_serviceConnectDefaults :: Lens' UpdateCluster (Maybe ClusterServiceConnectDefaultsRequest)

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.

updateCluster_settings :: Lens' UpdateCluster (Maybe [ClusterSetting])

The cluster settings for your cluster.

updateCluster_cluster :: Lens' UpdateCluster Text

The name of the cluster to modify the settings for.

updateClusterResponse_cluster :: Lens' UpdateClusterResponse (Maybe Cluster)

Details about the cluster.

updateClusterResponse_httpStatus :: Lens' UpdateClusterResponse Int

The response's http status code.

UpdateClusterSettings

updateClusterSettings_cluster :: Lens' UpdateClusterSettings Text

The name of the cluster to modify the settings for.

updateClusterSettings_settings :: Lens' UpdateClusterSettings [ClusterSetting]

The setting to use by default for 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.

Currently, if you delete an existing cluster that does not have Container Insights turned on, and then create a new cluster with the same name with Container Insights tuned on, Container Insights will not actually be turned on. If you want to preserve the same name for your existing cluster and turn on Container Insights, you must wait 7 days before you can re-create it.

updateClusterSettingsResponse_cluster :: Lens' UpdateClusterSettingsResponse (Maybe Cluster)

Details about the cluster

updateClusterSettingsResponse_httpStatus :: Lens' UpdateClusterSettingsResponse Int

The response's http status code.

UpdateContainerAgent

updateContainerAgent_cluster :: Lens' UpdateContainerAgent (Maybe Text)

The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is running on. If you do not specify a cluster, the default cluster is assumed.

updateContainerAgent_containerInstance :: Lens' UpdateContainerAgent Text

The container instance ID or full ARN entries for the container instance where you would like to update the Amazon ECS container agent.

updateContainerAgentResponse_containerInstance :: Lens' UpdateContainerAgentResponse (Maybe ContainerInstance)

The container instance that the container agent was updated for.

updateContainerAgentResponse_httpStatus :: Lens' UpdateContainerAgentResponse Int

The response's http status code.

UpdateContainerInstancesState

updateContainerInstancesState_cluster :: Lens' UpdateContainerInstancesState (Maybe Text)

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to update. If you do not specify a cluster, the default cluster is assumed.

updateContainerInstancesState_containerInstances :: Lens' UpdateContainerInstancesState [Text]

A list of up to 10 container instance IDs or full ARN entries.

updateContainerInstancesState_status :: Lens' UpdateContainerInstancesState ContainerInstanceStatus

The container instance state to update the container instance with. The only valid values for this action are ACTIVE and DRAINING. A container instance can only be updated to DRAINING status once it has reached an ACTIVE state. If a container instance is in REGISTERING, DEREGISTERING, or REGISTRATION_FAILED state you can describe the container instance but can't update the container instance state.

updateContainerInstancesStateResponse_containerInstances :: Lens' UpdateContainerInstancesStateResponse (Maybe [ContainerInstance])

The list of container instances.

updateContainerInstancesStateResponse_failures :: Lens' UpdateContainerInstancesStateResponse (Maybe [Failure])

Any failures associated with the call.

updateContainerInstancesStateResponse_httpStatus :: Lens' UpdateContainerInstancesStateResponse Int

The response's http status code.

UpdateService

updateService_capacityProviderStrategy :: Lens' UpdateService (Maybe [CapacityProviderStrategyItem])

The capacity provider strategy to update the service to use.

if the service uses the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers as opposed to the default capacity provider strategy. However, when a service is using a capacity provider strategy that's not the default capacity provider strategy, the service can't be updated to use the cluster's default capacity provider strategy.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

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

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

updateService_cluster :: Lens' UpdateService (Maybe Text)

The short name or full Amazon Resource Name (ARN) of the cluster that your service runs on. If you do not specify a cluster, the default cluster is assumed.

updateService_deploymentConfiguration :: Lens' UpdateService (Maybe DeploymentConfiguration)

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

updateService_desiredCount :: Lens' UpdateService (Maybe Int)

The number of instantiations of the task to place and keep running in your service.

updateService_enableECSManagedTags :: Lens' UpdateService (Maybe Bool)

Determines whether to turn on Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

Only tasks launched after the update will reflect the update. To update the tags on all tasks, set forceNewDeployment to true, so that Amazon ECS starts new tasks with the updated tags.

updateService_enableExecuteCommand :: Lens' UpdateService (Maybe Bool)

If true, this enables execute command functionality on all task containers.

If you do not want to override the value that was set when the service was created, you can set this to null when performing this action.

updateService_forceNewDeployment :: Lens' UpdateService (Maybe Bool)

Determines whether to force a new deployment of the service. By default, deployments aren't forced. You can use this option to start a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination (my_image:latest) or to roll Fargate tasks onto a newer platform version.

updateService_healthCheckGracePeriodSeconds :: Lens' UpdateService (Maybe Int)

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

updateService_loadBalancers :: Lens' UpdateService (Maybe [LoadBalancer])

A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.

When you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks with the updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks are running.

For services that use rolling updates, you can add, update, or remove Elastic Load Balancing target groups. You can update from a single target group to multiple target groups and from multiple target groups to a single target group.

For services that use blue/green deployments, you can update Elastic Load Balancing target groups by using CreateDeployment through CodeDeploy. Note that multiple target groups are not supported for blue/green deployments. For more information see Register multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

For services that use the external deployment controller, you can add, update, or remove load balancers by using CreateTaskSet. Note that multiple target groups are not supported for external deployments. For more information see Register multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

You can remove existing loadBalancers by passing an empty list.

updateService_networkConfiguration :: Lens' UpdateService (Maybe NetworkConfiguration)

An object representing the network configuration for the service.

updateService_placementConstraints :: Lens' UpdateService (Maybe [PlacementConstraint])

An array of task placement constraint objects to update the service to use. If no value is specified, the existing placement constraints for the service will remain unchanged. If this value is specified, it will override any existing placement constraints defined for the service. To remove all existing placement constraints, specify an empty array.

You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.

updateService_placementStrategy :: Lens' UpdateService (Maybe [PlacementStrategy])

The task placement strategy objects to update the service to use. If no value is specified, the existing placement strategy for the service will remain unchanged. If this value is specified, it will override the existing placement strategy defined for the service. To remove an existing placement strategy, specify an empty object.

You can specify a maximum of five strategy rules for each service.

updateService_platformVersion :: Lens' UpdateService (Maybe Text)

The platform version that your tasks in the service run on. A platform version is only specified for tasks using the Fargate launch type. If a platform version is not specified, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

updateService_propagateTags :: Lens' UpdateService (Maybe PropagateTags)

Determines whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.

Only tasks launched after the update will reflect the update. To update the tags on all tasks, set forceNewDeployment to true, so that Amazon ECS starts new tasks with the updated tags.

updateService_serviceConnectConfiguration :: Lens' UpdateService (Maybe ServiceConnectConfiguration)

The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

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.

updateService_serviceRegistries :: Lens' UpdateService (Maybe [ServiceRegistry])

The details for the service discovery registries to assign to this service. For more information, see Service Discovery.

When you add, update, or remove the service registries configuration, Amazon ECS starts new tasks with the updated service registries configuration, and then stops the old tasks when the new tasks are running.

You can remove existing serviceRegistries by passing an empty list.

updateService_taskDefinition :: Lens' UpdateService (Maybe Text)

The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.

updateService_service :: Lens' UpdateService Text

The name of the service to update.

updateServiceResponse_service :: Lens' UpdateServiceResponse (Maybe ContainerService)

The full description of your service following the update call.

updateServiceResponse_httpStatus :: Lens' UpdateServiceResponse Int

The response's http status code.

UpdateServicePrimaryTaskSet

updateServicePrimaryTaskSet_cluster :: Lens' UpdateServicePrimaryTaskSet Text

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in.

updateServicePrimaryTaskSet_service :: Lens' UpdateServicePrimaryTaskSet Text

The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.

updateServicePrimaryTaskSet_primaryTaskSet :: Lens' UpdateServicePrimaryTaskSet Text

The short name or full Amazon Resource Name (ARN) of the task set to set as the primary task set in the deployment.

updateServicePrimaryTaskSetResponse_taskSet :: Lens' UpdateServicePrimaryTaskSetResponse (Maybe TaskSet)

The details about the task set.

updateServicePrimaryTaskSetResponse_httpStatus :: Lens' UpdateServicePrimaryTaskSetResponse Int

The response's http status code.

UpdateTaskProtection

updateTaskProtection_expiresInMinutes :: Lens' UpdateTaskProtection (Maybe Int)

If you set protectionEnabled to true, you can specify the duration for task protection in minutes. You can specify a value from 1 minute to up to 2,880 minutes (48 hours). During this time, your task will not be terminated by scale-in events from Service Auto Scaling or deployments. After this time period lapses, protectionEnabled will be reset to false.

If you don’t specify the time, then the task is automatically protected for 120 minutes (2 hours).

updateTaskProtection_cluster :: Lens' UpdateTaskProtection Text

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.

updateTaskProtection_tasks :: Lens' UpdateTaskProtection [Text]

A list of up to 10 task IDs or full ARN entries.

updateTaskProtection_protectionEnabled :: Lens' UpdateTaskProtection Bool

Specify true to mark a task for protection and false to unset protection, making it eligible for termination.

updateTaskProtectionResponse_failures :: Lens' UpdateTaskProtectionResponse (Maybe [Failure])

Any failures associated with the call.

updateTaskProtectionResponse_protectedTasks :: Lens' UpdateTaskProtectionResponse (Maybe [ProtectedTask])

A list of tasks with the following information.

• taskArn: The task ARN.
• protectionEnabled: The protection status of the task. If scale-in protection is enabled for a task, the value is true. Otherwise, it is false.
• expirationDate: The epoch time when protection for the task will expire.

updateTaskProtectionResponse_httpStatus :: Lens' UpdateTaskProtectionResponse Int

The response's http status code.

UpdateTaskSet

updateTaskSet_cluster :: Lens' UpdateTaskSet Text

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set is found in.

updateTaskSet_service :: Lens' UpdateTaskSet Text

The short name or full Amazon Resource Name (ARN) of the service that the task set is found in.

updateTaskSet_taskSet :: Lens' UpdateTaskSet Text

The short name or full Amazon Resource Name (ARN) of the task set to update.

updateTaskSet_scale :: Lens' UpdateTaskSet Scale

A floating-point percentage of the desired number of tasks to place and keep running in the task set.

updateTaskSetResponse_taskSet :: Lens' UpdateTaskSetResponse (Maybe TaskSet)

Details about the task set.

updateTaskSetResponse_httpStatus :: Lens' UpdateTaskSetResponse Int

The response's http status code.

Types

Attachment

attachment_details :: Lens' Attachment (Maybe [KeyValuePair])

Details of the attachment. For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.

attachment_id :: Lens' Attachment (Maybe Text)

The unique identifier for the attachment.

attachment_status :: Lens' Attachment (Maybe Text)

The status of the attachment. Valid values are PRECREATED, CREATED, ATTACHING, ATTACHED, DETACHING, DETACHED, DELETED, and FAILED.

attachment_type :: Lens' Attachment (Maybe Text)

The type of the attachment, such as ElasticNetworkInterface.

AttachmentStateChange

attachmentStateChange_attachmentArn :: Lens' AttachmentStateChange Text

The Amazon Resource Name (ARN) of the attachment.

attachmentStateChange_status :: Lens' AttachmentStateChange Text

The status of the attachment.

Attribute

attribute_targetId :: Lens' Attribute (Maybe Text)

The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).

attribute_targetType :: Lens' Attribute (Maybe TargetType)

The type of the target to attach the attribute with. This parameter is required if you use the short form ID for a resource instead of the full ARN.

attribute_value :: Lens' Attribute (Maybe Text)

The value of the attribute. The value must contain between 1 and 128 characters. It can contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), periods (.), at signs (@), forward slashes (/), back slashes (\), colons (:), or spaces. The value can't start or end with a space.

attribute_name :: Lens' Attribute Text

The name of the attribute. The name must contain between 1 and 128 characters. The name may contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), forward slashes (/), back slashes (\), or periods (.).

AutoScalingGroupProvider

autoScalingGroupProvider_managedScaling :: Lens' AutoScalingGroupProvider (Maybe ManagedScaling)

The managed scaling settings for the Auto Scaling group capacity provider.

autoScalingGroupProvider_managedTerminationProtection :: Lens' AutoScalingGroupProvider (Maybe ManagedTerminationProtection)

The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection. The default is disabled.

When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work.

When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled as well. For more information, see Instance Protection in the Auto Scaling User Guide.

When managed termination protection is disabled, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.

autoScalingGroupProvider_autoScalingGroupArn :: Lens' AutoScalingGroupProvider Text

The Amazon Resource Name (ARN) that identifies the Auto Scaling group.

AutoScalingGroupProviderUpdate

autoScalingGroupProviderUpdate_managedScaling :: Lens' AutoScalingGroupProviderUpdate (Maybe ManagedScaling)

The managed scaling settings for the Auto Scaling group capacity provider.

autoScalingGroupProviderUpdate_managedTerminationProtection :: Lens' AutoScalingGroupProviderUpdate (Maybe ManagedTerminationProtection)

The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection.

When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work.

When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled. For more information, see Instance Protection in the Auto Scaling User Guide.

When managed termination protection is disabled, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.

AwsVpcConfiguration

awsVpcConfiguration_assignPublicIp :: Lens' AwsVpcConfiguration (Maybe AssignPublicIp)

Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.

awsVpcConfiguration_securityGroups :: Lens' AwsVpcConfiguration (Maybe [Text])

The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per AwsVpcConfiguration.

All specified security groups must be from the same VPC.

awsVpcConfiguration_subnets :: Lens' AwsVpcConfiguration [Text]

The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per AwsVpcConfiguration.

All specified subnets must be from the same VPC.

CapacityProvider

capacityProvider_autoScalingGroupProvider :: Lens' CapacityProvider (Maybe AutoScalingGroupProvider)

The Auto Scaling group settings for the capacity provider.

capacityProvider_capacityProviderArn :: Lens' CapacityProvider (Maybe Text)

The Amazon Resource Name (ARN) that identifies the capacity provider.

capacityProvider_name :: Lens' CapacityProvider (Maybe Text)

The name of the capacity provider.

capacityProvider_status :: Lens' CapacityProvider (Maybe CapacityProviderStatus)

The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster. When a capacity provider is successfully deleted, it has an INACTIVE status.

capacityProvider_tags :: Lens' CapacityProvider (Maybe [Tag])

The metadata that you apply to the capacity provider to help you categorize and organize it. 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.

capacityProvider_updateStatus :: Lens' CapacityProvider (Maybe CapacityProviderUpdateStatus)

The update status of the capacity provider. The following are the possible states that is returned.

DELETE_IN_PROGRESS

The capacity provider is in the process of being deleted.

DELETE_COMPLETE

The capacity provider was successfully deleted and has an INACTIVE status.

DELETE_FAILED

The capacity provider can't be deleted. The update status reason provides further details about why the delete failed.

capacityProvider_updateStatusReason :: Lens' CapacityProvider (Maybe Text)

The update status reason. This provides further details about the update status for the capacity provider.

CapacityProviderStrategyItem

capacityProviderStrategyItem_base :: Lens' CapacityProviderStrategyItem (Maybe Natural)

The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.

capacityProviderStrategyItem_weight :: Lens' CapacityProviderStrategyItem (Maybe Natural)

The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.

If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0, any RunTask or CreateService actions using the capacity provider strategy will fail.

An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.

capacityProviderStrategyItem_capacityProvider :: Lens' CapacityProviderStrategyItem Text

The short name of the capacity provider.

Cluster

cluster_activeServicesCount :: Lens' Cluster (Maybe Int)

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])

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)

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])

The capacity providers associated with the cluster.

cluster_clusterArn :: Lens' Cluster (Maybe Text)

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)

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

cluster_configuration :: Lens' Cluster (Maybe ClusterConfiguration)

The execute command configuration for the cluster.

cluster_defaultCapacityProviderStrategy :: Lens' Cluster (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.

cluster_pendingTasksCount :: Lens' Cluster (Maybe Int)

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

cluster_registeredContainerInstancesCount :: Lens' Cluster (Maybe Int)

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)

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

cluster_serviceConnectDefaults :: Lens' Cluster (Maybe 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.

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

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])

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)

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.

cluster_tags :: Lens' Cluster (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. 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.

ClusterConfiguration

clusterConfiguration_executeCommandConfiguration :: Lens' ClusterConfiguration (Maybe ExecuteCommandConfiguration)

The details of the execute command configuration.

ClusterServiceConnectDefaults

clusterServiceConnectDefaults_namespace :: Lens' ClusterServiceConnectDefaults (Maybe Text)

The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace. When you create a service and don't specify a Service Connect configuration, this namespace is used.

ClusterServiceConnectDefaultsRequest

clusterServiceConnectDefaultsRequest_namespace :: Lens' ClusterServiceConnectDefaultsRequest Text

The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace that's used when you create a service and don't specify a Service Connect configuration. The namespace name can include up to 1024 characters. The name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than (>), less than (<), or slash (/).

If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace type is supported. The namespace must be in this account and this Amazon Web Services Region.

If you enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a Cloud Map namespace with the "API calls" method of instance discovery only. This instance discovery method is the "HTTP" namespace type in the Command Line Interface. Other types of instance discovery aren't used by Service Connect.

If you update the service with an empty string "" for the namespace name, the cluster configuration for Service Connect is removed. Note that the namespace will remain in Cloud Map and must be deleted separately.

For more information about Cloud Map, see Working with Services in the /Cloud Map Developer Guide/.

ClusterSetting

clusterSetting_name :: Lens' ClusterSetting (Maybe ClusterSettingName)

The name of the cluster setting. The only supported value is containerInsights.

clusterSetting_value :: Lens' ClusterSetting (Maybe Text)

The value to set for the cluster setting. The supported values are enabled and disabled. If enabled is specified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be disabled unless the containerInsights account setting is enabled. If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

Container

container_containerArn :: Lens' Container (Maybe Text)

The Amazon Resource Name (ARN) of the container.

container_cpu :: Lens' Container (Maybe Text)

The number of CPU units set for the container. The value is 0 if no value was specified in the container definition when the task definition was registered.

container_exitCode :: Lens' Container (Maybe Int)

The exit code returned from the container.

container_gpuIds :: Lens' Container (Maybe [Text])

The IDs of each GPU assigned to the container.

container_healthStatus :: Lens' Container (Maybe HealthStatus)

The health status of the container. If health checks aren't configured for this container in its task definition, then it reports the health status as UNKNOWN.

container_image :: Lens' Container (Maybe Text)

The image used for the container.

container_imageDigest :: Lens' Container (Maybe Text)

The container image manifest digest.

The imageDigest is only returned if the container is using an image hosted in Amazon ECR, otherwise it is omitted.

container_lastStatus :: Lens' Container (Maybe Text)

The last known status of the container.

container_managedAgents :: Lens' Container (Maybe [ManagedAgent])

The details of any Amazon ECS managed agents associated with the container.

container_memory :: Lens' Container (Maybe Text)

The hard limit (in MiB) of memory set for the container.

container_memoryReservation :: Lens' Container (Maybe Text)

The soft limit (in MiB) of memory set for the container.

container_name :: Lens' Container (Maybe Text)

The name of the container.

container_networkBindings :: Lens' Container (Maybe [NetworkBinding])

The network bindings associated with the container.

container_networkInterfaces :: Lens' Container (Maybe [NetworkInterface])

The network interfaces associated with the container.

container_reason :: Lens' Container (Maybe Text)

A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

container_runtimeId :: Lens' Container (Maybe Text)

The ID of the Docker container.

container_taskArn :: Lens' Container (Maybe Text)

The ARN of the task.

ContainerDefinition

containerDefinition_command :: Lens' ContainerDefinition (Maybe [Text])

The command that's passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument is a separated string in the array.

containerDefinition_cpu :: Lens' ContainerDefinition (Maybe Int)

The number of cpu units reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run.

This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level cpu value.

You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.

Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units.

On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn't required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:

• Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.
• Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.

On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as 0, which Windows interprets as 1% of one CPU.

containerDefinition_dependsOn :: Lens' ContainerDefinition (Maybe [ContainerDependency])

The dependencies defined for container startup and shutdown. A container can contain multiple dependencies on other containers in a task definition. When a dependency is defined for container startup, for container shutdown it is reversed.

For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

For tasks using the Fargate launch type, the task or service requires the following platforms:

• Linux platform version 1.3.0 or later.
• Windows platform version 1.0.0 or later.

containerDefinition_disableNetworking :: Lens' ContainerDefinition (Maybe Bool)

When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API.

This parameter is not supported for Windows containers.

containerDefinition_dnsSearchDomains :: Lens' ContainerDefinition (Maybe [Text])

A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the --dns-search option to docker run.

This parameter is not supported for Windows containers.

containerDefinition_dnsServers :: Lens' ContainerDefinition (Maybe [Text])

A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the --dns option to docker run.

This parameter is not supported for Windows containers.

containerDefinition_dockerLabels :: Lens' ContainerDefinition (Maybe (HashMap Text Text))

A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the --label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

containerDefinition_dockerSecurityOptions :: Lens' ContainerDefinition (Maybe [Text])

A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field isn't valid for containers in tasks using the Fargate launch type.

With Windows containers, this parameter can be used to reference a credential spec file when configuring a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers in the Amazon Elastic Container Service Developer Guide.

This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the --security-opt option to docker run.

The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

For more information about valid values, see Docker Run Security Configuration.

Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"

containerDefinition_entryPoint :: Lens' ContainerDefinition (Maybe [Text])

Early versions of the Amazon ECS container agent don't properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.

The entry point that's passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.

containerDefinition_environment :: Lens' ContainerDefinition (Maybe [KeyValuePair])

The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.

We don't recommend that you use plaintext environment variables for sensitive information, such as credential data.

containerDefinition_environmentFiles :: Lens' ContainerDefinition (Maybe [EnvironmentFile])

A list of files containing the environment variables to pass to a container. This parameter maps to the --env-file option to docker run.

You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file contains an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored. For more information about the environment variable file syntax, see Declare default environment variables in file.

If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide.

containerDefinition_essential :: Lens' ContainerDefinition (Maybe Bool)

If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.

containerDefinition_extraHosts :: Lens' ContainerDefinition (Maybe [HostEntry])

A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the --add-host option to docker run.

This parameter isn't supported for Windows containers or tasks that use the awsvpc network mode.

containerDefinition_firelensConfiguration :: Lens' ContainerDefinition (Maybe FirelensConfiguration)

The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.

containerDefinition_healthCheck :: Lens' ContainerDefinition (Maybe HealthCheck)

The container health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the Create a container section of the Docker Remote API and the HEALTHCHECK parameter of docker run.

containerDefinition_hostname :: Lens' ContainerDefinition (Maybe Text)

The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run.

The hostname parameter is not supported if you're using the awsvpc network mode.

containerDefinition_image :: Lens' ContainerDefinition (Maybe Text)

The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

• When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks.
• Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag or registry/repository@digest. For example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE.
• Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).
• Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).
• Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).

containerDefinition_interactive :: Lens' ContainerDefinition (Maybe Bool)

When this parameter is true, you can deploy containerized applications that require stdin or a tty to be allocated. This parameter maps to OpenStdin in the Create a container section of the Docker Remote API and the --interactive option to docker run.

containerDefinition_links :: Lens' ContainerDefinition (Maybe [Text])

The links parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is bridge. The name:internalName construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This parameter maps to Links in the Create a container section of the Docker Remote API and the --link option to docker run.

This parameter is not supported for Windows containers.

Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.

containerDefinition_linuxParameters :: Lens' ContainerDefinition (Maybe LinuxParameters)

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities.

This parameter is not supported for Windows containers.

containerDefinition_logConfiguration :: Lens' ContainerDefinition (Maybe LogConfiguration)

The log configuration specification for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container can use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information about the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

containerDefinition_memory :: Lens' ContainerDefinition (Maybe Int)

The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task memory value, if one is specified. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.

If using the Fargate launch type, this parameter is optional.

If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level memory and memoryReservation value, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of memory is used.

The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.

The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.

containerDefinition_memoryReservation :: Lens' ContainerDefinition (Maybe Int)

The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the --memory-reservation option to docker run.

If a task-level memory value is not specified, you must specify a non-zero integer for one or both of memory or memoryReservation in a container definition. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of memory is used.

For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.

The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.

The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.

containerDefinition_mountPoints :: Lens' ContainerDefinition (Maybe [MountPoint])

The mount points for data volumes in your container.

This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives.

containerDefinition_name :: Lens' ContainerDefinition (Maybe Text)

The name of a container. If you're linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the --name option to docker run.

containerDefinition_portMappings :: Lens' ContainerDefinition (Maybe [PortMapping])

The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.

For task definitions that use the awsvpc network mode, only specify the containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

Port mappings on Windows use the NetNAT gateway address rather than localhost. There's no loopback for port mappings on Windows, so you can't access a container's mapped port from the host itself.

This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run. If the network mode of a task definition is set to none, then you can't specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping.

After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings section DescribeTasks responses.

containerDefinition_privileged :: Lens' ContainerDefinition (Maybe Bool)

When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.

This parameter is not supported for Windows containers or tasks run on Fargate.

containerDefinition_pseudoTerminal :: Lens' ContainerDefinition (Maybe Bool)

When this parameter is true, a TTY is allocated. This parameter maps to Tty in the Create a container section of the Docker Remote API and the --tty option to docker run.

containerDefinition_readonlyRootFilesystem :: Lens' ContainerDefinition (Maybe Bool)

When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.

This parameter is not supported for Windows containers.

containerDefinition_repositoryCredentials :: Lens' ContainerDefinition (Maybe RepositoryCredentials)

The private repository authentication credentials to use.

containerDefinition_resourceRequirements :: Lens' ContainerDefinition (Maybe [ResourceRequirement])

The type and amount of a resource to assign to a container. The only supported resource is a GPU.

containerDefinition_secrets :: Lens' ContainerDefinition (Maybe [Secret])

The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

containerDefinition_startTimeout :: Lens' ContainerDefinition (Maybe Int)

Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a COMPLETE, SUCCESS, or HEALTHY status. If a startTimeout value is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to a STOPPED state.

When the ECS_CONTAINER_START_TIMEOUT container agent configuration variable is used, it's enforced independently from this start timeout value.

For tasks using the Fargate launch type, the task or service requires the following platforms:

• Linux platform version 1.3.0 or later.
• Windows platform version 1.0.0 or later.

For tasks using the EC2 launch type, your container instances require at least version 1.26.0 of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

containerDefinition_stopTimeout :: Lens' ContainerDefinition (Maybe Int)

Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.

For tasks using the Fargate launch type, the task or service requires the following platforms:

• Linux platform version 1.3.0 or later.
• Windows platform version 1.0.0 or later.

The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.

For tasks that use the EC2 launch type, if the stopTimeout parameter isn't specified, the value set for the Amazon ECS container agent configuration variable ECS_CONTAINER_STOP_TIMEOUT is used. If neither the stopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

containerDefinition_systemControls :: Lens' ContainerDefinition (Maybe [SystemControl])

A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run.

We don't recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network modes. For tasks that use the awsvpc network mode, the container that's started last determines which systemControls parameters take effect. For tasks that use the host network mode, it changes the container instance's namespaced kernel parameters as well as the containers.

containerDefinition_ulimits :: Lens' ContainerDefinition (Maybe [Ulimit])

A list of ulimits to set in the container. If a ulimit value is specified in a task definition, it overrides the default values set by Docker. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run. Valid naming values are displayed in the Ulimit data type.

Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and hard limit is 4096.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

This parameter is not supported for Windows containers.

containerDefinition_user :: Lens' ContainerDefinition (Maybe Text)

The user to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.

When running tasks using the host network mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security.

You can specify the user using the following formats. If specifying a UID or GID, you must specify it as a positive integer.

• user

• user:group

• uid

• uid:gid

• user:gid

• uid:group

This parameter is not supported for Windows containers.

containerDefinition_volumesFrom :: Lens' ContainerDefinition (Maybe [VolumeFrom])

Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the --volumes-from option to docker run.

containerDefinition_workingDirectory :: Lens' ContainerDefinition (Maybe Text)

The working directory to run commands inside the container in. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the --workdir option to docker run.

ContainerDependency

containerDependency_containerName :: Lens' ContainerDependency Text

The name of a container.

containerDependency_condition :: Lens' ContainerDependency ContainerCondition

The dependency condition of the container. The following are the available conditions and their behavior:

• START - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.
• COMPLETE - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container.
• SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status. This condition can't be set on an essential container.
• HEALTHY - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.

ContainerInstance

containerInstance_agentConnected :: Lens' ContainerInstance (Maybe Bool)

This parameter returns true if the agent is connected to Amazon ECS. An instance with an agent that may be unhealthy or stopped return false. Only instances connected to an agent can accept task placement requests.

containerInstance_agentUpdateStatus :: Lens' ContainerInstance (Maybe AgentUpdateStatus)

The status of the most recent agent update. If an update wasn't ever requested, this value is NULL.

containerInstance_attachments :: Lens' ContainerInstance (Maybe [Attachment])

The resources attached to a container instance, such as an elastic network interface.

containerInstance_attributes :: Lens' ContainerInstance (Maybe [Attribute])

The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.

containerInstance_capacityProviderName :: Lens' ContainerInstance (Maybe Text)

The capacity provider that's associated with the container instance.

containerInstance_containerInstanceArn :: Lens' ContainerInstance (Maybe Text)

The Amazon Resource Name (ARN) of the container instance. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

containerInstance_ec2InstanceId :: Lens' ContainerInstance (Maybe Text)

The ID of the container instance. For Amazon EC2 instances, this value is the Amazon EC2 instance ID. For external instances, this value is the Amazon Web Services Systems Manager managed instance ID.

containerInstance_healthStatus :: Lens' ContainerInstance (Maybe ContainerInstanceHealthStatus)

An object representing the health status of the container instance.

containerInstance_pendingTasksCount :: Lens' ContainerInstance (Maybe Int)

The number of tasks on the container instance that are in the PENDING status.

containerInstance_registeredAt :: Lens' ContainerInstance (Maybe UTCTime)

The Unix timestamp for the time when the container instance was registered.

containerInstance_registeredResources :: Lens' ContainerInstance (Maybe [Resource])

For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.

containerInstance_remainingResources :: Lens' ContainerInstance (Maybe [Resource])

For CPU and memory resource types, this parameter describes the remaining CPU and memory that wasn't already allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the host or bridge network mode). Any port that's not specified here is available for new tasks.

containerInstance_runningTasksCount :: Lens' ContainerInstance (Maybe Int)

The number of tasks on the container instance that are in the RUNNING status.

containerInstance_status :: Lens' ContainerInstance (Maybe Text)

The status of the container instance. The valid values are REGISTERING, REGISTRATION_FAILED, ACTIVE, INACTIVE, DEREGISTERING, or DRAINING.

If your account has opted in to the awsvpcTrunking account setting, then any newly registered container instance will transition to a REGISTERING status while the trunk elastic network interface is provisioned for the instance. If the registration fails, the instance will transition to a REGISTRATION_FAILED status. You can describe the container instance and see the reason for failure in the statusReason parameter. Once the container instance is terminated, the instance transitions to a DEREGISTERING status while the trunk elastic network interface is deprovisioned. The instance then transitions to an INACTIVE status.

The ACTIVE status indicates that the container instance can accept tasks. The DRAINING indicates that new tasks aren't placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container instance draining in the Amazon Elastic Container Service Developer Guide.

containerInstance_statusReason :: Lens' ContainerInstance (Maybe Text)

The reason that the container instance reached its current status.

containerInstance_tags :: Lens' ContainerInstance (Maybe [Tag])

The metadata that you apply to the container instance 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.

containerInstance_version :: Lens' ContainerInstance (Maybe Integer)

The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you're replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the detail object) to verify that the version in your event stream is current.

containerInstance_versionInfo :: Lens' ContainerInstance (Maybe VersionInfo)

The version information for the Amazon ECS container agent and Docker daemon running on the container instance.

ContainerInstanceHealthStatus

containerInstanceHealthStatus_details :: Lens' ContainerInstanceHealthStatus (Maybe [InstanceHealthCheckResult])

An array of objects representing the details of the container instance health status.

containerInstanceHealthStatus_overallStatus :: Lens' ContainerInstanceHealthStatus (Maybe InstanceHealthCheckState)

The overall health status of the container instance. This is an aggregate status of all container instance health checks.

ContainerOverride

containerOverride_command :: Lens' ContainerOverride (Maybe [Text])

The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.

containerOverride_cpu :: Lens' ContainerOverride (Maybe Int)

The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.

containerOverride_environment :: Lens' ContainerOverride (Maybe [KeyValuePair])

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.

containerOverride_environmentFiles :: Lens' ContainerOverride (Maybe [EnvironmentFile])

A list of files containing the environment variables to pass to a container, instead of the value from the container definition.

containerOverride_memory :: Lens' ContainerOverride (Maybe Int)

The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.

containerOverride_memoryReservation :: Lens' ContainerOverride (Maybe Int)

The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.

containerOverride_name :: Lens' ContainerOverride (Maybe Text)

The name of the container that receives the override. This parameter is required if any override is specified.

containerOverride_resourceRequirements :: Lens' ContainerOverride (Maybe [ResourceRequirement])

The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.

ContainerService

containerService_capacityProviderStrategy :: Lens' ContainerService (Maybe [CapacityProviderStrategyItem])

The capacity provider strategy the service uses. When using the DescribeServices API, this field is omitted if the service was created using a launch type.

containerService_clusterArn :: Lens' ContainerService (Maybe Text)

The Amazon Resource Name (ARN) of the cluster that hosts the service.

containerService_createdAt :: Lens' ContainerService (Maybe UTCTime)

The Unix timestamp for the time when the service was created.

containerService_createdBy :: Lens' ContainerService (Maybe Text)

The principal that created the service.

containerService_deploymentConfiguration :: Lens' ContainerService (Maybe DeploymentConfiguration)

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

containerService_deploymentController :: Lens' ContainerService (Maybe DeploymentController)

The deployment controller type the service is using.

containerService_deployments :: Lens' ContainerService (Maybe [Deployment])

The current state of deployments for the service.

containerService_desiredCount :: Lens' ContainerService (Maybe Int)

The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

containerService_enableECSManagedTags :: Lens' ContainerService (Maybe Bool)

Determines whether to use Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

containerService_enableExecuteCommand :: Lens' ContainerService (Maybe Bool)

Determines whether the execute command functionality is enabled for the service. If true, the execute command functionality is enabled for all containers in tasks as part of the service.

containerService_events :: Lens' ContainerService (Maybe [ServiceEvent])

The event stream for your service. A maximum of 100 of the latest events are displayed.

containerService_healthCheckGracePeriodSeconds :: Lens' ContainerService (Maybe Int)

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.

containerService_launchType :: Lens' ContainerService (Maybe LaunchType)

The launch type the service is using. When using the DescribeServices API, this field is omitted if the service was created using a capacity provider strategy.

containerService_loadBalancers :: Lens' ContainerService (Maybe [LoadBalancer])

A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.

containerService_networkConfiguration :: Lens' ContainerService (Maybe NetworkConfiguration)

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

containerService_pendingCount :: Lens' ContainerService (Maybe Int)

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

containerService_placementConstraints :: Lens' ContainerService (Maybe [PlacementConstraint])

The placement constraints for the tasks in the service.

containerService_placementStrategy :: Lens' ContainerService (Maybe [PlacementStrategy])

The placement strategy that determines how tasks for the service are placed.

containerService_platformFamily :: Lens' ContainerService (Maybe Text)

The operating system that your tasks in the service run on. A platform family is specified only for tasks using the Fargate launch type.

All tasks that run as part of this service must use the same platformFamily value as the service (for example, LINUX).

containerService_platformVersion :: Lens' ContainerService (Maybe Text)

The platform version to run your service on. A platform version is only specified for tasks that are hosted on Fargate. If one isn't specified, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

containerService_propagateTags :: Lens' ContainerService (Maybe PropagateTags)

Determines whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.

containerService_roleArn :: Lens' ContainerService (Maybe Text)

The ARN of the IAM role that's associated with the service. It allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

containerService_runningCount :: Lens' ContainerService (Maybe Int)

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

containerService_schedulingStrategy :: Lens' ContainerService (Maybe SchedulingStrategy)

The scheduling strategy to use for the service. For more information, see Services.

There are two service scheduler strategies available.

• REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.

• DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance. This task meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It stop tasks that don't meet the placement constraints.

  Fargate tasks don't support the DAEMON scheduling strategy.

containerService_serviceArn :: Lens' ContainerService (Maybe Text)

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

containerService_serviceName :: Lens' ContainerService (Maybe Text)

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster. However, you can have similarly named services in multiple clusters within a Region or across multiple Regions.

containerService_serviceRegistries :: Lens' ContainerService (Maybe [ServiceRegistry])

The details for the service discovery registries to assign to this service. For more information, see Service Discovery.

containerService_status :: Lens' ContainerService (Maybe Text)

The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.

containerService_tags :: Lens' ContainerService (Maybe [Tag])

The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value. You define bot the key and value.

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.

containerService_taskDefinition :: Lens' ContainerService (Maybe Text)

The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

containerService_taskSets :: Lens' ContainerService (Maybe [TaskSet])

Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.

ContainerStateChange

containerStateChange_containerName :: Lens' ContainerStateChange (Maybe Text)

The name of the container.

containerStateChange_exitCode :: Lens' ContainerStateChange (Maybe Int)

The exit code for the container, if the state change is a result of the container exiting.

containerStateChange_imageDigest :: Lens' ContainerStateChange (Maybe Text)

The container image SHA 256 digest.

containerStateChange_networkBindings :: Lens' ContainerStateChange (Maybe [NetworkBinding])

Any network bindings that are associated with the container.

containerStateChange_reason :: Lens' ContainerStateChange (Maybe Text)

The reason for the state change.

containerStateChange_runtimeId :: Lens' ContainerStateChange (Maybe Text)

The ID of the Docker container.

containerStateChange_status :: Lens' ContainerStateChange (Maybe Text)

The status of the container.

Deployment

deployment_capacityProviderStrategy :: Lens' Deployment (Maybe [CapacityProviderStrategyItem])

The capacity provider strategy that the deployment is using.

deployment_createdAt :: Lens' Deployment (Maybe UTCTime)

The Unix timestamp for the time when the service deployment was created.

deployment_desiredCount :: Lens' Deployment (Maybe Int)

The most recent desired count of tasks that was specified for the service to deploy or maintain.

deployment_failedTasks :: Lens' Deployment (Maybe Int)

The number of consecutively failed tasks in the deployment. A task is considered a failure if the service scheduler can't launch the task, the task doesn't transition to a RUNNING state, or if it fails any of its defined health checks and is stopped.

Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.

deployment_id :: Lens' Deployment (Maybe Text)

The ID of the deployment.

deployment_launchType :: Lens' Deployment (Maybe LaunchType)

The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

deployment_networkConfiguration :: Lens' Deployment (Maybe NetworkConfiguration)

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

deployment_pendingCount :: Lens' Deployment (Maybe Int)

The number of tasks in the deployment that are in the PENDING status.

deployment_platformFamily :: Lens' Deployment (Maybe Text)

The operating system that your tasks in the service, or tasks are running on. A platform family is specified only for tasks using the Fargate launch type.

All tasks that run as part of this service must use the same platformFamily value as the service, for example, LINUX..

deployment_platformVersion :: Lens' Deployment (Maybe Text)

The platform version that your tasks in the service run on. A platform version is only specified for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

deployment_rolloutState :: Lens' Deployment (Maybe DeploymentRolloutState)

The rolloutState of a service is only returned for services that use the rolling update (ECS) deployment type that aren't behind a Classic Load Balancer.

The rollout state of the deployment. When a service deployment is started, it begins in an IN_PROGRESS state. When the service reaches a steady state, the deployment transitions to a COMPLETED state. If the service fails to reach a steady state and circuit breaker is enabled, the deployment transitions to a FAILED state. A deployment in FAILED state doesn't launch any new tasks. For more information, see DeploymentCircuitBreaker.

deployment_rolloutStateReason :: Lens' Deployment (Maybe Text)

A description of the rollout state of a deployment.

deployment_runningCount :: Lens' Deployment (Maybe Int)

The number of tasks in the deployment that are in the RUNNING status.

deployment_serviceConnectConfiguration :: Lens' Deployment (Maybe ServiceConnectConfiguration)

The details of the Service Connect configuration that's used by this deployment. Compare the configuration between multiple deployments when troubleshooting issues with new deployments.

The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

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.

deployment_serviceConnectResources :: Lens' Deployment (Maybe [ServiceConnectServiceResource])

The list of Service Connect resources that are associated with this deployment. Each list entry maps a discovery name to a Cloud Map service name.

deployment_status :: Lens' Deployment (Maybe Text)

The status of the deployment. The following describes each state.

PRIMARY

The most recent deployment of a service.

ACTIVE

A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.

INACTIVE

A deployment that has been completely replaced.

deployment_taskDefinition :: Lens' Deployment (Maybe Text)

The most recent task definition that was specified for the tasks in the service to use.

deployment_updatedAt :: Lens' Deployment (Maybe UTCTime)

The Unix timestamp for the time when the service deployment was last updated.

DeploymentAlarms

deploymentAlarms_alarmNames :: Lens' DeploymentAlarms [Text]

One or more CloudWatch alarm names. Use a "," to separate the alarms.

deploymentAlarms_enable :: Lens' DeploymentAlarms Bool

Determines whether to use the CloudWatch alarm option in the service deployment process.

deploymentAlarms_rollback :: Lens' DeploymentAlarms Bool

Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

DeploymentCircuitBreaker

deploymentCircuitBreaker_enable :: Lens' DeploymentCircuitBreaker Bool

Determines whether to use the deployment circuit breaker logic for the service.

deploymentCircuitBreaker_rollback :: Lens' DeploymentCircuitBreaker Bool

Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

DeploymentConfiguration

deploymentConfiguration_alarms :: Lens' DeploymentConfiguration (Maybe DeploymentAlarms)

Information about the CloudWatch alarms.

deploymentConfiguration_deploymentCircuitBreaker :: Lens' DeploymentConfiguration (Maybe DeploymentCircuitBreaker)

The deployment circuit breaker can only be used for services using the rolling update (ECS) deployment type.

The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If deployment circuit breaker is enabled, a service deployment will transition to a failed state and stop launching new tasks. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

deploymentConfiguration_maximumPercent :: Lens' DeploymentConfiguration (Maybe Int)

If a service is using the rolling update (ECS) deployment type, the maximumPercent parameter represents an upper limit on the number of your service's tasks that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desiredCount (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using the REPLICA service scheduler and has a desiredCount of four tasks and a maximumPercent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default maximumPercent value for a service using the REPLICA service scheduler is 200%.

If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.

deploymentConfiguration_minimumHealthyPercent :: Lens' DeploymentConfiguration (Maybe Int)

If a service is using the rolling update (ECS) deployment type, the minimumHealthyPercent represents a lower limit on the number of your service's tasks that must remain in the RUNNING state during a deployment, as a percentage of the desiredCount (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desiredCount of four tasks and a minimumHealthyPercent of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks.

For services that do not use a load balancer, the following should be noted:

• A service is considered healthy if all essential containers within the tasks in the service pass their health checks.
• If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a RUNNING state before the task is counted towards the minimum healthy percent total.
• If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings.

For services are that do use a load balancer, the following should be noted:

• If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
• If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.

If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and is running tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.

DeploymentController

deploymentController_type :: Lens' DeploymentController DeploymentControllerType

The deployment controller type to use.

There are three deployment controller types available:

ECS

The rolling update (ECS) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration.

CODE_DEPLOY

The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it.

EXTERNAL

The external (EXTERNAL) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.

Device

device_containerPath :: Lens' Device (Maybe Text)

The path inside the container at which to expose the host device.

device_permissions :: Lens' Device (Maybe [DeviceCgroupPermission])

The explicit permissions to provide to the container for the device. By default, the container has permissions for read, write, and mknod for the device.

device_hostPath :: Lens' Device Text

The path for the device on the host container instance.

DockerVolumeConfiguration

dockerVolumeConfiguration_autoprovision :: Lens' DockerVolumeConfiguration (Maybe Bool)

If this value is true, the Docker volume is created if it doesn't already exist.

This field is only used if the scope is shared.

dockerVolumeConfiguration_driver :: Lens' DockerVolumeConfiguration (Maybe Text)

The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps to Driver in the Create a volume section of the Docker Remote API and the xxdriver option to docker volume create.

dockerVolumeConfiguration_driverOpts :: Lens' DockerVolumeConfiguration (Maybe (HashMap Text Text))

A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to docker volume create.

dockerVolumeConfiguration_labels :: Lens' DockerVolumeConfiguration (Maybe (HashMap Text Text))

Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to docker volume create.

dockerVolumeConfiguration_scope :: Lens' DockerVolumeConfiguration (Maybe Scope)

The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.

EFSAuthorizationConfig

eFSAuthorizationConfig_accessPointId :: Lens' EFSAuthorizationConfig (Maybe Text)

The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the EFSVolumeConfiguration must either be omitted or set to / which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide.

eFSAuthorizationConfig_iam :: Lens' EFSAuthorizationConfig (Maybe EFSAuthorizationConfigIAM)

Determines whether to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS access points in the Amazon Elastic Container Service Developer Guide.

EFSVolumeConfiguration

eFSVolumeConfiguration_authorizationConfig :: Lens' EFSVolumeConfiguration (Maybe EFSAuthorizationConfig)

The authorization configuration details for the Amazon EFS file system.

eFSVolumeConfiguration_rootDirectory :: Lens' EFSVolumeConfiguration (Maybe Text)

The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying / will have the same effect as omitting this parameter.

If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to / which will enforce the path set on the EFS access point.

eFSVolumeConfiguration_transitEncryption :: Lens' EFSVolumeConfiguration (Maybe EFSTransitEncryption)

Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.

eFSVolumeConfiguration_transitEncryptionPort :: Lens' EFSVolumeConfiguration (Maybe Int)

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.

eFSVolumeConfiguration_fileSystemId :: Lens' EFSVolumeConfiguration Text

The Amazon EFS file system ID to use.

EnvironmentFile

environmentFile_value :: Lens' EnvironmentFile Text

The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.

environmentFile_type :: Lens' EnvironmentFile EnvironmentFileType

The file type to use. The only supported value is s3.

EphemeralStorage

ephemeralStorage_sizeInGiB :: Lens' EphemeralStorage Int

The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.

ExecuteCommandConfiguration

executeCommandConfiguration_kmsKeyId :: Lens' ExecuteCommandConfiguration (Maybe Text)

Specify an Key Management Service key ID to encrypt the data between the local client and the container.

executeCommandConfiguration_logConfiguration :: Lens' ExecuteCommandConfiguration (Maybe ExecuteCommandLogConfiguration)

The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When logging=OVERRIDE is specified, a logConfiguration must be provided.

executeCommandConfiguration_logging :: Lens' ExecuteCommandConfiguration (Maybe ExecuteCommandLogging)

The log setting to use for redirecting logs for your execute command results. The following log settings are available.

• NONE: The execute command session is not logged.
• DEFAULT: The awslogs configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no awslogs log driver is configured in the task definition, the output won't be logged.
• OVERRIDE: Specify the logging details as a part of logConfiguration. If the OVERRIDE logging option is specified, the logConfiguration is required.

ExecuteCommandLogConfiguration

executeCommandLogConfiguration_cloudWatchEncryptionEnabled :: Lens' ExecuteCommandLogConfiguration (Maybe Bool)

Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be disabled.

executeCommandLogConfiguration_cloudWatchLogGroupName :: Lens' ExecuteCommandLogConfiguration (Maybe Text)

The name of the CloudWatch log group to send logs to.

The CloudWatch log group must already be created.

executeCommandLogConfiguration_s3BucketName :: Lens' ExecuteCommandLogConfiguration (Maybe Text)

The name of the S3 bucket to send logs to.

The S3 bucket must already be created.

executeCommandLogConfiguration_s3EncryptionEnabled :: Lens' ExecuteCommandLogConfiguration (Maybe Bool)

Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.

executeCommandLogConfiguration_s3KeyPrefix :: Lens' ExecuteCommandLogConfiguration (Maybe Text)

An optional folder in the S3 bucket to place logs in.

FSxWindowsFileServerAuthorizationConfig

fSxWindowsFileServerAuthorizationConfig_credentialsParameter :: Lens' FSxWindowsFileServerAuthorizationConfig Text

The authorization credential option to use. The authorization credential options can be provided using either the Amazon Resource Name (ARN) of an Secrets Manager secret or SSM Parameter Store parameter. The ARN refers to the stored credentials.

fSxWindowsFileServerAuthorizationConfig_domain :: Lens' FSxWindowsFileServerAuthorizationConfig Text

A fully qualified domain name hosted by an Directory Service Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2.

FSxWindowsFileServerVolumeConfiguration

fSxWindowsFileServerVolumeConfiguration_fileSystemId :: Lens' FSxWindowsFileServerVolumeConfiguration Text

The Amazon FSx for Windows File Server file system ID to use.

fSxWindowsFileServerVolumeConfiguration_rootDirectory :: Lens' FSxWindowsFileServerVolumeConfiguration Text

The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.

fSxWindowsFileServerVolumeConfiguration_authorizationConfig :: Lens' FSxWindowsFileServerVolumeConfiguration FSxWindowsFileServerAuthorizationConfig

The authorization configuration details for the Amazon FSx for Windows File Server file system.

Failure

failure_arn :: Lens' Failure (Maybe Text)

The Amazon Resource Name (ARN) of the failed resource.

failure_detail :: Lens' Failure (Maybe Text)

The details of the failure.

failure_reason :: Lens' Failure (Maybe Text)

The reason for the failure.

FirelensConfiguration

firelensConfiguration_options :: Lens' FirelensConfiguration (Maybe (HashMap Text Text))

The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}. For more information, see Creating a task definition that uses a FireLens configuration in the Amazon Elastic Container Service Developer Guide.

Tasks hosted on Fargate only support the file configuration file type.

firelensConfiguration_type :: Lens' FirelensConfiguration FirelensConfigurationType

The log router to use. The valid values are fluentd or fluentbit.

HealthCheck

healthCheck_interval :: Lens' HealthCheck (Maybe Int)

The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.

healthCheck_retries :: Lens' HealthCheck (Maybe Int)

The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.

healthCheck_startPeriod :: Lens' HealthCheck (Maybe Int)

The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the startPeriod is disabled.

If a health check succeeds within the startPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.

healthCheck_timeout :: Lens' HealthCheck (Maybe Int)

The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.

healthCheck_command :: Lens' HealthCheck [Text]

A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD to run the command arguments directly, or CMD-SHELL to run the command with the container's default shell.

When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, enclose the list of commands in brackets.

[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]

You don't need to include the brackets when you use the Amazon Web Services Management Console.

 "CMD-SHELL", "curl -f http://localhost/ || exit 1"

An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck in the Create a container section of the Docker Remote API.

HostEntry

hostEntry_hostname :: Lens' HostEntry Text

The hostname to use in the /etc/hosts entry.

hostEntry_ipAddress :: Lens' HostEntry Text

The IP address to use in the /etc/hosts entry.

HostVolumeProperties

hostVolumeProperties_sourcePath :: Lens' HostVolumeProperties (Maybe Text)

When the host parameter is used, specify a sourcePath to declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

If you're using the Fargate launch type, the sourcePath parameter is not supported.

InferenceAccelerator

inferenceAccelerator_deviceName :: Lens' InferenceAccelerator Text

The Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement.

inferenceAccelerator_deviceType :: Lens' InferenceAccelerator Text

The Elastic Inference accelerator type to use.

InferenceAcceleratorOverride

inferenceAcceleratorOverride_deviceName :: Lens' InferenceAcceleratorOverride (Maybe Text)

The Elastic Inference accelerator device name to override for the task. This parameter must match a deviceName specified in the task definition.

inferenceAcceleratorOverride_deviceType :: Lens' InferenceAcceleratorOverride (Maybe Text)

The Elastic Inference accelerator type to use.

InstanceHealthCheckResult

instanceHealthCheckResult_lastStatusChange :: Lens' InstanceHealthCheckResult (Maybe UTCTime)

The Unix timestamp for when the container instance health status last changed.

instanceHealthCheckResult_lastUpdated :: Lens' InstanceHealthCheckResult (Maybe UTCTime)

The Unix timestamp for when the container instance health status was last updated.

instanceHealthCheckResult_status :: Lens' InstanceHealthCheckResult (Maybe InstanceHealthCheckState)

The container instance health status.

instanceHealthCheckResult_type :: Lens' InstanceHealthCheckResult (Maybe InstanceHealthCheckType)

The type of container instance health status that was verified.

KernelCapabilities

kernelCapabilities_add :: Lens' KernelCapabilities (Maybe [Text])

The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to CapAdd in the Create a container section of the Docker Remote API and the --cap-add option to docker run.

Tasks launched on Fargate only support adding the SYS_PTRACE kernel capability.

Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"

kernelCapabilities_drop :: Lens' KernelCapabilities (Maybe [Text])

The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to CapDrop in the Create a container section of the Docker Remote API and the --cap-drop option to docker run.

Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"

KeyValuePair

keyValuePair_name :: Lens' KeyValuePair (Maybe Text)

The name of the key-value pair. For environment variables, this is the name of the environment variable.

keyValuePair_value :: Lens' KeyValuePair (Maybe Text)

The value of the key-value pair. For environment variables, this is the value of the environment variable.

LinuxParameters

linuxParameters_capabilities :: Lens' LinuxParameters (Maybe KernelCapabilities)

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.

For tasks that use the Fargate launch type, capabilities is supported for all platform versions but the add parameter is only supported if using platform version 1.4.0 or later.

linuxParameters_devices :: Lens' LinuxParameters (Maybe [Device])

Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.

If you're using tasks that use the Fargate launch type, the devices parameter isn't supported.

linuxParameters_initProcessEnabled :: Lens' LinuxParameters (Maybe Bool)

Run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

linuxParameters_maxSwap :: Lens' LinuxParameters (Maybe Int)

The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the --memory-swap option to docker run where the value would be the sum of the container memory plus the maxSwap value.

If a maxSwap value of 0 is specified, the container will not use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container will use the swap configuration for the container instance it is running on. A maxSwap value must be set for the swappiness parameter to be used.

If you're using tasks that use the Fargate launch type, the maxSwap parameter isn't supported.

linuxParameters_sharedMemorySize :: Lens' LinuxParameters (Maybe Int)

The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.

If you are using tasks that use the Fargate launch type, the sharedMemorySize parameter is not supported.

linuxParameters_swappiness :: Lens' LinuxParameters (Maybe Int)

This allows you to tune a container's memory swappiness behavior. A swappiness value of 0 will cause swapping to not happen unless absolutely necessary. A swappiness value of 100 will cause pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter is not specified, a default value of 60 is used. If a value is not specified for maxSwap then this parameter is ignored. This parameter maps to the --memory-swappiness option to docker run.

If you're using tasks that use the Fargate launch type, the swappiness parameter isn't supported.

linuxParameters_tmpfs :: Lens' LinuxParameters (Maybe [Tmpfs])

The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.

If you're using tasks that use the Fargate launch type, the tmpfs parameter isn't supported.

LoadBalancer

loadBalancer_containerName :: Lens' LoadBalancer (Maybe Text)

The name of the container (as it appears in a container definition) to associate with the load balancer.

loadBalancer_containerPort :: Lens' LoadBalancer (Maybe Int)

The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on the hostPort of the port mapping.

loadBalancer_loadBalancerName :: Lens' LoadBalancer (Maybe Text)

The name of the load balancer to associate with the Amazon ECS service or task set.

A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.

loadBalancer_targetGroupArn :: Lens' LoadBalancer (Maybe Text)

The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.

A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you're using a Classic Load Balancer, omit the target group ARN.

For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

For services using the CODE_DEPLOY deployment controller, you're required to define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.

If your service's task definition uses the awsvpc network mode, you must choose ip as the target type, not instance. Do this when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.

LogConfiguration

logConfiguration_options :: Lens' LogConfiguration (Maybe (HashMap Text Text))

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

logConfiguration_secretOptions :: Lens' LogConfiguration (Maybe [Secret])

The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.

logConfiguration_logDriver :: Lens' LogConfiguration LogDriver

The log driver to use for the container.

For tasks on Fargate, the supported log drivers are awslogs, splunk, and awsfirelens.

For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens.

For more information about using the awslogs log driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide.

For more information about using the awsfirelens log driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide.

If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software.

ManagedAgent

managedAgent_lastStartedAt :: Lens' ManagedAgent (Maybe UTCTime)

The Unix timestamp for the time when the managed agent was last started.

managedAgent_lastStatus :: Lens' ManagedAgent (Maybe Text)

The last known status of the managed agent.

managedAgent_name :: Lens' ManagedAgent (Maybe ManagedAgentName)

The name of the managed agent. When the execute command feature is enabled, the managed agent name is ExecuteCommandAgent.

managedAgent_reason :: Lens' ManagedAgent (Maybe Text)

The reason for why the managed agent is in the state it is in.

ManagedAgentStateChange

managedAgentStateChange_reason :: Lens' ManagedAgentStateChange (Maybe Text)

The reason for the status of the managed agent.

managedAgentStateChange_containerName :: Lens' ManagedAgentStateChange Text

The name of the container that's associated with the managed agent.

managedAgentStateChange_managedAgentName :: Lens' ManagedAgentStateChange ManagedAgentName

The name of the managed agent.

managedAgentStateChange_status :: Lens' ManagedAgentStateChange Text

The status of the managed agent.

ManagedScaling

managedScaling_instanceWarmupPeriod :: Lens' ManagedScaling (Maybe Natural)

The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics for Auto Scaling group. If this parameter is omitted, the default value of 300 seconds is used.

managedScaling_maximumScalingStepSize :: Lens' ManagedScaling (Maybe Natural)

The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter. If this parameter is omitted, the default value of 1 is used.

managedScaling_minimumScalingStepSize :: Lens' ManagedScaling (Maybe Natural)

The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter If this parameter is omitted, the default value of 1 is used.

When additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the actual demand is less than the minimum scaling step size.

If you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value and will ignore both the maximum scaling step size as well as the capacity demand.

managedScaling_status :: Lens' ManagedScaling (Maybe ManagedScalingStatus)

Determines whether to use managed scaling for the capacity provider.

managedScaling_targetCapacity :: Lens' ManagedScaling (Maybe Natural)

The target capacity value for the capacity provider. The specified value must be greater than 0 and less than or equal to 100. A value of 100 results in the Amazon EC2 instances in your Auto Scaling group being completely used.

MountPoint

mountPoint_containerPath :: Lens' MountPoint (Maybe Text)

The path on the container to mount the host volume at.

mountPoint_readOnly :: Lens' MountPoint (Maybe Bool)

If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.

mountPoint_sourceVolume :: Lens' MountPoint (Maybe Text)

The name of the volume to mount. Must be a volume name referenced in the name parameter of task definition volume.

NetworkBinding

networkBinding_bindIP :: Lens' NetworkBinding (Maybe Text)

The IP address that the container is bound to on the container instance.

networkBinding_containerPort :: Lens' NetworkBinding (Maybe Int)

The port number on the container that's used with the network binding.

networkBinding_containerPortRange :: Lens' NetworkBinding (Maybe Text)

The port number range on the container that's bound to the dynamically mapped host port range.

The following rules apply when you specify a containerPortRange:

• You must use either the bridge network mode or the awsvpc network mode.
• This parameter is available for both the EC2 and Fargate launch types.
• This parameter is available for both the Linux and Windows operating systems.
• The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the ecs-init package
• You can specify a maximum of 100 port ranges per container.

• You do not specify a hostPortRange. The value of the hostPortRange is set as follows:

  • For containers in a task with the awsvpc network mode, the hostPort is set to the same value as the containerPort. This is a static mapping strategy.
  • For containers in a task with the bridge network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.
• The containerPortRange valid values are between 1 and 65535.
• A port can only be included in one port mapping per container.
• You cannot specify overlapping port ranges.
• The first port in the range must be less than last port in the range.

• Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.

  For more information, see Issue #11185 on the Github website.

  For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.

You can call DescribeTasks to view the hostPortRange which are the host ports that are bound to the container ports.

networkBinding_hostPort :: Lens' NetworkBinding (Maybe Int)

The port number on the host that's used with the network binding.

networkBinding_hostPortRange :: Lens' NetworkBinding (Maybe Text)

The port number range on the host that's used with the network binding. This is assigned is assigned by Docker and delivered by the Amazon ECS agent.

networkBinding_protocol :: Lens' NetworkBinding (Maybe TransportProtocol)

The protocol used for the network binding.

NetworkConfiguration

networkConfiguration_awsvpcConfiguration :: Lens' NetworkConfiguration (Maybe AwsVpcConfiguration)

The VPC subnets and security groups that are associated with a task.

All specified subnets and security groups must be from the same VPC.

NetworkInterface

networkInterface_attachmentId :: Lens' NetworkInterface (Maybe Text)

The attachment ID for the network interface.

networkInterface_ipv6Address :: Lens' NetworkInterface (Maybe Text)

The private IPv6 address for the network interface.

networkInterface_privateIpv4Address :: Lens' NetworkInterface (Maybe Text)

The private IPv4 address for the network interface.

PlacementConstraint

placementConstraint_expression :: Lens' PlacementConstraint (Maybe Text)

A cluster query language expression to apply to the constraint. The expression can have a maximum length of 2000 characters. You can't specify an expression if the constraint type is distinctInstance. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.

placementConstraint_type :: Lens' PlacementConstraint (Maybe PlacementConstraintType)

The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.

PlacementStrategy

placementStrategy_field :: Lens' PlacementStrategy (Maybe Text)

The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that's applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.

placementStrategy_type :: Lens' PlacementStrategy (Maybe PlacementStrategyType)

The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that's specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task.

PlatformDevice

platformDevice_id :: Lens' PlatformDevice Text

The ID for the GPUs on the container instance. The available GPU IDs can also be obtained on the container instance in the /var/lib/ecs/gpu/nvidia_gpu_info.json file.

platformDevice_type :: Lens' PlatformDevice PlatformDeviceType

The type of device that's available on the container instance. The only supported value is GPU.

PortMapping

portMapping_appProtocol :: Lens' PortMapping (Maybe ApplicationProtocol)

The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch.

If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP.

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.

portMapping_containerPort :: Lens' PortMapping (Maybe Int)

The port number on the container that's bound to the user-specified or automatically assigned host port.

If you use containers in a task with the awsvpc or host network mode, specify the exposed ports using containerPort.

If you use containers in a task with the bridge network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see hostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.

portMapping_containerPortRange :: Lens' PortMapping (Maybe Text)

The port number range on the container that's bound to the dynamically mapped host port range.

The following rules apply when you specify a containerPortRange:

• You must use either the bridge network mode or the awsvpc network mode.
• This parameter is available for both the EC2 and Fargate launch types.
• This parameter is available for both the Linux and Windows operating systems.
• The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the ecs-init package
• You can specify a maximum of 100 port ranges per container.

• You do not specify a hostPortRange. The value of the hostPortRange is set as follows:

  • For containers in a task with the awsvpc network mode, the hostPort is set to the same value as the containerPort. This is a static mapping strategy.
  • For containers in a task with the bridge network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.
• The containerPortRange valid values are between 1 and 65535.
• A port can only be included in one port mapping per container.
• You cannot specify overlapping port ranges.
• The first port in the range must be less than last port in the range.

• Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.

  For more information, see Issue #11185 on the Github website.

  For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.

You can call DescribeTasks to view the hostPortRange which are the host ports that are bound to the container ports.

portMapping_hostPort :: Lens' PortMapping (Maybe Int)

The port number on the container instance to reserve for your container.

If you specify a containerPortRange, leave this field empty and the value of the hostPort is set as follows:

• For containers in a task with the awsvpc network mode, the hostPort is set to the same value as the containerPort. This is a static mapping strategy.
• For containers in a task with the bridge network mode, the Amazon ECS agent finds open ports on the host and automaticaly binds them to the container ports. This is a dynamic mapping strategy.

If you use containers in a task with the awsvpc or host network mode, the hostPort can either be left blank or set to the same value as the containerPort.

If you use containers in a task with the bridge network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0) while specifying a containerPort and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.

The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.

The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota.

portMapping_name :: Lens' PortMapping (Maybe Text)

The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the serviceConnectConfiguration of a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.

For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

portMapping_protocol :: Lens' PortMapping (Maybe TransportProtocol)

The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.

ProtectedTask

protectedTask_expirationDate :: Lens' ProtectedTask (Maybe UTCTime)

The epoch time when protection for the task will expire.

protectedTask_protectionEnabled :: Lens' ProtectedTask (Maybe Bool)

The protection status of the task. If scale-in protection is enabled for a task, the value is true. Otherwise, it is false.

protectedTask_taskArn :: Lens' ProtectedTask (Maybe Text)

The task ARN.

ProxyConfiguration

proxyConfiguration_properties :: Lens' ProxyConfiguration (Maybe [KeyValuePair])

The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs.

• IgnoredUID - (Required) The user ID (UID) of the proxy container as defined by the user parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If IgnoredGID is specified, this field can be empty.
• IgnoredGID - (Required) The group ID (GID) of the proxy container as defined by the user parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If IgnoredUID is specified, this field can be empty.
• AppPorts - (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to the ProxyIngressPort and ProxyEgressPort.
• ProxyIngressPort - (Required) Specifies the port that incoming traffic to the AppPorts is directed to.
• ProxyEgressPort - (Required) Specifies the port that outgoing traffic from the AppPorts is directed to.
• EgressIgnoredPorts - (Required) The egress traffic going to the specified ports is ignored and not redirected to the ProxyEgressPort. It can be an empty list.
• EgressIgnoredIPs - (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to the ProxyEgressPort. It can be an empty list.

proxyConfiguration_type :: Lens' ProxyConfiguration (Maybe ProxyConfigurationType)

The proxy type. The only supported value is APPMESH.

proxyConfiguration_containerName :: Lens' ProxyConfiguration Text

The name of the container that will serve as the App Mesh proxy.

RepositoryCredentials

repositoryCredentials_credentialsParameter :: Lens' RepositoryCredentials Text

The Amazon Resource Name (ARN) of the secret containing the private repository credentials.

When you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the Amazon Web Services Management Console, you must specify the full ARN of the secret.

Resource

resource_doubleValue :: Lens' Resource (Maybe Double)

When the doubleValue type is set, the value of the resource must be a double precision floating-point type.

resource_integerValue :: Lens' Resource (Maybe Int)

When the integerValue type is set, the value of the resource must be an integer.

resource_longValue :: Lens' Resource (Maybe Integer)

When the longValue type is set, the value of the resource must be an extended precision floating-point type.

resource_name :: Lens' Resource (Maybe Text)

The name of the resource, such as CPU, MEMORY, PORTS, PORTS_UDP, or a user-defined resource.

resource_stringSetValue :: Lens' Resource (Maybe [Text])

When the stringSetValue type is set, the value of the resource must be a string type.

resource_type :: Lens' Resource (Maybe Text)

The type of the resource. Valid values: INTEGER, DOUBLE, LONG, or STRINGSET.

ResourceRequirement

resourceRequirement_value :: Lens' ResourceRequirement Text

The value for the specified resource type.

If the GPU type is used, the value is the number of physical GPUs the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on.

If the InferenceAccelerator type is used, the value matches the deviceName for an InferenceAccelerator specified in a task definition.

resourceRequirement_type :: Lens' ResourceRequirement ResourceType

The type of resource to assign to a container. The supported values are GPU or InferenceAccelerator.

RuntimePlatform

runtimePlatform_cpuArchitecture :: Lens' RuntimePlatform (Maybe CPUArchitecture)

The CPU architecture.

You can run your Linux tasks on an ARM-based platform by setting the value to ARM64. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate.

runtimePlatform_operatingSystemFamily :: Lens' RuntimePlatform (Maybe OSFamily)

The operating system.

Scale

scale_unit :: Lens' Scale (Maybe ScaleUnit)

The unit of measure for the scale value.

scale_value :: Lens' Scale (Maybe Double)

The value, specified as a percent total of a service's desiredCount, to scale the task set. Accepted values are numbers between 0 and 100.

Secret

secret_name :: Lens' Secret Text

The name of the secret.

secret_valueFrom :: Lens' Secret Text

The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.

For information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the /Amazon Elastic Container Service Developer Guide/.

If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.

ServiceConnectClientAlias

serviceConnectClientAlias_dnsName :: Lens' ServiceConnectClientAlias (Maybe Text)

The dnsName is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn't need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can't start with a hyphen.

If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.

To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are database, db, or the lowercase name of a database, such as mysql or redis. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

serviceConnectClientAlias_port :: Lens' ServiceConnectClientAlias Natural

The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace.

To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

ServiceConnectConfiguration

serviceConnectConfiguration_logConfiguration :: Lens' ServiceConnectConfiguration (Maybe LogConfiguration)

Undocumented member.

serviceConnectConfiguration_namespace :: Lens' ServiceConnectConfiguration (Maybe Text)

The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in the same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about Cloud Map, see Working with Services in the /Cloud Map Developer Guide/.

serviceConnectConfiguration_services :: Lens' ServiceConnectConfiguration (Maybe [ServiceConnectService])

The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service.

This field is not required for a "client" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.

An object selects a port from the task definition, assigns a name for the Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.

serviceConnectConfiguration_enabled :: Lens' ServiceConnectConfiguration Bool

Specifies whether to use Service Connect with this service.

ServiceConnectService

serviceConnectService_clientAliases :: Lens' ServiceConnectService (Maybe [ServiceConnectClientAlias])

The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.

Each alias ("endpoint") is a fully-qualified name and port number that other Amazon ECS tasks ("clients") can use to connect to this service.

Each name and port mapping must be unique within the namespace.

For each ServiceConnectService, you must provide at least one clientAlias with one port.

serviceConnectService_discoveryName :: Lens' ServiceConnectService (Maybe Text)

The discoveryName is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.

If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.

serviceConnectService_ingressPortOverride :: Lens' ServiceConnectService (Maybe Natural)

The port number for the Service Connect proxy to listen on.

Use the value of this field to bypass the proxy for traffic on the port number specified in the named portMapping in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service.

In awsvpc mode and Fargate, the default value is the container port number. The container port number is in the portMapping in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy.

serviceConnectService_portName :: Lens' ServiceConnectService Text

The portName must match the name of one of the portMappings from all the containers in the task definition of this Amazon ECS service.

ServiceConnectServiceResource

serviceConnectServiceResource_discoveryArn :: Lens' ServiceConnectServiceResource (Maybe Text)

The Amazon Resource Name (ARN) for the namespace in Cloud Map that matches the discovery name for this Service Connect resource. You can use this ARN in other integrations with Cloud Map. However, Service Connect can't ensure connectivity outside of Amazon ECS.

serviceConnectServiceResource_discoveryName :: Lens' ServiceConnectServiceResource (Maybe Text)

The discovery name of this Service Connect resource.

The discoveryName is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.

If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.

ServiceEvent

serviceEvent_createdAt :: Lens' ServiceEvent (Maybe UTCTime)

The Unix timestamp for the time when the event was triggered.

serviceEvent_id :: Lens' ServiceEvent (Maybe Text)

The ID string for the event.

serviceEvent_message :: Lens' ServiceEvent (Maybe Text)

The event message.

ServiceRegistry

serviceRegistry_containerName :: Lens' ServiceRegistry (Maybe Text)

The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can't specify both.

serviceRegistry_containerPort :: Lens' ServiceRegistry (Maybe Int)

The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can't specify both.

serviceRegistry_port :: Lens' ServiceRegistry (Maybe Int)

The port value used if your service discovery service specified an SRV record. This field might be used if both the awsvpc network mode and SRV records are used.

serviceRegistry_registryArn :: Lens' ServiceRegistry (Maybe Text)

The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see CreateService.

Session

session_sessionId :: Lens' Session (Maybe Text)

The ID of the execute command session.

session_streamUrl :: Lens' Session (Maybe Text)

A URL to the managed agent on the container that the SSM Session Manager client uses to send commands and receive output from the container.

session_tokenValue :: Lens' Session (Maybe Text)

An encrypted token value containing session and caller information. It's used to authenticate the connection to the container.

Setting

setting_name :: Lens' Setting (Maybe SettingName)

The Amazon ECS resource name.

setting_principalArn :: Lens' Setting (Maybe Text)

The ARN of the principal. It can be an IAM user, IAM role, or the root user. If this field is omitted, the authenticated user is assumed.

setting_value :: Lens' Setting (Maybe Text)

Determines whether the account setting is enabled or disabled for the specified resource.

SystemControl

systemControl_namespace :: Lens' SystemControl (Maybe Text)

The namespaced kernel parameter to set a value for.

systemControl_value :: Lens' SystemControl (Maybe Text)

The value for the namespaced kernel parameter that's specified in namespace.

Tag

tag_key :: Lens' Tag (Maybe Text)

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

tag_value :: Lens' Tag (Maybe Text)

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

Task

task_attachments :: Lens' Task (Maybe [Attachment])

The Elastic Network Adapter that's associated with the task if the task uses the awsvpc network mode.

task_attributes :: Lens' Task (Maybe [Attribute])

The attributes of the task

task_availabilityZone :: Lens' Task (Maybe Text)

The Availability Zone for the task.

task_capacityProviderName :: Lens' Task (Maybe Text)

The capacity provider that's associated with the task.

task_clusterArn :: Lens' Task (Maybe Text)

The ARN of the cluster that hosts the task.

task_connectivity :: Lens' Task (Maybe Connectivity)

The connectivity status of a task.

task_connectivityAt :: Lens' Task (Maybe UTCTime)

The Unix timestamp for the time when the task last went into CONNECTED status.

task_containerInstanceArn :: Lens' Task (Maybe Text)

The ARN of the container instances that host the task.

task_containers :: Lens' Task (Maybe [Container])

The containers that's associated with the task.

task_cpu :: Lens' Task (Maybe Text)

The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units (for example, 1024). It can also be expressed as a string using vCPUs (for example, 1 vCPU or 1 vcpu). String values are converted to an integer that indicates the CPU units when the task definition is registered.

If you use the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).

If you use the Fargate launch type, this field is required. You must use one of the following values. These values determine the range of supported values for the memory parameter:

The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

• 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
• 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
• 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
• 2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
• 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)

• 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments

  This option requires Linux platform 1.4.0 or later.

• 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments

  This option requires Linux platform 1.4.0 or later.

task_createdAt :: Lens' Task (Maybe UTCTime)

The Unix timestamp for the time when the task was created. More specifically, it's for the time when the task entered the PENDING state.

task_desiredStatus :: Lens' Task (Maybe Text)

The desired status of the task. For more information, see Task Lifecycle.

task_enableExecuteCommand :: Lens' Task (Maybe Bool)

Determines whether execute command functionality is enabled for this task. If true, execute command functionality is enabled on all the containers in the task.

task_ephemeralStorage :: Lens' Task (Maybe EphemeralStorage)

The ephemeral storage settings for the task.

task_executionStoppedAt :: Lens' Task (Maybe UTCTime)

The Unix timestamp for the time when the task execution stopped.

task_group :: Lens' Task (Maybe Text)

The name of the task group that's associated with the task.

task_healthStatus :: Lens' Task (Maybe HealthStatus)

The health status for the task. It's determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY, the task status also reports as HEALTHY. If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN, the task status also reports as UNHEALTHY or UNKNOWN.

The Amazon ECS container agent doesn't monitor or report on Docker health checks that are embedded in a container image and not specified in the container definition. For example, this includes those specified in a parent image or from the image's Dockerfile. Health check parameters that are specified in a container definition override any Docker health checks that are found in the container image.

task_inferenceAccelerators :: Lens' Task (Maybe [InferenceAccelerator])

The Elastic Inference accelerator that's associated with the task.

task_lastStatus :: Lens' Task (Maybe Text)

The last known status for the task. For more information, see Task Lifecycle.

task_launchType :: Lens' Task (Maybe LaunchType)

The infrastructure where your task runs on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

task_memory :: Lens' Task (Maybe Text)

The amount of memory (in MiB) that the task uses as expressed in a task definition. It can be expressed as an integer using MiB (for example, 1024). If it's expressed as a string using GB (for example, 1GB or 1 GB), it's converted to an integer indicating the MiB when the task definition is registered.

If you use the EC2 launch type, this field is optional.

If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines the range of supported values for the cpu parameter.

• 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
• 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
• 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
• Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
• Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)

• Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)

  This option requires Linux platform 1.4.0 or later.

• Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)

  This option requires Linux platform 1.4.0 or later.

task_overrides :: Lens' Task (Maybe TaskOverride)

One or more container overrides.

task_platformFamily :: Lens' Task (Maybe Text)

The operating system that your tasks are running on. A platform family is specified only for tasks that use the Fargate launch type.

All tasks that run as part of this service must use the same platformFamily value as the service (for example, LINUX.).

task_platformVersion :: Lens' Task (Maybe Text)

The platform version where your task runs on. A platform version is only specified for tasks that use the Fargate launch type. If you didn't specify one, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

task_pullStartedAt :: Lens' Task (Maybe UTCTime)

The Unix timestamp for the time when the container image pull began.

task_pullStoppedAt :: Lens' Task (Maybe UTCTime)

The Unix timestamp for the time when the container image pull completed.

task_startedAt :: Lens' Task (Maybe UTCTime)

The Unix timestamp for the time when the task started. More specifically, it's for the time when the task transitioned from the PENDING state to the RUNNING state.

task_startedBy :: Lens' Task (Maybe Text)

The tag specified when a task is started. If an Amazon ECS service started the task, the startedBy parameter contains the deployment ID of that service.

task_stopCode :: Lens' Task (Maybe TaskStopCode)

The stop code indicating why a task was stopped. The stoppedReason might contain additional details.

The following are valid values:

• TaskFailedToStart

• EssentialContainerExited

• UserInitiated

• TerminationNotice

• ServiceSchedulerInitiated

• SpotInterruption

task_stoppedAt :: Lens' Task (Maybe UTCTime)

The Unix timestamp for the time when the task was stopped. More specifically, it's for the time when the task transitioned from the RUNNING state to the STOPPED state.

task_stoppedReason :: Lens' Task (Maybe Text)

The reason that the task was stopped.

task_stoppingAt :: Lens' Task (Maybe UTCTime)

The Unix timestamp for the time when the task stops. More specifically, it's for the time when the task transitions from the RUNNING state to STOPPED.

task_tags :: Lens' Task (Maybe [Tag])

The metadata that you apply to the task to help you categorize and organize the task. Each tag consists of a key and an optional value. You define both the key and value.

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.

task_taskArn :: Lens' Task (Maybe Text)

The Amazon Resource Name (ARN) of the task.

task_taskDefinitionArn :: Lens' Task (Maybe Text)

The ARN of the task definition that creates the task.

task_version :: Lens' Task (Maybe Integer)

The version counter for the task. Every time a task experiences a change that starts a CloudWatch event, the version counter is incremented. If you replicate your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API actions with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.

TaskDefinition

taskDefinition_compatibilities :: Lens' TaskDefinition (Maybe [Compatibility])

The task launch types the task definition validated against during task definition registration. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

taskDefinition_containerDefinitions :: Lens' TaskDefinition (Maybe [ContainerDefinition])

A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.

taskDefinition_cpu :: Lens' TaskDefinition (Maybe Text)

The number of cpu units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the memory parameter.

The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

• 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
• 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
• 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
• 2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
• 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)

• 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments

  This option requires Linux platform 1.4.0 or later.

• 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments

  This option requires Linux platform 1.4.0 or later.

taskDefinition_deregisteredAt :: Lens' TaskDefinition (Maybe UTCTime)

The Unix timestamp for the time when the task definition was deregistered.

taskDefinition_ephemeralStorage :: Lens' TaskDefinition (Maybe EphemeralStorage)

The ephemeral storage settings to use for tasks run with the task definition.

taskDefinition_executionRoleArn :: Lens' TaskDefinition (Maybe Text)

The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.

taskDefinition_family :: Lens' TaskDefinition (Maybe Text)

The name of a family that this task definition is registered to. Up to 255 characters are allowed. Letters (both uppercase and lowercase letters), numbers, hyphens (-), and underscores (_) are allowed.

A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.

taskDefinition_inferenceAccelerators :: Lens' TaskDefinition (Maybe [InferenceAccelerator])

The Elastic Inference accelerator that's associated with the task.

taskDefinition_ipcMode :: Lens' TaskDefinition (Maybe IpcMode)

The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.

If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.

If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.

• For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.
• For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.

This parameter is not supported for Windows containers or tasks run on Fargate.

taskDefinition_memory :: Lens' TaskDefinition (Maybe Text)

The amount (in MiB) of memory used by the task.

If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition.

If your tasks runs on Fargate, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the cpu parameter.

• 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
• 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
• 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
• Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
• Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)

• Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)

  This option requires Linux platform 1.4.0 or later.

• Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)

  This option requires Linux platform 1.4.0 or later.

taskDefinition_networkMode :: Lens' TaskDefinition (Maybe NetworkMode)

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.

For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.

If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.

For more information, see Network settings in the Docker run reference.

taskDefinition_pidMode :: Lens' TaskDefinition (Maybe PidMode)

The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference.

If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security.

This parameter is not supported for Windows containers or tasks run on Fargate.

taskDefinition_placementConstraints :: Lens' TaskDefinition (Maybe [TaskDefinitionPlacementConstraint])

An array of placement constraint objects to use for tasks.

This parameter isn't supported for tasks run on Fargate.

taskDefinition_proxyConfiguration :: Lens' TaskDefinition (Maybe ProxyConfiguration)

The configuration details for the App Mesh proxy.

Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version 20190301 or later, they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

taskDefinition_registeredAt :: Lens' TaskDefinition (Maybe UTCTime)

The Unix timestamp for the time when the task definition was registered.

taskDefinition_registeredBy :: Lens' TaskDefinition (Maybe Text)

The principal that registered the task definition.

taskDefinition_requiresAttributes :: Lens' TaskDefinition (Maybe [Attribute])

The container instance attributes required by your task. When an Amazon EC2 instance is registered to your cluster, the Amazon ECS container agent assigns some standard attributes to the instance. You can apply custom attributes. These are specified as key-value pairs using the Amazon ECS console or the PutAttributes API. These attributes are used when determining task placement for tasks hosted on Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

This parameter isn't supported for tasks run on Fargate.

taskDefinition_requiresCompatibilities :: Lens' TaskDefinition (Maybe [Compatibility])

The task launch types the task definition was validated against. To determine which task launch types the task definition is validated for, see the TaskDefinition$compatibilities parameter.

taskDefinition_revision :: Lens' TaskDefinition (Maybe Int)

The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1. Each time that you register a new revision of a task definition in the same family, the revision value always increases by one. This is even if you deregistered previous revisions in this family.

taskDefinition_runtimePlatform :: Lens' TaskDefinition (Maybe RuntimePlatform)

The operating system that your task definitions are running on. A platform family is specified only for tasks using the Fargate launch type.

When you specify a task in a service, this value must match the runtimePlatform value of the service.

taskDefinition_status :: Lens' TaskDefinition (Maybe TaskDefinitionStatus)

The status of the task definition.

taskDefinition_taskDefinitionArn :: Lens' TaskDefinition (Maybe Text)

The full Amazon Resource Name (ARN) of the task definition.

taskDefinition_taskRoleArn :: Lens' TaskDefinition (Maybe Text)

The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the task permission to call Amazon Web Services APIs on your behalf. For more information, see Amazon ECS Task Role in the Amazon Elastic Container Service Developer Guide.

IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see Windows IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.

taskDefinition_volumes :: Lens' TaskDefinition (Maybe [Volume])

The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide.

The host and sourcePath parameters aren't supported for tasks run on Fargate.

TaskDefinitionPlacementConstraint

taskDefinitionPlacementConstraint_expression :: Lens' TaskDefinitionPlacementConstraint (Maybe Text)

A cluster query language expression to apply to the constraint. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.

taskDefinitionPlacementConstraint_type :: Lens' TaskDefinitionPlacementConstraint (Maybe TaskDefinitionPlacementConstraintType)

The type of constraint. The MemberOf constraint restricts selection to be from a group of valid candidates.

TaskOverride

taskOverride_containerOverrides :: Lens' TaskOverride (Maybe [ContainerOverride])

One or more container overrides that are sent to a task.

taskOverride_cpu :: Lens' TaskOverride (Maybe Text)

The CPU override for the task.

taskOverride_ephemeralStorage :: Lens' TaskOverride (Maybe EphemeralStorage)

The ephemeral storage setting override for the task.

This parameter is only supported for tasks hosted on Fargate that use the following platform versions:

• Linux platform version 1.4.0 or later.
• Windows platform version 1.0.0 or later.

taskOverride_executionRoleArn :: Lens' TaskOverride (Maybe Text)

The Amazon Resource Name (ARN) of the task execution IAM role override for the task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.

taskOverride_inferenceAcceleratorOverrides :: Lens' TaskOverride (Maybe [InferenceAcceleratorOverride])

The Elastic Inference accelerator override for the task.

taskOverride_memory :: Lens' TaskOverride (Maybe Text)

The memory override for the task.

taskOverride_taskRoleArn :: Lens' TaskOverride (Maybe Text)

The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Role for Tasks in the Amazon Elastic Container Service Developer Guide.

TaskSet

taskSet_capacityProviderStrategy :: Lens' TaskSet (Maybe [CapacityProviderStrategyItem])

The capacity provider strategy that are associated with the task set.

taskSet_clusterArn :: Lens' TaskSet (Maybe Text)

The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.

taskSet_computedDesiredCount :: Lens' TaskSet (Maybe Int)

The computed desired count for the task set. This is calculated by multiplying the service's desiredCount by the task set's scale percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.

taskSet_createdAt :: Lens' TaskSet (Maybe UTCTime)

The Unix timestamp for the time when the task set was created.

taskSet_externalId :: Lens' TaskSet (Maybe Text)

The external ID associated with the task set.

If an CodeDeploy deployment created a task set, the externalId parameter contains the CodeDeploy deployment ID.

If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute.

taskSet_id :: Lens' TaskSet (Maybe Text)

The ID of the task set.

taskSet_launchType :: Lens' TaskSet (Maybe LaunchType)

The launch type the tasks in the task set are using. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

taskSet_loadBalancers :: Lens' TaskSet (Maybe [LoadBalancer])

Details on a load balancer that are used with a task set.

taskSet_networkConfiguration :: Lens' TaskSet (Maybe NetworkConfiguration)

The network configuration for the task set.

taskSet_pendingCount :: Lens' TaskSet (Maybe Int)

The number of tasks in the task set that are in the PENDING status during a deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time or when it's restarted after being in the STOPPED state.

taskSet_platformFamily :: Lens' TaskSet (Maybe Text)

The operating system that your tasks in the set are running on. A platform family is specified only for tasks that use the Fargate launch type.

All tasks in the set must have the same value.

taskSet_platformVersion :: Lens' TaskSet (Maybe Text)

The Fargate platform version where the tasks in the task set are running. A platform version is only specified for tasks run on Fargate. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

taskSet_runningCount :: Lens' TaskSet (Maybe Int)

The number of tasks in the task set that are in the RUNNING status during a deployment. A task in the RUNNING state is running and ready for use.

taskSet_scale :: Lens' TaskSet (Maybe Scale)

A floating-point percentage of your desired number of tasks to place and keep running in the task set.

taskSet_serviceArn :: Lens' TaskSet (Maybe Text)

The Amazon Resource Name (ARN) of the service the task set exists in.

taskSet_serviceRegistries :: Lens' TaskSet (Maybe [ServiceRegistry])

The details for the service discovery registries to assign to this task set. For more information, see Service discovery.

taskSet_stabilityStatus :: Lens' TaskSet (Maybe StabilityStatus)

The stability status. This indicates whether the task set has reached a steady state. If the following conditions are met, the task set are in STEADY_STATE:

• The task runningCount is equal to the computedDesiredCount.
• The pendingCount is 0.
• There are no tasks that are running on container instances in the DRAINING status.
• All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.

If any of those conditions aren't met, the stability status returns STABILIZING.

taskSet_stabilityStatusAt :: Lens' TaskSet (Maybe UTCTime)

The Unix timestamp for the time when the task set stability status was retrieved.

taskSet_startedBy :: Lens' TaskSet (Maybe Text)

The tag specified when a task set is started. If an CodeDeploy deployment created the task set, the startedBy parameter is CODE_DEPLOY. If an external deployment created the task set, the startedBy field isn't used.

taskSet_status :: Lens' TaskSet (Maybe Text)

The status of the task set. The following describes each state.

PRIMARY

The task set is serving production traffic.

ACTIVE

The task set isn't serving production traffic.

DRAINING

The tasks in the task set are being stopped, and their corresponding targets are being deregistered from their target group.

taskSet_tags :: Lens' TaskSet (Maybe [Tag])

The metadata that you apply to the task set 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.

taskSet_taskDefinition :: Lens' TaskSet (Maybe Text)

The task definition that the task set is using.

taskSet_taskSetArn :: Lens' TaskSet (Maybe Text)

The Amazon Resource Name (ARN) of the task set.

taskSet_updatedAt :: Lens' TaskSet (Maybe UTCTime)

The Unix timestamp for the time when the task set was last updated.

Tmpfs

tmpfs_mountOptions :: Lens' Tmpfs (Maybe [Text])

The list of tmpfs volume mount options.

Valid values: "defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"

tmpfs_containerPath :: Lens' Tmpfs Text

The absolute file path where the tmpfs volume is to be mounted.

tmpfs_size :: Lens' Tmpfs Int

The maximum size (in MiB) of the tmpfs volume.

Ulimit

ulimit_name :: Lens' Ulimit UlimitName

The type of the ulimit.

ulimit_softLimit :: Lens' Ulimit Int

The soft limit for the ulimit type.

ulimit_hardLimit :: Lens' Ulimit Int

The hard limit for the ulimit type.

VersionInfo

versionInfo_agentHash :: Lens' VersionInfo (Maybe Text)

The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.

versionInfo_agentVersion :: Lens' VersionInfo (Maybe Text)

The version number of the Amazon ECS container agent.

versionInfo_dockerVersion :: Lens' VersionInfo (Maybe Text)

The Docker version that's running on the container instance.

Volume

volume_dockerVolumeConfiguration :: Lens' Volume (Maybe DockerVolumeConfiguration)

This parameter is specified when you use Docker volumes.

Windows containers only support the use of the local driver. To use bind mounts, specify the host parameter instead.

Docker volumes aren't supported by tasks run on Fargate.

volume_efsVolumeConfiguration :: Lens' Volume (Maybe EFSVolumeConfiguration)

This parameter is specified when you use an Amazon Elastic File System file system for task storage.

volume_fsxWindowsFileServerVolumeConfiguration :: Lens' Volume (Maybe FSxWindowsFileServerVolumeConfiguration)

This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.

volume_host :: Lens' Volume (Maybe HostVolumeProperties)

This parameter is specified when you use bind mount host volumes. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mount C:\my\path:C:\my\path and D:\:D:\, but not D:\my\path:C:\my\path or D:\:C:\my\path.

volume_name :: Lens' Volume (Maybe Text)

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.

VolumeFrom

volumeFrom_readOnly :: Lens' VolumeFrom (Maybe Bool)

If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.

volumeFrom_sourceContainer :: Lens' VolumeFrom (Maybe Text)

The name of another container within the same task definition to mount volumes from.