public static interface CreateTaskSetRequest.Builder extends EcsRequest.Builder, SdkPojo, CopyableBuilder<CreateTaskSetRequest.Builder,CreateTaskSetRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateTaskSetRequest.Builder |
capacityProviderStrategy(CapacityProviderStrategyItem... capacityProviderStrategy)
The capacity provider strategy to use for the task set.
|
CreateTaskSetRequest.Builder |
capacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)
The capacity provider strategy to use for the task set.
|
CreateTaskSetRequest.Builder |
capacityProviderStrategy(Consumer<CapacityProviderStrategyItem.Builder>... capacityProviderStrategy)
The capacity provider strategy to use for the task set.
|
CreateTaskSetRequest.Builder |
clientToken(String clientToken)
The identifier that you provide to ensure the idempotency of the request.
|
CreateTaskSetRequest.Builder |
cluster(String cluster)
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task
set in.
|
CreateTaskSetRequest.Builder |
externalId(String externalId)
An optional non-unique tag that identifies this task set in external systems.
|
CreateTaskSetRequest.Builder |
launchType(LaunchType launchType)
The launch type that new tasks in the task set uses.
|
CreateTaskSetRequest.Builder |
launchType(String launchType)
The launch type that new tasks in the task set uses.
|
CreateTaskSetRequest.Builder |
loadBalancers(Collection<LoadBalancer> loadBalancers)
A load balancer object representing the load balancer to use with the task set.
|
CreateTaskSetRequest.Builder |
loadBalancers(Consumer<LoadBalancer.Builder>... loadBalancers)
A load balancer object representing the load balancer to use with the task set.
|
CreateTaskSetRequest.Builder |
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.
|
CreateTaskSetRequest.Builder |
networkConfiguration(NetworkConfiguration networkConfiguration)
An object representing the network configuration for a task set.
|
CreateTaskSetRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CreateTaskSetRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
CreateTaskSetRequest.Builder |
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.
|
CreateTaskSetRequest.Builder |
scale(Scale scale)
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
|
CreateTaskSetRequest.Builder |
service(String service)
The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
|
CreateTaskSetRequest.Builder |
serviceRegistries(Collection<ServiceRegistry> serviceRegistries)
The details of the service discovery registries to assign to this task set.
|
CreateTaskSetRequest.Builder |
serviceRegistries(Consumer<ServiceRegistry.Builder>... serviceRegistries)
The details of the service discovery registries to assign to this task set.
|
CreateTaskSetRequest.Builder |
serviceRegistries(ServiceRegistry... serviceRegistries)
The details of the service discovery registries to assign to this task set.
|
CreateTaskSetRequest.Builder |
tags(Collection<Tag> tags)
The metadata that you apply to the task set to help you categorize and organize them.
|
CreateTaskSetRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
The metadata that you apply to the task set to help you categorize and organize them.
|
CreateTaskSetRequest.Builder |
tags(Tag... tags)
The metadata that you apply to the task set to help you categorize and organize them.
|
CreateTaskSetRequest.Builder |
taskDefinition(String taskDefinition)
The task definition for the tasks in the task set to use.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateTaskSetRequest.Builder service(String service)
The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
service - The short name or full Amazon Resource Name (ARN) of the service to create the task set in.CreateTaskSetRequest.Builder cluster(String cluster)
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
cluster - The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the
task set in.CreateTaskSetRequest.Builder externalId(String 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.
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.CreateTaskSetRequest.Builder taskDefinition(String taskDefinition)
The task definition for the tasks in the task set to use.
taskDefinition - The task definition for the tasks in the task set to use.CreateTaskSetRequest.Builder networkConfiguration(NetworkConfiguration networkConfiguration)
An object representing the network configuration for a task set.
networkConfiguration - An object representing the network configuration for a task set.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 via NetworkConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to networkConfiguration(NetworkConfiguration).
networkConfiguration - a consumer that will call methods on NetworkConfiguration.BuildernetworkConfiguration(NetworkConfiguration)CreateTaskSetRequest.Builder loadBalancers(Collection<LoadBalancer> 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.
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.CreateTaskSetRequest.Builder loadBalancers(LoadBalancer... 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.
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.CreateTaskSetRequest.Builder loadBalancers(Consumer<LoadBalancer.Builder>... 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 via LoadBalancer.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and its
result is passed to #loadBalancers(List.
loadBalancers - a consumer that will call methods on
LoadBalancer.Builder#loadBalancers(java.util.Collection) CreateTaskSetRequest.Builder serviceRegistries(Collection<ServiceRegistry> serviceRegistries)
The details of the service discovery registries to assign to this task set. For more information, see Service discovery.
serviceRegistries - The details of the service discovery registries to assign to this task set. For more information, see
Service
discovery.CreateTaskSetRequest.Builder serviceRegistries(ServiceRegistry... serviceRegistries)
The details of the service discovery registries to assign to this task set. For more information, see Service discovery.
serviceRegistries - The details of the service discovery registries to assign to this task set. For more information, see
Service
discovery.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 via ServiceRegistry.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and
its result is passed to #serviceRegistries(List.
serviceRegistries - a consumer that will call methods on
ServiceRegistry.Builder#serviceRegistries(java.util.Collection) CreateTaskSetRequest.Builder launchType(String 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.
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.
LaunchType,
LaunchTypeCreateTaskSetRequest.Builder launchType(LaunchType 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.
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.
LaunchType,
LaunchTypeCreateTaskSetRequest.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 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.
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.
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 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.
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.
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 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.
This is a convenience method that creates an instance of theCapacityProviderStrategyItem.Builder avoiding the need to
create one manually via
CapacityProviderStrategyItem.builder().
When the Consumer completes,
SdkBuilder.build() is called
immediately and its result is passed to #capacityProviderStrategy(List.
capacityProviderStrategy - a consumer that will call methods on
CapacityProviderStrategyItem.Builder#capacityProviderStrategy(java.util.Collection) CreateTaskSetRequest.Builder platformVersion(String 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.
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.CreateTaskSetRequest.Builder scale(Scale scale)
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
scale - A floating-point percentage of the desired number of tasks to place and keep running in the task set.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.
This is a convenience method that creates an instance of theScale.Builder avoiding the need to
create one manually via Scale.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result is
passed to scale(Scale).
scale - a consumer that will call methods on Scale.Builderscale(Scale)CreateTaskSetRequest.Builder clientToken(String 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.
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.CreateTaskSetRequest.Builder tags(Collection<Tag> 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.
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.
CreateTaskSetRequest.Builder tags(Tag... 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.
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.
CreateTaskSetRequest.Builder tags(Consumer<Tag.Builder>... 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 via
Tag.builder().
When the Consumer completes, SdkBuilder.build() is
called immediately and its result is passed to #tags(List.
tags - a consumer that will call methods on Tag.Builder#tags(java.util.Collection) CreateTaskSetRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateTaskSetRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.