Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ECS.CreateTaskSet

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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' {
- capacityProviderStrategy :: Maybe [CapacityProviderStrategyItem]
- clientToken :: Maybe Text
- externalId :: Maybe Text
- launchType :: Maybe LaunchType
- loadBalancers :: Maybe [LoadBalancer]
- networkConfiguration :: Maybe NetworkConfiguration
- platformVersion :: Maybe Text
- scale :: Maybe Scale
- serviceRegistries :: Maybe [ServiceRegistry]
- tags :: Maybe [Tag]
- service :: Text
- cluster :: Text
- taskDefinition :: Text
}
newCreateTaskSet :: Text -> Text -> Text -> CreateTaskSet
createTaskSet_capacityProviderStrategy :: Lens' CreateTaskSet (Maybe [CapacityProviderStrategyItem])
createTaskSet_clientToken :: Lens' CreateTaskSet (Maybe Text)
createTaskSet_externalId :: Lens' CreateTaskSet (Maybe Text)
createTaskSet_launchType :: Lens' CreateTaskSet (Maybe LaunchType)
createTaskSet_loadBalancers :: Lens' CreateTaskSet (Maybe [LoadBalancer])
createTaskSet_networkConfiguration :: Lens' CreateTaskSet (Maybe NetworkConfiguration)
createTaskSet_platformVersion :: Lens' CreateTaskSet (Maybe Text)
createTaskSet_scale :: Lens' CreateTaskSet (Maybe Scale)
createTaskSet_serviceRegistries :: Lens' CreateTaskSet (Maybe [ServiceRegistry])
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.

Constructors

CreateTaskSet'

Fields

capacityProviderStrategy :: 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.
clientToken :: 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.
externalId :: 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.
launchType :: 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.
loadBalancers :: 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.
networkConfiguration :: Maybe NetworkConfiguration
An object representing the network configuration for a task set.
platformVersion :: 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.
scale :: Maybe Scale
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
serviceRegistries :: Maybe [ServiceRegistry]
The details of the service discovery registries to assign to this task set. For more information, see Service discovery.
tags :: 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.
service :: Text
The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
cluster :: Text
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
taskDefinition :: Text
The task definition for the tasks in the task set to use.

Instances

Instances details

ToJSON CreateTaskSet Source #
Instance details Defined in Amazonka.ECS.CreateTaskSet Methods toJSON :: CreateTaskSet -> Value # toEncoding :: CreateTaskSet -> Encoding # toJSONList :: [CreateTaskSet] -> Value # toEncodingList :: [CreateTaskSet] -> Encoding #
ToHeaders CreateTaskSet Source #
Instance details Defined in Amazonka.ECS.CreateTaskSet Methods toHeaders :: CreateTaskSet -> [Header] #
ToPath CreateTaskSet Source #
Instance details Defined in Amazonka.ECS.CreateTaskSet Methods toPath :: CreateTaskSet -> ByteString #
ToQuery CreateTaskSet Source #
Instance details Defined in Amazonka.ECS.CreateTaskSet Methods toQuery :: CreateTaskSet -> QueryString #
AWSRequest CreateTaskSet Source #
Instance details Defined in Amazonka.ECS.CreateTaskSet Associated Types type AWSResponse CreateTaskSet # Methods request :: (Service -> Service) -> CreateTaskSet -> Request CreateTaskSet # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateTaskSet -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateTaskSet))) #
Generic CreateTaskSet Source #
Instance details Defined in Amazonka.ECS.CreateTaskSet Associated Types type Rep CreateTaskSet :: Type -> Type # Methods from :: CreateTaskSet -> Rep CreateTaskSet x # to :: Rep CreateTaskSet x -> CreateTaskSet #
Read CreateTaskSet Source #
Instance details Defined in Amazonka.ECS.CreateTaskSet Methods readsPrec :: Int -> ReadS CreateTaskSet # readList :: ReadS [CreateTaskSet] # readPrec :: ReadPrec CreateTaskSet # readListPrec :: ReadPrec [CreateTaskSet] #
Show CreateTaskSet Source #
Instance details Defined in Amazonka.ECS.CreateTaskSet Methods showsPrec :: Int -> CreateTaskSet -> ShowS # show :: CreateTaskSet -> String # showList :: [CreateTaskSet] -> ShowS #
NFData CreateTaskSet Source #
Instance details Defined in Amazonka.ECS.CreateTaskSet Methods rnf :: CreateTaskSet -> () #
Eq CreateTaskSet Source #
Instance details Defined in Amazonka.ECS.CreateTaskSet Methods (==) :: CreateTaskSet -> CreateTaskSet -> Bool # (/=) :: CreateTaskSet -> CreateTaskSet -> Bool #
Hashable CreateTaskSet Source #
Instance details Defined in Amazonka.ECS.CreateTaskSet Methods hashWithSalt :: Int -> CreateTaskSet -> Int # hash :: CreateTaskSet -> Int #
type AWSResponse CreateTaskSet Source #
Instance details Defined in Amazonka.ECS.CreateTaskSet type AWSResponse CreateTaskSet = CreateTaskSetResponse
type Rep CreateTaskSet Source #
Instance details Defined in Amazonka.ECS.CreateTaskSet type Rep CreateTaskSet = D1 ('MetaData "CreateTaskSet" "Amazonka.ECS.CreateTaskSet" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "CreateTaskSet'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "capacityProviderStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CapacityProviderStrategyItem])) :: (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "externalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "launchType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LaunchType)) :: (S1 ('MetaSel ('Just "loadBalancers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LoadBalancer])) :: S1 ('MetaSel ('Just "networkConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NetworkConfiguration))))) :: ((S1 ('MetaSel ('Just "platformVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "scale") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Scale)) :: S1 ('MetaSel ('Just "serviceRegistries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ServiceRegistry])))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "service") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "cluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "taskDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateTaskSet Source #

Arguments

:: Text	`$sel:service:CreateTaskSet'`
-> Text	`$sel:cluster:CreateTaskSet'`
-> Text	`CreateTaskSet`
-> 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:

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:clientToken:CreateTaskSet', createTaskSet_clientToken - 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, 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.

CreateTaskSet, createTaskSet_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, 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.

CreateTaskSet, createTaskSet_networkConfiguration - An object representing the network configuration for a task set.

CreateTaskSet, createTaskSet_platformVersion - 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, createTaskSet_scale - A floating-point percentage of the desired number of tasks to place and keep running in the task set.

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

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

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

CreateTaskSet, createTaskSet_taskDefinition - The task definition for the tasks in the task set to use.

Request Lenses

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_clientToken :: Lens' CreateTaskSet (Maybe Text) Source #

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) 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_launchType :: Lens' CreateTaskSet (Maybe LaunchType) Source #

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]) 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_networkConfiguration :: Lens' CreateTaskSet (Maybe NetworkConfiguration) Source #

An object representing the network configuration for a task set.

createTaskSet_platformVersion :: Lens' CreateTaskSet (Maybe Text) Source #

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) Source #

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

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

Constructors

CreateTaskSetResponse'
Fields taskSet :: 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. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateTaskSetResponse Source #
Instance details Defined in Amazonka.ECS.CreateTaskSet Associated Types type Rep CreateTaskSetResponse :: Type -> Type # Methods from :: CreateTaskSetResponse -> Rep CreateTaskSetResponse x # to :: Rep CreateTaskSetResponse x -> CreateTaskSetResponse #
Read CreateTaskSetResponse Source #
Instance details Defined in Amazonka.ECS.CreateTaskSet Methods readsPrec :: Int -> ReadS CreateTaskSetResponse # readList :: ReadS [CreateTaskSetResponse] # readPrec :: ReadPrec CreateTaskSetResponse # readListPrec :: ReadPrec [CreateTaskSetResponse] #
Show CreateTaskSetResponse Source #
Instance details Defined in Amazonka.ECS.CreateTaskSet Methods showsPrec :: Int -> CreateTaskSetResponse -> ShowS # show :: CreateTaskSetResponse -> String # showList :: [CreateTaskSetResponse] -> ShowS #
NFData CreateTaskSetResponse Source #
Instance details Defined in Amazonka.ECS.CreateTaskSet Methods rnf :: CreateTaskSetResponse -> () #
Eq CreateTaskSetResponse Source #
Instance details Defined in Amazonka.ECS.CreateTaskSet Methods (==) :: CreateTaskSetResponse -> CreateTaskSetResponse -> Bool # (/=) :: CreateTaskSetResponse -> CreateTaskSetResponse -> Bool #
type Rep CreateTaskSetResponse Source #
Instance details Defined in Amazonka.ECS.CreateTaskSet type Rep CreateTaskSetResponse = D1 ('MetaData "CreateTaskSetResponse" "Amazonka.ECS.CreateTaskSet" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "CreateTaskSetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "taskSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskSet)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateTaskSetResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateTaskSetResponse'`
-> CreateTaskSetResponse

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.