Package software.amazon.awssdk.services.scheduler.model

Class EcsParameters

java.lang.Object
software.amazon.awssdk.services.scheduler.model.EcsParameters
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EcsParameters.Builder,EcsParameters>
@Generated("software.amazon.awssdk:codegen") public final class EcsParameters extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EcsParameters.Builder,EcsParameters>

The templated target type for the Amazon ECS RunTask API operation.

See Also:

  • Method Details

    • hasCapacityProviderStrategy

      public final boolean hasCapacityProviderStrategy()
      For responses, this returns true if the service returned a value for the CapacityProviderStrategy 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.

    • capacityProviderStrategy

      public final List<CapacityProviderStrategyItem> capacityProviderStrategy()

      The capacity provider strategy to use for the task.

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

      Returns:
      The capacity provider strategy to use for the task.

    • enableECSManagedTags

      public final Boolean enableECSManagedTags()

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

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

    • enableExecuteCommand

      public final Boolean enableExecuteCommand()

      Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.

      Returns:
      Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.

    • group

      public final String group()

      Specifies an ECS task group for the task. The maximum length is 255 characters.

      Returns:
      Specifies an ECS task group for the task. The maximum length is 255 characters.

    • launchType

      public final LaunchType launchType()

      Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon ECS Developer Guide.

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

      Returns:
      Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon ECS Developer Guide.
      See Also:

    • launchTypeAsString

      public final String launchTypeAsString()

      Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon ECS Developer Guide.

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

      Returns:
      Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon ECS Developer Guide.
      See Also:

    • networkConfiguration

      public final NetworkConfiguration networkConfiguration()

      This structure specifies the network configuration for an ECS task.

      Returns:
      This structure specifies the network configuration for an ECS task.

    • hasPlacementConstraints

      public final boolean hasPlacementConstraints()
      For responses, this returns true if the service returned a value for the PlacementConstraints 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.

    • placementConstraints

      public final List<PlacementConstraint> placementConstraints()

      An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).

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

      Returns:
      An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).

    • hasPlacementStrategy

      public final boolean hasPlacementStrategy()
      For responses, this returns true if the service returned a value for the PlacementStrategy 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.

    • placementStrategy

      public final List<PlacementStrategy> placementStrategy()

      The task placement strategy for a task or service.

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

      Returns:
      The task placement strategy for a task or service.

    • platformVersion

      public final String platformVersion()

      Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.

      Returns:
      Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.

    • propagateTags

      public final PropagateTags propagateTags()

      Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use Amazon ECS's TagResource API action.

      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 to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use Amazon ECS's TagResource API action.
      See Also:

    • propagateTagsAsString

      public final String propagateTagsAsString()

      Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use Amazon ECS's TagResource API action.

      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 to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use Amazon ECS's TagResource API action.
      See Also:

    • referenceId

      public final String referenceId()

      The reference ID to use for the task.

      Returns:
      The reference ID to use for the task.

    • 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<Map<String,String>> 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. For more information, see RunTask in the Amazon ECS API Reference.

      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. For more information, see RunTask in the Amazon ECS API Reference.

    • taskCount

      public final Integer taskCount()

      The number of tasks to create based on TaskDefinition. The default is 1.

      Returns:
      The number of tasks to create based on TaskDefinition. The default is 1.

    • taskDefinitionArn

      public final String taskDefinitionArn()

      The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.

      Returns:
      The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.

    • toBuilder

      public EcsParameters.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<EcsParameters.Builder,EcsParameters>
      Returns:
      a builder for type T

    • builder

      public static EcsParameters.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

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