Class StartTaskRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.ecs.model.StartTaskRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class StartTaskRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
See Also:
  • Constructor Details

    • StartTaskRequest

      public StartTaskRequest()
  • Method Details

    • setCluster

      public void setCluster(String cluster)

      The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed..

      Parameters:
      cluster - The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed..
    • getCluster

      public String getCluster()

      The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed..

      Returns:
      The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed..
    • withCluster

      public StartTaskRequest withCluster(String cluster)

      The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed..

      Parameters:
      cluster - The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed..
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setTaskDefinition

      public void setTaskDefinition(String taskDefinition)

      The family and revision ( family:revision) or full Amazon Resource Name (ARN) of the task definition to start. If a revision is not specified, the latest ACTIVE revision is used.

      Parameters:
      taskDefinition - The family and revision ( family:revision) or full Amazon Resource Name (ARN) of the task definition to start. If a revision is not specified, the latest ACTIVE revision is used.
    • getTaskDefinition

      public String getTaskDefinition()

      The family and revision ( family:revision) or full Amazon Resource Name (ARN) of the task definition to start. If a revision is not specified, the latest ACTIVE revision is used.

      Returns:
      The family and revision ( family:revision) or full Amazon Resource Name (ARN) of the task definition to start. If a revision is not specified, the latest ACTIVE revision is used.
    • withTaskDefinition

      public StartTaskRequest withTaskDefinition(String taskDefinition)

      The family and revision ( family:revision) or full Amazon Resource Name (ARN) of the task definition to start. If a revision is not specified, the latest ACTIVE revision is used.

      Parameters:
      taskDefinition - The family and revision ( family:revision) or full Amazon Resource Name (ARN) of the task definition to start. If a revision is not specified, the latest ACTIVE revision is used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setOverrides

      public void setOverrides(TaskOverride overrides)

      A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

      A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

      Parameters:
      overrides - A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

      A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

    • getOverrides

      public TaskOverride getOverrides()

      A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

      A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

      Returns:
      A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

      A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

    • withOverrides

      public StartTaskRequest withOverrides(TaskOverride overrides)

      A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

      A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

      Parameters:
      overrides - A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

      A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getContainerInstances

      public List<String> getContainerInstances()

      The container instance IDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.

      The list of container instances to start tasks on is limited to 10.

      Returns:
      The container instance IDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.

      The list of container instances to start tasks on is limited to 10.

    • setContainerInstances

      public void setContainerInstances(Collection<String> containerInstances)

      The container instance IDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.

      The list of container instances to start tasks on is limited to 10.

      Parameters:
      containerInstances - The container instance IDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.

      The list of container instances to start tasks on is limited to 10.

    • withContainerInstances

      public StartTaskRequest withContainerInstances(String... containerInstances)

      The container instance IDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.

      The list of container instances to start tasks on is limited to 10.

      NOTE: This method appends the values to the existing list (if any). Use setContainerInstances(java.util.Collection) or withContainerInstances(java.util.Collection) if you want to override the existing values.

      Parameters:
      containerInstances - The container instance IDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.

      The list of container instances to start tasks on is limited to 10.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • withContainerInstances

      public StartTaskRequest withContainerInstances(Collection<String> containerInstances)

      The container instance IDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.

      The list of container instances to start tasks on is limited to 10.

      Parameters:
      containerInstances - The container instance IDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.

      The list of container instances to start tasks on is limited to 10.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setStartedBy

      public void setStartedBy(String startedBy)

      An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

      If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

      Parameters:
      startedBy - An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

      If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

    • getStartedBy

      public String getStartedBy()

      An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

      If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

      Returns:
      An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

      If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

    • withStartedBy

      public StartTaskRequest withStartedBy(String startedBy)

      An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

      If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

      Parameters:
      startedBy - An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

      If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • toString

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public StartTaskRequest clone()
      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: