Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Create a task set in the specified cluster and service. This is used
when a service uses the EXTERNAL
deployment controller type. For more
information, see
Amazon ECS Deployment Types
in the Amazon Elastic Container Service Developer Guide.
Synopsis
- data CreateTaskSet = CreateTaskSet' {
- clientToken :: Maybe Text
- platformVersion :: Maybe Text
- scale :: Maybe Scale
- loadBalancers :: Maybe [LoadBalancer]
- launchType :: Maybe LaunchType
- externalId :: Maybe Text
- networkConfiguration :: Maybe NetworkConfiguration
- serviceRegistries :: Maybe [ServiceRegistry]
- capacityProviderStrategy :: Maybe [CapacityProviderStrategyItem]
- tags :: Maybe [Tag]
- service :: Text
- cluster :: Text
- taskDefinition :: Text
- newCreateTaskSet :: Text -> Text -> Text -> CreateTaskSet
- createTaskSet_clientToken :: Lens' CreateTaskSet (Maybe Text)
- createTaskSet_platformVersion :: Lens' CreateTaskSet (Maybe Text)
- createTaskSet_scale :: Lens' CreateTaskSet (Maybe Scale)
- createTaskSet_loadBalancers :: Lens' CreateTaskSet (Maybe [LoadBalancer])
- createTaskSet_launchType :: Lens' CreateTaskSet (Maybe LaunchType)
- createTaskSet_externalId :: Lens' CreateTaskSet (Maybe Text)
- createTaskSet_networkConfiguration :: Lens' CreateTaskSet (Maybe NetworkConfiguration)
- createTaskSet_serviceRegistries :: Lens' CreateTaskSet (Maybe [ServiceRegistry])
- createTaskSet_capacityProviderStrategy :: Lens' CreateTaskSet (Maybe [CapacityProviderStrategyItem])
- createTaskSet_tags :: Lens' CreateTaskSet (Maybe [Tag])
- createTaskSet_service :: Lens' CreateTaskSet Text
- createTaskSet_cluster :: Lens' CreateTaskSet Text
- createTaskSet_taskDefinition :: Lens' CreateTaskSet Text
- data CreateTaskSetResponse = CreateTaskSetResponse' {
- taskSet :: Maybe TaskSet
- httpStatus :: Int
- newCreateTaskSetResponse :: Int -> CreateTaskSetResponse
- createTaskSetResponse_taskSet :: Lens' CreateTaskSetResponse (Maybe TaskSet)
- createTaskSetResponse_httpStatus :: Lens' CreateTaskSetResponse Int
Creating a Request
data CreateTaskSet Source #
See: newCreateTaskSet
smart constructor.
CreateTaskSet' | |
|
Instances
:: Text | |
-> Text | |
-> Text | |
-> CreateTaskSet |
Create a value of CreateTaskSet
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateTaskSet'
, createTaskSet_clientToken
- Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. Up to 32 ASCII characters are allowed.
$sel:platformVersion:CreateTaskSet'
, createTaskSet_platformVersion
- The platform version that the tasks in the task set should use. A
platform version is specified only for tasks using the Fargate launch
type. If one isn't specified, the LATEST
platform version is used by
default.
$sel:scale:CreateTaskSet'
, createTaskSet_scale
- A floating-point percentage of the desired number of tasks to place and
keep running in the task set.
$sel:loadBalancers:CreateTaskSet'
, createTaskSet_loadBalancers
- 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.
$sel:launchType:CreateTaskSet'
, createTaskSet_launchType
- The launch type that new tasks in the task set will use. 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.
$sel:externalId:CreateTaskSet'
, createTaskSet_externalId
- 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.
$sel:networkConfiguration:CreateTaskSet'
, createTaskSet_networkConfiguration
- An object representing the network configuration for a task set.
$sel:serviceRegistries:CreateTaskSet'
, createTaskSet_serviceRegistries
- The details of the service discovery registries to assign to this task
set. For more information, see
Service Discovery.
$sel:capacityProviderStrategy:CreateTaskSet'
, createTaskSet_capacityProviderStrategy
- 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.
$sel:tags:CreateTaskSet'
, createTaskSet_tags
- 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, 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.
$sel:service:CreateTaskSet'
, createTaskSet_service
- The short name or full Amazon Resource Name (ARN) of the service to
create the task set in.
$sel:cluster:CreateTaskSet'
, createTaskSet_cluster
- The short name or full Amazon Resource Name (ARN) of the cluster that
hosts the service to create the task set in.
$sel:taskDefinition:CreateTaskSet'
, createTaskSet_taskDefinition
- The task definition for the tasks in the task set to use.
Request Lenses
createTaskSet_clientToken :: Lens' CreateTaskSet (Maybe Text) Source #
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
createTaskSet_platformVersion :: Lens' CreateTaskSet (Maybe Text) Source #
The platform version that the tasks in the task set should use. A
platform version is specified only for tasks using the Fargate launch
type. If one isn't specified, the LATEST
platform version is used by
default.
createTaskSet_scale :: Lens' CreateTaskSet (Maybe Scale) Source #
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
createTaskSet_loadBalancers :: Lens' CreateTaskSet (Maybe [LoadBalancer]) Source #
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_launchType :: Lens' CreateTaskSet (Maybe LaunchType) Source #
The launch type that new tasks in the task set will use. 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_externalId :: Lens' CreateTaskSet (Maybe Text) Source #
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_networkConfiguration :: Lens' CreateTaskSet (Maybe NetworkConfiguration) Source #
An object representing the network configuration for a task set.
createTaskSet_serviceRegistries :: Lens' CreateTaskSet (Maybe [ServiceRegistry]) Source #
The details of the service discovery registries to assign to this task set. For more information, see Service Discovery.
createTaskSet_capacityProviderStrategy :: Lens' CreateTaskSet (Maybe [CapacityProviderStrategyItem]) Source #
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_tags :: Lens' CreateTaskSet (Maybe [Tag]) Source #
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, 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.
createTaskSet_service :: Lens' CreateTaskSet Text Source #
The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
createTaskSet_cluster :: Lens' CreateTaskSet Text Source #
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 Source #
The task definition for the tasks in the task set to use.
Destructuring the Response
data CreateTaskSetResponse Source #
See: newCreateTaskSetResponse
smart constructor.
CreateTaskSetResponse' | |
|
Instances
newCreateTaskSetResponse Source #
Create a value of CreateTaskSetResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:taskSet:CreateTaskSetResponse'
, createTaskSetResponse_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.
$sel:httpStatus:CreateTaskSetResponse'
, createTaskSetResponse_httpStatus
- The response's http status code.
Response Lenses
createTaskSetResponse_taskSet :: Lens' CreateTaskSetResponse (Maybe TaskSet) Source #
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 Source #
The response's http status code.