@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class EcsParameters extends Object implements Serializable, Cloneable, StructuredPojo
The templated target type for the Amazon ECS RunTask
API
operation.
Constructor and Description |
---|
EcsParameters() |
Modifier and Type | Method and Description |
---|---|
EcsParameters |
clone() |
boolean |
equals(Object obj) |
List<CapacityProviderStrategyItem> |
getCapacityProviderStrategy()
The capacity provider strategy to use for the task.
|
Boolean |
getEnableECSManagedTags()
Specifies whether to enable Amazon ECS managed tags for the task.
|
Boolean |
getEnableExecuteCommand()
Whether or not to enable the execute command functionality for the containers in this task.
|
String |
getGroup()
Specifies an ECS task group for the task.
|
String |
getLaunchType()
Specifies the launch type on which your task is running.
|
NetworkConfiguration |
getNetworkConfiguration()
This structure specifies the network configuration for an ECS task.
|
List<PlacementConstraint> |
getPlacementConstraints()
An array of placement constraint objects to use for the task.
|
List<PlacementStrategy> |
getPlacementStrategy()
The task placement strategy for a task or service.
|
String |
getPlatformVersion()
Specifies the platform version for the task.
|
String |
getPropagateTags()
Specifies whether to propagate the tags from the task definition to the task.
|
String |
getReferenceId()
The reference ID to use for the task.
|
List<Map<String,String>> |
getTags()
The metadata that you apply to the task to help you categorize and organize them.
|
Integer |
getTaskCount()
The number of tasks to create based on
TaskDefinition . |
String |
getTaskDefinitionArn()
The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.
|
int |
hashCode() |
Boolean |
isEnableECSManagedTags()
Specifies whether to enable Amazon ECS managed tags for the task.
|
Boolean |
isEnableExecuteCommand()
Whether or not to enable the execute command functionality for the containers in this task.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)
The capacity provider strategy to use for the task.
|
void |
setEnableECSManagedTags(Boolean enableECSManagedTags)
Specifies whether to enable Amazon ECS managed tags for the task.
|
void |
setEnableExecuteCommand(Boolean enableExecuteCommand)
Whether or not to enable the execute command functionality for the containers in this task.
|
void |
setGroup(String group)
Specifies an ECS task group for the task.
|
void |
setLaunchType(String launchType)
Specifies the launch type on which your task is running.
|
void |
setNetworkConfiguration(NetworkConfiguration networkConfiguration)
This structure specifies the network configuration for an ECS task.
|
void |
setPlacementConstraints(Collection<PlacementConstraint> placementConstraints)
An array of placement constraint objects to use for the task.
|
void |
setPlacementStrategy(Collection<PlacementStrategy> placementStrategy)
The task placement strategy for a task or service.
|
void |
setPlatformVersion(String platformVersion)
Specifies the platform version for the task.
|
void |
setPropagateTags(String propagateTags)
Specifies whether to propagate the tags from the task definition to the task.
|
void |
setReferenceId(String referenceId)
The reference ID to use for the task.
|
void |
setTags(Collection<Map<String,String>> tags)
The metadata that you apply to the task to help you categorize and organize them.
|
void |
setTaskCount(Integer taskCount)
The number of tasks to create based on
TaskDefinition . |
void |
setTaskDefinitionArn(String taskDefinitionArn)
The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.
|
String |
toString()
Returns a string representation of this object.
|
EcsParameters |
withCapacityProviderStrategy(CapacityProviderStrategyItem... capacityProviderStrategy)
The capacity provider strategy to use for the task.
|
EcsParameters |
withCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)
The capacity provider strategy to use for the task.
|
EcsParameters |
withEnableECSManagedTags(Boolean enableECSManagedTags)
Specifies whether to enable Amazon ECS managed tags for the task.
|
EcsParameters |
withEnableExecuteCommand(Boolean enableExecuteCommand)
Whether or not to enable the execute command functionality for the containers in this task.
|
EcsParameters |
withGroup(String group)
Specifies an ECS task group for the task.
|
EcsParameters |
withLaunchType(LaunchType launchType)
Specifies the launch type on which your task is running.
|
EcsParameters |
withLaunchType(String launchType)
Specifies the launch type on which your task is running.
|
EcsParameters |
withNetworkConfiguration(NetworkConfiguration networkConfiguration)
This structure specifies the network configuration for an ECS task.
|
EcsParameters |
withPlacementConstraints(Collection<PlacementConstraint> placementConstraints)
An array of placement constraint objects to use for the task.
|
EcsParameters |
withPlacementConstraints(PlacementConstraint... placementConstraints)
An array of placement constraint objects to use for the task.
|
EcsParameters |
withPlacementStrategy(Collection<PlacementStrategy> placementStrategy)
The task placement strategy for a task or service.
|
EcsParameters |
withPlacementStrategy(PlacementStrategy... placementStrategy)
The task placement strategy for a task or service.
|
EcsParameters |
withPlatformVersion(String platformVersion)
Specifies the platform version for the task.
|
EcsParameters |
withPropagateTags(PropagateTags propagateTags)
Specifies whether to propagate the tags from the task definition to the task.
|
EcsParameters |
withPropagateTags(String propagateTags)
Specifies whether to propagate the tags from the task definition to the task.
|
EcsParameters |
withReferenceId(String referenceId)
The reference ID to use for the task.
|
EcsParameters |
withTags(Collection<Map<String,String>> tags)
The metadata that you apply to the task to help you categorize and organize them.
|
EcsParameters |
withTags(Map<String,String>... tags)
The metadata that you apply to the task to help you categorize and organize them.
|
EcsParameters |
withTaskCount(Integer taskCount)
The number of tasks to create based on
TaskDefinition . |
EcsParameters |
withTaskDefinitionArn(String taskDefinitionArn)
The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.
|
public List<CapacityProviderStrategyItem> getCapacityProviderStrategy()
The capacity provider strategy to use for the task.
public void setCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)
The capacity provider strategy to use for the task.
capacityProviderStrategy
- The capacity provider strategy to use for the task.public EcsParameters withCapacityProviderStrategy(CapacityProviderStrategyItem... capacityProviderStrategy)
The capacity provider strategy to use for the task.
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.public EcsParameters withCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)
The capacity provider strategy to use for the task.
capacityProviderStrategy
- The capacity provider strategy to use for the task.public void setEnableECSManagedTags(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.
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.public Boolean getEnableECSManagedTags()
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.
public EcsParameters withEnableECSManagedTags(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.
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.public Boolean isEnableECSManagedTags()
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.
public void setEnableExecuteCommand(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.
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 Boolean getEnableExecuteCommand()
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 EcsParameters withEnableExecuteCommand(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.
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 Boolean isEnableExecuteCommand()
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 void setGroup(String group)
Specifies an ECS task group for the task. The maximum length is 255 characters.
group
- Specifies an ECS task group for the task. The maximum length is 255 characters.public String getGroup()
Specifies an ECS task group for the task. The maximum length is 255 characters.
public EcsParameters withGroup(String group)
Specifies an ECS task group for the task. The maximum length is 255 characters.
group
- Specifies an ECS task group for the task. The maximum length is 255 characters.public void setLaunchType(String 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.
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.LaunchType
public String getLaunchType()
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.
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.LaunchType
public EcsParameters withLaunchType(String 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.
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.LaunchType
public EcsParameters withLaunchType(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.
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.LaunchType
public void setNetworkConfiguration(NetworkConfiguration networkConfiguration)
This structure specifies the network configuration for an ECS task.
networkConfiguration
- This structure specifies the network configuration for an ECS task.public NetworkConfiguration getNetworkConfiguration()
This structure specifies the network configuration for an ECS task.
public EcsParameters withNetworkConfiguration(NetworkConfiguration networkConfiguration)
This structure specifies the network configuration for an ECS task.
networkConfiguration
- This structure specifies the network configuration for an ECS task.public List<PlacementConstraint> getPlacementConstraints()
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).
public void setPlacementConstraints(Collection<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).
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).public EcsParameters withPlacementConstraints(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).
NOTE: This method appends the values to the existing list (if any). Use
setPlacementConstraints(java.util.Collection)
or withPlacementConstraints(java.util.Collection)
if you want to override the existing values.
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).public EcsParameters withPlacementConstraints(Collection<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).
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).public List<PlacementStrategy> getPlacementStrategy()
The task placement strategy for a task or service.
public void setPlacementStrategy(Collection<PlacementStrategy> placementStrategy)
The task placement strategy for a task or service.
placementStrategy
- The task placement strategy for a task or service.public EcsParameters withPlacementStrategy(PlacementStrategy... placementStrategy)
The task placement strategy for a task or service.
NOTE: This method appends the values to the existing list (if any). Use
setPlacementStrategy(java.util.Collection)
or withPlacementStrategy(java.util.Collection)
if
you want to override the existing values.
placementStrategy
- The task placement strategy for a task or service.public EcsParameters withPlacementStrategy(Collection<PlacementStrategy> placementStrategy)
The task placement strategy for a task or service.
placementStrategy
- The task placement strategy for a task or service.public void setPlatformVersion(String platformVersion)
Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as
1.1.0
.
platformVersion
- Specifies the platform version for the task. Specify only the numeric portion of the platform version,
such as 1.1.0
.public String getPlatformVersion()
Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as
1.1.0
.
1.1.0
.public EcsParameters withPlatformVersion(String platformVersion)
Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as
1.1.0
.
platformVersion
- Specifies the platform version for the task. Specify only the numeric portion of the platform version,
such as 1.1.0
.public void setPropagateTags(String 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.
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.PropagateTags
public String getPropagateTags()
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.
TagResource
API action.PropagateTags
public EcsParameters withPropagateTags(String 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.
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.PropagateTags
public EcsParameters withPropagateTags(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.
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.PropagateTags
public void setReferenceId(String referenceId)
The reference ID to use for the task.
referenceId
- The reference ID to use for the task.public String getReferenceId()
The reference ID to use for the task.
public EcsParameters withReferenceId(String referenceId)
The reference ID to use for the task.
referenceId
- The reference ID to use for the task.public List<Map<String,String>> getTags()
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.
RunTask
in the Amazon ECS API Reference.public void setTags(Collection<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.
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.public EcsParameters withTags(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.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
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.public EcsParameters withTags(Collection<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.
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.public void setTaskCount(Integer taskCount)
The number of tasks to create based on TaskDefinition
. The default is 1
.
taskCount
- The number of tasks to create based on TaskDefinition
. The default is 1
.public Integer getTaskCount()
The number of tasks to create based on TaskDefinition
. The default is 1
.
TaskDefinition
. The default is 1
.public EcsParameters withTaskCount(Integer taskCount)
The number of tasks to create based on TaskDefinition
. The default is 1
.
taskCount
- The number of tasks to create based on TaskDefinition
. The default is 1
.public void setTaskDefinitionArn(String taskDefinitionArn)
The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.
taskDefinitionArn
- The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.public String getTaskDefinitionArn()
The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.
public EcsParameters withTaskDefinitionArn(String taskDefinitionArn)
The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.
taskDefinitionArn
- The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.public String toString()
toString
in class Object
Object.toString()
public EcsParameters clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.