Interface CreateTaskSetRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateTaskSetRequest.Builder,
,CreateTaskSetRequest> EcsRequest.Builder
,SdkBuilder<CreateTaskSetRequest.Builder,
,CreateTaskSetRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateTaskSetRequest
-
Method Summary
Modifier and TypeMethodDescriptioncapacityProviderStrategy
(Collection<CapacityProviderStrategyItem> capacityProviderStrategy) The capacity provider strategy to use for the task set.capacityProviderStrategy
(Consumer<CapacityProviderStrategyItem.Builder>... capacityProviderStrategy) The capacity provider strategy to use for the task set.capacityProviderStrategy
(CapacityProviderStrategyItem... capacityProviderStrategy) The capacity provider strategy to use for the task set.clientToken
(String clientToken) An identifier that you provide to ensure the idempotency of the request.The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.externalId
(String externalId) An optional non-unique tag that identifies this task set in external systems.launchType
(String launchType) The launch type that new tasks in the task set uses.launchType
(LaunchType launchType) The launch type that new tasks in the task set uses.loadBalancers
(Collection<LoadBalancer> loadBalancers) A load balancer object representing the load balancer to use with the task set.loadBalancers
(Consumer<LoadBalancer.Builder>... loadBalancers) A load balancer object representing the load balancer to use with the task set.loadBalancers
(LoadBalancer... loadBalancers) A load balancer object representing the load balancer to use with the task set.default CreateTaskSetRequest.Builder
networkConfiguration
(Consumer<NetworkConfiguration.Builder> networkConfiguration) An object representing the network configuration for a task set.networkConfiguration
(NetworkConfiguration networkConfiguration) An object representing the network configuration for a task set.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.platformVersion
(String platformVersion) The platform version that the tasks in the task set uses.default CreateTaskSetRequest.Builder
scale
(Consumer<Scale.Builder> scale) A floating-point percentage of the desired number of tasks to place and keep running in the task set.A floating-point percentage of the desired number of tasks to place and keep running in the task set.The short name or full Amazon Resource Name (ARN) of the service to create the task set in.serviceRegistries
(Collection<ServiceRegistry> serviceRegistries) The details of the service discovery registries to assign to this task set.serviceRegistries
(Consumer<ServiceRegistry.Builder>... serviceRegistries) The details of the service discovery registries to assign to this task set.serviceRegistries
(ServiceRegistry... serviceRegistries) The details of the service discovery registries to assign to this task set.tags
(Collection<Tag> tags) The metadata that you apply to the task set to help you categorize and organize them.tags
(Consumer<Tag.Builder>... tags) The metadata that you apply to the task set to help you categorize and organize them.The metadata that you apply to the task set to help you categorize and organize them.taskDefinition
(String taskDefinition) The task definition for the tasks in the task set to use.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.ecs.model.EcsRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
service
The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
- Parameters:
service
- The short name or full Amazon Resource Name (ARN) of the service to create the task set in.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cluster
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
- Parameters:
cluster
- The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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 theECS_TASK_SET_EXTERNAL_ID
Cloud Map attribute set to the provided value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
taskDefinition
The task definition for the tasks in the task set to use. If a revision isn't specified, the latest
ACTIVE
revision is used.- Parameters:
taskDefinition
- The task definition for the tasks in the task set to use. If a revision isn't specified, the latestACTIVE
revision is used.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
networkConfiguration
An object representing the network configuration for a task set.
- Parameters:
networkConfiguration
- An object representing the network configuration for a task set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
networkConfiguration
default CreateTaskSetRequest.Builder networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration) An object representing the network configuration for a task set.
This is a convenience method that creates an instance of theNetworkConfiguration.Builder
avoiding the need to create one manually viaNetworkConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tonetworkConfiguration(NetworkConfiguration)
.- Parameters:
networkConfiguration
- a consumer that will call methods onNetworkConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
This is a convenience method that creates an instance of theLoadBalancer.Builder
avoiding the need to create one manually viaLoadBalancer.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toloadBalancers(List<LoadBalancer>)
.- Parameters:
loadBalancers
- a consumer that will call methods onLoadBalancer.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
serviceRegistries
The details of the service discovery registries to assign to this task set. For more information, see Service discovery.
- Parameters:
serviceRegistries
- The details of the service discovery registries to assign to this task set. For more information, see Service discovery.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
serviceRegistries
The details of the service discovery registries to assign to this task set. For more information, see Service discovery.
- Parameters:
serviceRegistries
- The details of the service discovery registries to assign to this task set. For more information, see Service discovery.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
serviceRegistries
CreateTaskSetRequest.Builder serviceRegistries(Consumer<ServiceRegistry.Builder>... serviceRegistries) The details of the service discovery registries to assign to this task set. For more information, see Service discovery.
This is a convenience method that creates an instance of theServiceRegistry.Builder
avoiding the need to create one manually viaServiceRegistry.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toserviceRegistries(List<ServiceRegistry>)
.- Parameters:
serviceRegistries
- a consumer that will call methods onServiceRegistry.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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, thecapacityProviderStrategy
parameter must be omitted.- Parameters:
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, thecapacityProviderStrategy
parameter must be omitted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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, thecapacityProviderStrategy
parameter must be omitted.- Parameters:
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, thecapacityProviderStrategy
parameter must be omitted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
capacityProviderStrategy
CreateTaskSetRequest.Builder capacityProviderStrategy(Collection<CapacityProviderStrategyItem> 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
andweight
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 anACTIVE
orUPDATING
status can be used.If a
capacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
orlaunchType
is specified, thedefaultCapacityProviderStrategy
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
orFARGATE_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.
- Parameters:
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
andweight
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 anACTIVE
orUPDATING
status can be used.If a
capacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
orlaunchType
is specified, thedefaultCapacityProviderStrategy
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
orFARGATE_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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
capacityProviderStrategy
CreateTaskSetRequest.Builder capacityProviderStrategy(CapacityProviderStrategyItem... 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
andweight
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 anACTIVE
orUPDATING
status can be used.If a
capacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
orlaunchType
is specified, thedefaultCapacityProviderStrategy
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
orFARGATE_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.
- Parameters:
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
andweight
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 anACTIVE
orUPDATING
status can be used.If a
capacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
orlaunchType
is specified, thedefaultCapacityProviderStrategy
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
orFARGATE_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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
capacityProviderStrategy
CreateTaskSetRequest.Builder capacityProviderStrategy(Consumer<CapacityProviderStrategyItem.Builder>... 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
andweight
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 anACTIVE
orUPDATING
status can be used.If a
capacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
orlaunchType
is specified, thedefaultCapacityProviderStrategy
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
orFARGATE_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.
This is a convenience method that creates an instance of theCapacityProviderStrategyItem.Builder
avoiding the need to create one manually viaCapacityProviderStrategyItem.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocapacityProviderStrategy(List<CapacityProviderStrategyItem>)
.- Parameters:
capacityProviderStrategy
- a consumer that will call methods onCapacityProviderStrategyItem.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
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, theLATEST
platform version is used.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scale
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
- Parameters:
scale
- A floating-point percentage of the desired number of tasks to place and keep running in the task set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scale
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
This is a convenience method that creates an instance of theScale.Builder
avoiding the need to create one manually viaScale.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toscale(Scale)
.- Parameters:
scale
- a consumer that will call methods onScale.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
clientToken
An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.
- Parameters:
clientToken
- An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.
Tag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
overrideConfiguration
CreateTaskSetRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateTaskSetRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-