Package software.amazon.awssdk.services.ecs.model

Class StartTaskRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ecs.model.EcsRequest
software.amazon.awssdk.services.ecs.model.StartTaskRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartTaskRequest.Builder,StartTaskRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartTaskRequest extends EcsRequest implements ToCopyableBuilder<StartTaskRequest.Builder,StartTaskRequest>

  • Method Details

    • cluster

      public final String cluster()

      The short name or full Amazon Resource Name (ARN) of the cluster where 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 where to start your task. If you do not specify a cluster, the default cluster is assumed.

    • hasContainerInstances

      public final boolean hasContainerInstances()
      For responses, this returns true if the service returned a value for the ContainerInstances property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • containerInstances

      public final List<String> containerInstances()

      The container instance IDs or full ARN entries for the container instances where you would like to place your task. You can specify up to 10 container instances.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasContainerInstances() method.

      Returns:
      The container instance IDs or full ARN entries for the container instances where you would like to place your task. You can specify up to 10 container instances.

    • enableECSManagedTags

      public final Boolean enableECSManagedTags()

      Specifies whether to use Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

      Returns:
      Specifies whether to use Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

    • enableExecuteCommand

      public final Boolean enableExecuteCommand()

      Whether or not the execute command functionality is turned on for the task. If true, this turns on the execute command functionality on all containers in the task.

      Returns:
      Whether or not the execute command functionality is turned on for the task. If true, this turns on the execute command functionality on all containers in the task.

    • group

      public final String group()

      The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).

      Returns:
      The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).

    • networkConfiguration

      public final NetworkConfiguration networkConfiguration()

      The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

      Returns:
      The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

    • overrides

      public final 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 receives. You can override the default command for a container (that's 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 receives. You can override the default command for a container (that's 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.

    • propagateTags

      public final PropagateTags propagateTags()

      Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.

      If the service returns an enum value that is not available in the current SDK version, propagateTags will return PropagateTags.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from propagateTagsAsString().

      Returns:
      Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.
      See Also:

    • propagateTagsAsString

      public final String propagateTagsAsString()

      Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.

      If the service returns an enum value that is not available in the current SDK version, propagateTags will return PropagateTags.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from propagateTagsAsString().

      Returns:
      Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.
      See Also:

    • referenceId

      public final String referenceId()

      The reference ID to use for the task.

      Returns:
      The reference ID to use for the task.

    • startedBy

      public final 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 (-), forward slash (/), and underscores (_) are allowed.

      If a task is started by an Amazon ECS service, 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 (-), forward slash (/), and underscores (_) are allowed.

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

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

      The following basic restrictions apply to tags:

      • Maximum number of tags per resource - 50

      • For each resource, each tag key must be unique, and each tag key can have only one value.

      • Maximum key length - 128 Unicode characters in UTF-8

      • Maximum value length - 256 Unicode characters in UTF-8

      • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

      • Tag keys and values are case-sensitive.

      • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

      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.

    • taskDefinition

      public final String taskDefinition()

      The family and revision (family:revision) or full ARN of the task definition to start. If a revision isn't specified, the latest ACTIVE revision is used.

      Returns:
      The family and revision (family:revision) or full ARN of the task definition to start. If a revision isn't specified, the latest ACTIVE revision is used.

    • hasVolumeConfigurations

      public final boolean hasVolumeConfigurations()
      For responses, this returns true if the service returned a value for the VolumeConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • volumeConfigurations

      public final List<TaskVolumeConfiguration> volumeConfigurations()

      The details of the volume that was configuredAtLaunch. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in TaskManagedEBSVolumeConfiguration. The name of the volume must match the name from the task definition.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVolumeConfigurations() method.

      Returns:
      The details of the volume that was configuredAtLaunch. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in TaskManagedEBSVolumeConfiguration. The name of the volume must match the name from the task definition.

    • toBuilder

      public StartTaskRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<StartTaskRequest.Builder,StartTaskRequest>
      Specified by:
      toBuilder in class EcsRequest
      Returns:
      a builder for type T

    • builder

      public static StartTaskRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.