@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateTaskSetRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateTaskSetRequest() |
Modifier and Type | Method and Description |
---|---|
CreateTaskSetRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
List<CapacityProviderStrategyItem> |
getCapacityProviderStrategy()
The capacity provider strategy to use for the task set.
|
String |
getClientToken()
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
|
String |
getCluster()
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set
in.
|
String |
getExternalId()
An optional non-unique tag that identifies this task set in external systems.
|
String |
getLaunchType()
The launch type that new tasks in the task set will use.
|
List<LoadBalancer> |
getLoadBalancers()
A load balancer object representing the load balancer to use with the task set.
|
NetworkConfiguration |
getNetworkConfiguration() |
String |
getPlatformVersion()
The platform version that the tasks in the task set should use.
|
Scale |
getScale() |
String |
getService()
The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
|
List<ServiceRegistry> |
getServiceRegistries()
The details of the service discovery registries to assign to this task set.
|
String |
getTaskDefinition()
The task definition for the tasks in the task set to use.
|
int |
hashCode() |
void |
setCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)
The capacity provider strategy to use for the task set.
|
void |
setClientToken(String clientToken)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
|
void |
setCluster(String cluster)
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set
in.
|
void |
setExternalId(String externalId)
An optional non-unique tag that identifies this task set in external systems.
|
void |
setLaunchType(String launchType)
The launch type that new tasks in the task set will use.
|
void |
setLoadBalancers(Collection<LoadBalancer> loadBalancers)
A load balancer object representing the load balancer to use with the task set.
|
void |
setNetworkConfiguration(NetworkConfiguration networkConfiguration) |
void |
setPlatformVersion(String platformVersion)
The platform version that the tasks in the task set should use.
|
void |
setScale(Scale scale) |
void |
setService(String service)
The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
|
void |
setServiceRegistries(Collection<ServiceRegistry> serviceRegistries)
The details of the service discovery registries to assign to this task set.
|
void |
setTaskDefinition(String taskDefinition)
The task definition for the tasks in the task set to use.
|
String |
toString()
Returns a string representation of this object.
|
CreateTaskSetRequest |
withCapacityProviderStrategy(CapacityProviderStrategyItem... capacityProviderStrategy)
The capacity provider strategy to use for the task set.
|
CreateTaskSetRequest |
withCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)
The capacity provider strategy to use for the task set.
|
CreateTaskSetRequest |
withClientToken(String clientToken)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
|
CreateTaskSetRequest |
withCluster(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 |
withExternalId(String externalId)
An optional non-unique tag that identifies this task set in external systems.
|
CreateTaskSetRequest |
withLaunchType(LaunchType launchType)
The launch type that new tasks in the task set will use.
|
CreateTaskSetRequest |
withLaunchType(String launchType)
The launch type that new tasks in the task set will use.
|
CreateTaskSetRequest |
withLoadBalancers(Collection<LoadBalancer> loadBalancers)
A load balancer object representing the load balancer to use with the task set.
|
CreateTaskSetRequest |
withLoadBalancers(LoadBalancer... loadBalancers)
A load balancer object representing the load balancer to use with the task set.
|
CreateTaskSetRequest |
withNetworkConfiguration(NetworkConfiguration networkConfiguration) |
CreateTaskSetRequest |
withPlatformVersion(String platformVersion)
The platform version that the tasks in the task set should use.
|
CreateTaskSetRequest |
withScale(Scale scale) |
CreateTaskSetRequest |
withService(String service)
The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
|
CreateTaskSetRequest |
withServiceRegistries(Collection<ServiceRegistry> serviceRegistries)
The details of the service discovery registries to assign to this task set.
|
CreateTaskSetRequest |
withServiceRegistries(ServiceRegistry... serviceRegistries)
The details of the service discovery registries to assign to this task set.
|
CreateTaskSetRequest |
withTaskDefinition(String taskDefinition)
The task definition for the tasks in the task set to use.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setService(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.public String getService()
The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
public CreateTaskSetRequest withService(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.public void setCluster(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.public String getCluster()
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
public CreateTaskSetRequest withCluster(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.public void setExternalId(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.
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.public String getExternalId()
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.
ECS_TASK_SET_EXTERNAL_ID
AWS Cloud Map attribute set to the provided value.public CreateTaskSetRequest withExternalId(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.
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.public void setTaskDefinition(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.public String getTaskDefinition()
The task definition for the tasks in the task set to use.
public CreateTaskSetRequest withTaskDefinition(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.public void setNetworkConfiguration(NetworkConfiguration networkConfiguration)
networkConfiguration
- public NetworkConfiguration getNetworkConfiguration()
public CreateTaskSetRequest withNetworkConfiguration(NetworkConfiguration networkConfiguration)
networkConfiguration
- public List<LoadBalancer> getLoadBalancers()
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(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.public CreateTaskSetRequest withLoadBalancers(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.
NOTE: This method appends the values to the existing list (if any). Use
setLoadBalancers(java.util.Collection)
or withLoadBalancers(java.util.Collection)
if you want
to override the existing values.
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 CreateTaskSetRequest withLoadBalancers(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.public List<ServiceRegistry> getServiceRegistries()
The details of the service discovery registries to assign to this task set. For more information, see Service Discovery.
public void setServiceRegistries(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.public CreateTaskSetRequest withServiceRegistries(ServiceRegistry... 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
setServiceRegistries(java.util.Collection)
or withServiceRegistries(java.util.Collection)
if
you want to override the existing values.
serviceRegistries
- The details of the service discovery registries to assign to this task set. For more information, see Service
Discovery.public CreateTaskSetRequest withServiceRegistries(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.public void setLaunchType(String 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.
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.
LaunchType
public String getLaunchType()
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 a launchType
is specified, the capacityProviderStrategy
parameter must be
omitted.
LaunchType
public CreateTaskSetRequest withLaunchType(String 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.
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.
LaunchType
public CreateTaskSetRequest withLaunchType(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.
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.
LaunchType
public List<CapacityProviderStrategyItem> getCapacityProviderStrategy()
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.
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.
public void setCapacityProviderStrategy(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 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.
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.
public CreateTaskSetRequest withCapacityProviderStrategy(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.
NOTE: This method appends the values to the existing list (if any). Use
setCapacityProviderStrategy(java.util.Collection)
or
withCapacityProviderStrategy(java.util.Collection)
if you want to override the existing values.
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.
public CreateTaskSetRequest withCapacityProviderStrategy(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 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.
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.
public void setPlatformVersion(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.
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.public String getPlatformVersion()
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.
LATEST
platform version is
used by default.public CreateTaskSetRequest withPlatformVersion(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.
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.public void setScale(Scale scale)
scale
- public Scale getScale()
public CreateTaskSetRequest withScale(Scale scale)
scale
- public void setClientToken(String clientToken)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
clientToken
- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32
ASCII characters are allowed.public String getClientToken()
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
public CreateTaskSetRequest withClientToken(String clientToken)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
clientToken
- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32
ASCII characters are allowed.public String toString()
toString
in class Object
Object.toString()
public CreateTaskSetRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.