@Generated(value="software.amazon.awssdk:codegen") public final class EcsParameters extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EcsParameters.Builder,EcsParameters>
The custom parameters to be used when the target is an Amazon ECS task.
Modifier and Type | Class and Description |
---|---|
static interface |
EcsParameters.Builder |
Modifier and Type | Method and Description |
---|---|
static EcsParameters.Builder |
builder() |
List<CapacityProviderStrategyItem> |
capacityProviderStrategy()
The capacity provider strategy to use for the task.
|
Boolean |
enableECSManagedTags()
Specifies whether to enable Amazon ECS managed tags for the task.
|
Boolean |
enableExecuteCommand()
Whether or not to enable the execute command functionality for the containers in this task.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
String |
group()
Specifies an ECS task group for the task.
|
boolean |
hasCapacityProviderStrategy()
For responses, this returns true if the service returned a value for the CapacityProviderStrategy property.
|
int |
hashCode() |
boolean |
hasPlacementConstraints()
For responses, this returns true if the service returned a value for the PlacementConstraints property.
|
boolean |
hasPlacementStrategy()
For responses, this returns true if the service returned a value for the PlacementStrategy property.
|
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
LaunchType |
launchType()
Specifies the launch type on which your task is running.
|
String |
launchTypeAsString()
Specifies the launch type on which your task is running.
|
NetworkConfiguration |
networkConfiguration()
Use this structure if the Amazon ECS task uses the
awsvpc network mode. |
List<PlacementConstraint> |
placementConstraints()
An array of placement constraint objects to use for the task.
|
List<PlacementStrategy> |
placementStrategy()
The placement strategy objects to use for the task.
|
String |
platformVersion()
Specifies the platform version for the task.
|
PropagateTags |
propagateTags()
Specifies whether to propagate the tags from the task definition to the task.
|
String |
propagateTagsAsString()
Specifies whether to propagate the tags from the task definition to the task.
|
String |
referenceId()
The reference ID to use for the task.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends EcsParameters.Builder> |
serializableBuilderClass() |
List<Tag> |
tags()
The metadata that you apply to the task to help you categorize and organize them.
|
Integer |
taskCount()
The number of tasks to create based on
TaskDefinition . |
String |
taskDefinitionArn()
The ARN of the task definition to use if the event target is an Amazon ECS task.
|
EcsParameters.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String taskDefinitionArn()
The ARN of the task definition to use if the event target is an Amazon ECS task.
public final Integer taskCount()
The number of tasks to create based on TaskDefinition
. The default is 1.
TaskDefinition
. The default is 1.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 witt Amazon ECS is supported. For more information, see Fargate on Amazon ECS in
the Amazon Elastic Container Service 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()
.
FARGATE
value is supported
only in the Regions where Fargate witt Amazon ECS is supported. For more information, see Fargate on Amazon
ECS in the Amazon Elastic Container Service Developer Guide.LaunchType
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 witt Amazon ECS is supported. For more information, see Fargate on Amazon ECS in
the Amazon Elastic Container Service 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()
.
FARGATE
value is supported
only in the Regions where Fargate witt Amazon ECS is supported. For more information, see Fargate on Amazon
ECS in the Amazon Elastic Container Service Developer Guide.LaunchType
public final NetworkConfiguration networkConfiguration()
Use this structure if the Amazon ECS task uses the awsvpc
network mode. This structure specifies the
VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This
structure is required if LaunchType
is FARGATE
because the awsvpc
mode is
required for Fargate tasks.
If you specify NetworkConfiguration
when the target ECS task does not use the awsvpc
network mode, the task fails.
awsvpc
network mode. This structure
specifies the VPC subnets and security groups associated with the task, and whether a public IP address
is to be used. This structure is required if LaunchType
is FARGATE
because the
awsvpc
mode is required for Fargate tasks.
If you specify NetworkConfiguration
when the target ECS task does not use the
awsvpc
network mode, the task fails.
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
.
This structure is used only if LaunchType
is FARGATE
. For more information about valid
platform versions, see Fargate Platform
Versions in the Amazon Elastic Container Service Developer Guide.
1.1.0
.
This structure is used only if LaunchType
is FARGATE
. For more information
about valid platform versions, see Fargate
Platform Versions in the Amazon Elastic Container Service Developer Guide.
public final String group()
Specifies an ECS task group for the task. The maximum length is 255 characters.
public final boolean hasCapacityProviderStrategy()
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.public final List<CapacityProviderStrategyItem> capacityProviderStrategy()
The capacity provider strategy to use for the task.
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.
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.
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.
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 Elastic Container Service Developer Guide.
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.
public final boolean hasPlacementConstraints()
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.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.
public final boolean hasPlacementStrategy()
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.public final List<PlacementStrategy> placementStrategy()
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per 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 hasPlacementStrategy()
method.
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 the 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()
.
PropagateTags
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 the 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()
.
PropagateTags
public final String referenceId()
The reference ID to use for the task.
public final boolean hasTags()
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.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. To learn more, 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.
public EcsParameters.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<EcsParameters.Builder,EcsParameters>
public static EcsParameters.Builder builder()
public static Class<? extends EcsParameters.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2022. All rights reserved.