@Generated(value="software.amazon.awssdk:codegen") public final class CreateTaskSetRequest extends EcsRequest implements ToCopyableBuilder<CreateTaskSetRequest.Builder,CreateTaskSetRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateTaskSetRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static CreateTaskSetRequest.Builder |
builder() |
List<CapacityProviderStrategyItem> |
capacityProviderStrategy()
The capacity provider strategy to use for the task set.
|
String |
clientToken()
The identifier that you provide to ensure the idempotency of the request.
|
String |
cluster()
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set
in.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
String |
externalId()
An optional non-unique tag that identifies this task set in external systems.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasCapacityProviderStrategy()
For responses, this returns true if the service returned a value for the CapacityProviderStrategy property.
|
int |
hashCode() |
boolean |
hasLoadBalancers()
For responses, this returns true if the service returned a value for the LoadBalancers property.
|
boolean |
hasServiceRegistries()
For responses, this returns true if the service returned a value for the ServiceRegistries property.
|
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
LaunchType |
launchType()
The launch type that new tasks in the task set uses.
|
String |
launchTypeAsString()
The launch type that new tasks in the task set uses.
|
List<LoadBalancer> |
loadBalancers()
A load balancer object representing the load balancer to use with the task set.
|
NetworkConfiguration |
networkConfiguration()
An object representing the network configuration for a task set.
|
String |
platformVersion()
The platform version that the tasks in the task set uses.
|
Scale |
scale()
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateTaskSetRequest.Builder> |
serializableBuilderClass() |
String |
service()
The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
|
List<ServiceRegistry> |
serviceRegistries()
The details of the service discovery registries to assign to this task set.
|
List<Tag> |
tags()
The metadata that you apply to the task set to help you categorize and organize them.
|
String |
taskDefinition()
The task definition for the tasks in the task set to use.
|
CreateTaskSetRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String service()
The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
public final String cluster()
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
public final 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.
ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute set to the provided value.public final String taskDefinition()
The task definition for the tasks in the task set to use.
public final NetworkConfiguration networkConfiguration()
An object representing the network configuration for a task set.
public final boolean hasLoadBalancers()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasLoadBalancers() method.
public final boolean hasServiceRegistries()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<ServiceRegistry> serviceRegistries()
The details of the service discovery registries to assign to this task set. For more information, see Service Discovery.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasServiceRegistries() method.
public final 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.
If the service returns an enum value that is not available in the current SDK version, launchType will
return LaunchType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
launchTypeAsString().
If a launchType is specified, the capacityProviderStrategy parameter must be
omitted.
LaunchTypepublic final String launchTypeAsString()
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.
If the service returns an enum value that is not available in the current SDK version, launchType will
return LaunchType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
launchTypeAsString().
If a launchType is specified, the capacityProviderStrategy parameter must be
omitted.
LaunchTypepublic final boolean hasCapacityProviderStrategy()
isEmpty() method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasCapacityProviderStrategy() method.
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.
public final 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.
LATEST platform version is used.public final Scale scale()
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
public final 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.
public final boolean hasTags()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags() method.
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.
public CreateTaskSetRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateTaskSetRequest.Builder,CreateTaskSetRequest>toBuilder in class EcsRequestpublic static CreateTaskSetRequest.Builder builder()
public static Class<? extends CreateTaskSetRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2022. All rights reserved.