software.amazon.awssdk.services.ecs.model

Class CreateTaskSetRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ecs.model.EcsRequest

software.amazon.awssdk.services.ecs.model.CreateTaskSetRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateTaskSetRequest.Builder,CreateTaskSetRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateTaskSetRequest
extends EcsRequest
implements ToCopyableBuilder<CreateTaskSetRequest.Builder,CreateTaskSetRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateTaskSetRequest.Builder

Method Summary

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() Unique, case-sensitive 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() Returns true if the CapacityProviderStrategy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasLoadBalancers() Returns true if the LoadBalancers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasServiceRegistries() Returns true if the ServiceRegistries property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
LaunchType	launchType() The launch type that new tasks in the task set will use.
String	launchTypeAsString() The launch type that new tasks in the task set will use.
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 should use.
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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

service

public final String service()

The short name or full Amazon Resource Name (ARN) of the service to create the task set in.

Returns:

The short name or full Amazon Resource Name (ARN) of the service to create the task set in.

cluster

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.

Returns:

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.

externalId

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 AWS Cloud Map attribute set to the provided value.

Returns:

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 AWS Cloud Map attribute set to the provided value.

taskDefinition

public final String taskDefinition()

The task definition for the tasks in the task set to use.

Returns:

The task definition for the tasks in the task set to use.

networkConfiguration

public final NetworkConfiguration networkConfiguration()

An object representing the network configuration for a task set.

Returns:

An object representing the network configuration for a task set.

hasLoadBalancers

public final boolean hasLoadBalancers()

Returns true if the LoadBalancers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

loadBalancers

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.

You can use hasLoadBalancers() to see if a value was sent in this field.

Returns:

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.

hasServiceRegistries

public final boolean hasServiceRegistries()

Returns true if the ServiceRegistries property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

serviceRegistries

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.

You can use hasServiceRegistries() to see if a value was sent in this field.

Returns:

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

launchType

public final LaunchType 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.

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

Returns:

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.

See Also:

LaunchType

launchTypeAsString

public final String launchTypeAsString()

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.

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

Returns:

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.

See Also:

LaunchType

hasCapacityProviderStrategy

public final boolean hasCapacityProviderStrategy()

Returns true if the CapacityProviderStrategy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

capacityProviderStrategy

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 AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS 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.

You can use hasCapacityProviderStrategy() to see if a value was sent in this field.

Returns:

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 AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS 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.

platformVersion

public final String 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.

Returns:

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.

scale

public final Scale scale()

A floating-point percentage of the desired number of tasks to place and keep running in the task set.

Returns:

A floating-point percentage of the desired number of tasks to place and keep running in the task set.

clientToken

public final String clientToken()

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

Returns:

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

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

You can use hasTags() to see if a value was sent in this field.

Returns:

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

toBuilder

public CreateTaskSetRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateTaskSetRequest.Builder,CreateTaskSetRequest>

Specified by:

toBuilder in class EcsRequest

builder

public static CreateTaskSetRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateTaskSetRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo