com.amazonaws.services.ecs.model.CreateTaskSetRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ecs Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ecs.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateTaskSetRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
*
*/
private String service;
/**
*
* The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set
* in.
*
*/
private String cluster;
/**
*
* 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.
*
*/
private String externalId;
/**
*
* The task definition for the tasks in the task set to use. If a revision isn't specified, the latest
* ACTIVE revision is used.
*
*/
private String taskDefinition;
/**
*
* An object representing the network configuration for a task set.
*
*/
private NetworkConfiguration networkConfiguration;
/**
*
* 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.
*
*/
private com.amazonaws.internal.SdkInternalList loadBalancers;
/**
*
* The details of the service discovery registries to assign to this task set. For more information, see Service discovery.
*
*/
private com.amazonaws.internal.SdkInternalList serviceRegistries;
/**
*
* 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.
*
*/
private String launchType;
/**
*
* 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.
*
*/
private com.amazonaws.internal.SdkInternalList capacityProviderStrategy;
/**
*
* 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.
*
*/
private String platformVersion;
/**
*
* A floating-point percentage of the desired number of tasks to place and keep running in the task set.
*
*/
private Scale scale;
/**
*
* 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.
*
*/
private String clientToken;
/**
*
* 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.
*
*
*
*/
private com.amazonaws.internal.SdkInternalList tags;
/**
*
* The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
*
*
* @param service
* The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
*/
public void setService(String service) {
this.service = service;
}
/**
*
* The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
*
*
* @return The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
*/
public String getService() {
return this.service;
}
/**
*
* The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
*
*
* @param service
* The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateTaskSetRequest withService(String service) {
setService(service);
return this;
}
/**
*
* The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set
* in.
*
*
* @param cluster
* The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task
* set in.
*/
public void setCluster(String cluster) {
this.cluster = cluster;
}
/**
*
* The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set
* in.
*
*
* @return The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the
* task set in.
*/
public String getCluster() {
return this.cluster;
}
/**
*
* The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set
* in.
*
*
* @param cluster
* The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task
* set in.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateTaskSetRequest withCluster(String cluster) {
setCluster(cluster);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setExternalId(String externalId) {
this.externalId = 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.
*
*
* @return 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.
*/
public String getExternalId() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateTaskSetRequest withExternalId(String externalId) {
setExternalId(externalId);
return this;
}
/**
*
* The task definition for the tasks in the task set to use. If a revision isn't specified, the latest
* ACTIVE revision is used.
*
*
* @param 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.
*/
public void setTaskDefinition(String taskDefinition) {
this.taskDefinition = 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.
*
*
* @return The task definition for the tasks in the task set to use. If a revision isn't specified, the latest
* ACTIVE revision is used.
*/
public String getTaskDefinition() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateTaskSetRequest withTaskDefinition(String taskDefinition) {
setTaskDefinition(taskDefinition);
return this;
}
/**
*
* An object representing the network configuration for a task set.
*
*
* @param networkConfiguration
* An object representing the network configuration for a task set.
*/
public void setNetworkConfiguration(NetworkConfiguration networkConfiguration) {
this.networkConfiguration = networkConfiguration;
}
/**
*
* An object representing the network configuration for a task set.
*
*
* @return An object representing the network configuration for a task set.
*/
public NetworkConfiguration getNetworkConfiguration() {
return this.networkConfiguration;
}
/**
*
* An object representing the network configuration for a task set.
*
*
* @param networkConfiguration
* An object representing the network configuration for a task set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateTaskSetRequest withNetworkConfiguration(NetworkConfiguration networkConfiguration) {
setNetworkConfiguration(networkConfiguration);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public java.util.List getLoadBalancers() {
if (loadBalancers == null) {
loadBalancers = new com.amazonaws.internal.SdkInternalList();
}
return 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.
*
*
* @param 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.
*/
public void setLoadBalancers(java.util.Collection loadBalancers) {
if (loadBalancers == null) {
this.loadBalancers = null;
return;
}
this.loadBalancers = new com.amazonaws.internal.SdkInternalList(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.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setLoadBalancers(java.util.Collection)} or {@link #withLoadBalancers(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateTaskSetRequest withLoadBalancers(LoadBalancer... loadBalancers) {
if (this.loadBalancers == null) {
setLoadBalancers(new com.amazonaws.internal.SdkInternalList(loadBalancers.length));
}
for (LoadBalancer ele : loadBalancers) {
this.loadBalancers.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateTaskSetRequest withLoadBalancers(java.util.Collection loadBalancers) {
setLoadBalancers(loadBalancers);
return this;
}
/**
*
* The details of the service discovery registries to assign to this task set. For more information, see Service discovery.
*
*
* @return The details of the service discovery registries to assign to this task set. For more information, see Service
* discovery.
*/
public java.util.List getServiceRegistries() {
if (serviceRegistries == null) {
serviceRegistries = new com.amazonaws.internal.SdkInternalList();
}
return serviceRegistries;
}
/**
*
* The details of the service discovery registries to assign to this task set. For more information, see Service discovery.
*
*
* @param serviceRegistries
* The details of the service discovery registries to assign to this task set. For more information, see Service
* discovery.
*/
public void setServiceRegistries(java.util.Collection serviceRegistries) {
if (serviceRegistries == null) {
this.serviceRegistries = null;
return;
}
this.serviceRegistries = new com.amazonaws.internal.SdkInternalList(serviceRegistries);
}
/**
*
* The details of the service discovery registries to assign to this task set. For more information, see Service discovery.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setServiceRegistries(java.util.Collection)} or {@link #withServiceRegistries(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param serviceRegistries
* The details of the service discovery registries to assign to this task set. For more information, see Service
* discovery.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateTaskSetRequest withServiceRegistries(ServiceRegistry... serviceRegistries) {
if (this.serviceRegistries == null) {
setServiceRegistries(new com.amazonaws.internal.SdkInternalList(serviceRegistries.length));
}
for (ServiceRegistry ele : serviceRegistries) {
this.serviceRegistries.add(ele);
}
return this;
}
/**
*
* The details of the service discovery registries to assign to this task set. For more information, see Service discovery.
*
*
* @param serviceRegistries
* The details of the service discovery registries to assign to this task set. For more information, see Service
* discovery.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateTaskSetRequest withServiceRegistries(java.util.Collection serviceRegistries) {
setServiceRegistries(serviceRegistries);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @see LaunchType
*/
public void setLaunchType(String launchType) {
this.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.
*
*
* @return 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.
* @see LaunchType
*/
public String getLaunchType() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see LaunchType
*/
public CreateTaskSetRequest withLaunchType(String launchType) {
setLaunchType(launchType);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see LaunchType
*/
public CreateTaskSetRequest withLaunchType(LaunchType launchType) {
this.launchType = launchType.toString();
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public java.util.List getCapacityProviderStrategy() {
if (capacityProviderStrategy == null) {
capacityProviderStrategy = new com.amazonaws.internal.SdkInternalList();
}
return 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.
*
*
* @param 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.
*/
public void setCapacityProviderStrategy(java.util.Collection capacityProviderStrategy) {
if (capacityProviderStrategy == null) {
this.capacityProviderStrategy = null;
return;
}
this.capacityProviderStrategy = new com.amazonaws.internal.SdkInternalList(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.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setCapacityProviderStrategy(java.util.Collection)} or
* {@link #withCapacityProviderStrategy(java.util.Collection)} if you want to override the existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateTaskSetRequest withCapacityProviderStrategy(CapacityProviderStrategyItem... capacityProviderStrategy) {
if (this.capacityProviderStrategy == null) {
setCapacityProviderStrategy(new com.amazonaws.internal.SdkInternalList(capacityProviderStrategy.length));
}
for (CapacityProviderStrategyItem ele : capacityProviderStrategy) {
this.capacityProviderStrategy.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateTaskSetRequest withCapacityProviderStrategy(java.util.Collection capacityProviderStrategy) {
setCapacityProviderStrategy(capacityProviderStrategy);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setPlatformVersion(String platformVersion) {
this.platformVersion = 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.
*
*
* @return 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.
*/
public String getPlatformVersion() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateTaskSetRequest withPlatformVersion(String platformVersion) {
setPlatformVersion(platformVersion);
return this;
}
/**
*
* A floating-point percentage of the desired number of tasks to place and keep running in the task set.
*
*
* @param scale
* A floating-point percentage of the desired number of tasks to place and keep running in the task set.
*/
public void setScale(Scale scale) {
this.scale = scale;
}
/**
*
* A floating-point percentage of the desired number of tasks to place and keep running in the task set.
*
*
* @return A floating-point percentage of the desired number of tasks to place and keep running in the task set.
*/
public Scale getScale() {
return this.scale;
}
/**
*
* A floating-point percentage of the desired number of tasks to place and keep running in the task set.
*
*
* @param scale
* A floating-point percentage of the desired number of tasks to place and keep running in the task set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateTaskSetRequest withScale(Scale scale) {
setScale(scale);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setClientToken(String clientToken) {
this.clientToken = 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.
*
*
* @return 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.
*/
public String getClientToken() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateTaskSetRequest withClientToken(String clientToken) {
setClientToken(clientToken);
return this;
}
/**
*
* 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.
*
*
*
*
* @return 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.
*
*
*/
public java.util.List getTags() {
if (tags == null) {
tags = new com.amazonaws.internal.SdkInternalList();
}
return 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.
*
*
*
*
* @param 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.
*
*
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new com.amazonaws.internal.SdkInternalList(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.
*
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateTaskSetRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new com.amazonaws.internal.SdkInternalList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateTaskSetRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getService() != null)
sb.append("Service: ").append(getService()).append(",");
if (getCluster() != null)
sb.append("Cluster: ").append(getCluster()).append(",");
if (getExternalId() != null)
sb.append("ExternalId: ").append(getExternalId()).append(",");
if (getTaskDefinition() != null)
sb.append("TaskDefinition: ").append(getTaskDefinition()).append(",");
if (getNetworkConfiguration() != null)
sb.append("NetworkConfiguration: ").append(getNetworkConfiguration()).append(",");
if (getLoadBalancers() != null)
sb.append("LoadBalancers: ").append(getLoadBalancers()).append(",");
if (getServiceRegistries() != null)
sb.append("ServiceRegistries: ").append(getServiceRegistries()).append(",");
if (getLaunchType() != null)
sb.append("LaunchType: ").append(getLaunchType()).append(",");
if (getCapacityProviderStrategy() != null)
sb.append("CapacityProviderStrategy: ").append(getCapacityProviderStrategy()).append(",");
if (getPlatformVersion() != null)
sb.append("PlatformVersion: ").append(getPlatformVersion()).append(",");
if (getScale() != null)
sb.append("Scale: ").append(getScale()).append(",");
if (getClientToken() != null)
sb.append("ClientToken: ").append(getClientToken()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateTaskSetRequest == false)
return false;
CreateTaskSetRequest other = (CreateTaskSetRequest) obj;
if (other.getService() == null ^ this.getService() == null)
return false;
if (other.getService() != null && other.getService().equals(this.getService()) == false)
return false;
if (other.getCluster() == null ^ this.getCluster() == null)
return false;
if (other.getCluster() != null && other.getCluster().equals(this.getCluster()) == false)
return false;
if (other.getExternalId() == null ^ this.getExternalId() == null)
return false;
if (other.getExternalId() != null && other.getExternalId().equals(this.getExternalId()) == false)
return false;
if (other.getTaskDefinition() == null ^ this.getTaskDefinition() == null)
return false;
if (other.getTaskDefinition() != null && other.getTaskDefinition().equals(this.getTaskDefinition()) == false)
return false;
if (other.getNetworkConfiguration() == null ^ this.getNetworkConfiguration() == null)
return false;
if (other.getNetworkConfiguration() != null && other.getNetworkConfiguration().equals(this.getNetworkConfiguration()) == false)
return false;
if (other.getLoadBalancers() == null ^ this.getLoadBalancers() == null)
return false;
if (other.getLoadBalancers() != null && other.getLoadBalancers().equals(this.getLoadBalancers()) == false)
return false;
if (other.getServiceRegistries() == null ^ this.getServiceRegistries() == null)
return false;
if (other.getServiceRegistries() != null && other.getServiceRegistries().equals(this.getServiceRegistries()) == false)
return false;
if (other.getLaunchType() == null ^ this.getLaunchType() == null)
return false;
if (other.getLaunchType() != null && other.getLaunchType().equals(this.getLaunchType()) == false)
return false;
if (other.getCapacityProviderStrategy() == null ^ this.getCapacityProviderStrategy() == null)
return false;
if (other.getCapacityProviderStrategy() != null && other.getCapacityProviderStrategy().equals(this.getCapacityProviderStrategy()) == false)
return false;
if (other.getPlatformVersion() == null ^ this.getPlatformVersion() == null)
return false;
if (other.getPlatformVersion() != null && other.getPlatformVersion().equals(this.getPlatformVersion()) == false)
return false;
if (other.getScale() == null ^ this.getScale() == null)
return false;
if (other.getScale() != null && other.getScale().equals(this.getScale()) == false)
return false;
if (other.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getService() == null) ? 0 : getService().hashCode());
hashCode = prime * hashCode + ((getCluster() == null) ? 0 : getCluster().hashCode());
hashCode = prime * hashCode + ((getExternalId() == null) ? 0 : getExternalId().hashCode());
hashCode = prime * hashCode + ((getTaskDefinition() == null) ? 0 : getTaskDefinition().hashCode());
hashCode = prime * hashCode + ((getNetworkConfiguration() == null) ? 0 : getNetworkConfiguration().hashCode());
hashCode = prime * hashCode + ((getLoadBalancers() == null) ? 0 : getLoadBalancers().hashCode());
hashCode = prime * hashCode + ((getServiceRegistries() == null) ? 0 : getServiceRegistries().hashCode());
hashCode = prime * hashCode + ((getLaunchType() == null) ? 0 : getLaunchType().hashCode());
hashCode = prime * hashCode + ((getCapacityProviderStrategy() == null) ? 0 : getCapacityProviderStrategy().hashCode());
hashCode = prime * hashCode + ((getPlatformVersion() == null) ? 0 : getPlatformVersion().hashCode());
hashCode = prime * hashCode + ((getScale() == null) ? 0 : getScale().hashCode());
hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public CreateTaskSetRequest clone() {
return (CreateTaskSetRequest) super.clone();
}
}