com.amazonaws.services.eventbridge.model

Class EcsParameters

java.lang.Object

com.amazonaws.services.eventbridge.model.EcsParameters

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class EcsParameters
extends Object
implements Serializable, Cloneable, StructuredPojo

The custom parameters to be used when the target is an Amazon ECS task.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
EcsParameters()

Method Summary

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() Use this structure if the Amazon ECS task uses the awsvpc network mode.
List<PlacementConstraint>	getPlacementConstraints() An array of placement constraint objects to use for the task.
List<PlacementStrategy>	getPlacementStrategy() The placement strategy objects to use for the task.
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<Tag>	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 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) Use this structure if the Amazon ECS task uses the awsvpc network mode.
void	setPlacementConstraints(Collection<PlacementConstraint> placementConstraints) An array of placement constraint objects to use for the task.
void	setPlacementStrategy(Collection<PlacementStrategy> placementStrategy) The placement strategy objects to use for the task.
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<Tag> 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 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) Use this structure if the Amazon ECS task uses the awsvpc network mode.
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 placement strategy objects to use for the task.
EcsParameters	withPlacementStrategy(PlacementStrategy... placementStrategy) The placement strategy objects to use for the task.
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<Tag> tags) The metadata that you apply to the task to help you categorize and organize them.
EcsParameters	withTags(Tag... 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 ARN of the task definition to use if the event target is an Amazon ECS task.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EcsParameters

public EcsParameters()

Method Detail

setTaskDefinitionArn

public void setTaskDefinitionArn(String taskDefinitionArn)

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

Parameters:

taskDefinitionArn - The ARN of the task definition to use if the event target is an Amazon ECS task.

getTaskDefinitionArn

public String getTaskDefinitionArn()

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

Returns:

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

withTaskDefinitionArn

public EcsParameters withTaskDefinitionArn(String taskDefinitionArn)

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

Parameters:

taskDefinitionArn - The ARN of the task definition to use if the event target is an Amazon ECS task.

Returns:

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

setTaskCount

public void setTaskCount(Integer taskCount)

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

Parameters:

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

getTaskCount

public Integer getTaskCount()

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.

withTaskCount

public EcsParameters withTaskCount(Integer taskCount)

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

Parameters:

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

Returns:

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

setLaunchType

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 Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

Parameters:

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 Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

See Also:

LaunchType

getLaunchType

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 Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

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 Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

See Also:

LaunchType

withLaunchType

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 Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

Parameters:

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 Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

Returns:

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

See Also:

LaunchType

withLaunchType

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 Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

Parameters:

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 Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

Returns:

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

See Also:

LaunchType

setNetworkConfiguration

public void setNetworkConfiguration(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.

Parameters:

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.

getNetworkConfiguration

public NetworkConfiguration getNetworkConfiguration()

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.

Returns:

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.

withNetworkConfiguration

public EcsParameters withNetworkConfiguration(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.

Parameters:

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.

Returns:

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

setPlatformVersion

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.

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.

Parameters:

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.

getPlatformVersion

public String getPlatformVersion()

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.

Returns:

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.

withPlatformVersion

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.

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.

Parameters:

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.

Returns:

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

setGroup

public void setGroup(String group)

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

Parameters:

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

getGroup

public String getGroup()

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.

withGroup

public EcsParameters withGroup(String group)

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

Parameters:

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

Returns:

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

getCapacityProviderStrategy

public List<CapacityProviderStrategyItem> getCapacityProviderStrategy()

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.

Returns:

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.

setCapacityProviderStrategy

public void setCapacityProviderStrategy(Collection<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.

Parameters:

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.

withCapacityProviderStrategy

public EcsParameters withCapacityProviderStrategy(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.

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.

Parameters:

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.

Returns:

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

withCapacityProviderStrategy

public EcsParameters withCapacityProviderStrategy(Collection<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.

Parameters:

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.

Returns:

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

setEnableECSManagedTags

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 Elastic Container Service Developer Guide.

Parameters:

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.

getEnableECSManagedTags

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 Elastic Container Service 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 Elastic Container Service Developer Guide.

withEnableECSManagedTags

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 Elastic Container Service Developer Guide.

Parameters:

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.

Returns:

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

isEnableECSManagedTags

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 Elastic Container Service 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 Elastic Container Service Developer Guide.

setEnableExecuteCommand

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.

Parameters:

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.

getEnableExecuteCommand

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.

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.

withEnableExecuteCommand

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.

Parameters:

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:

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

isEnableExecuteCommand

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.

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.

getPlacementConstraints

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

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

setPlacementConstraints

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

Parameters:

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

withPlacementConstraints

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.

Parameters:

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

Returns:

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

withPlacementConstraints

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

Parameters:

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

Returns:

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

getPlacementStrategy

public List<PlacementStrategy> getPlacementStrategy()

The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

Returns:

The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

setPlacementStrategy

public void setPlacementStrategy(Collection<PlacementStrategy> placementStrategy)

The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

Parameters:

placementStrategy - The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

withPlacementStrategy

public EcsParameters withPlacementStrategy(PlacementStrategy... placementStrategy)

The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

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.

Parameters:

placementStrategy - The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

Returns:

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

withPlacementStrategy

public EcsParameters withPlacementStrategy(Collection<PlacementStrategy> placementStrategy)

The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

Parameters:

placementStrategy - The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

Returns:

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

setPropagateTags

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 the TagResource API action.

Parameters:

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.

See Also:

PropagateTags

getPropagateTags

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 the TagResource API action.

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 the TagResource API action.

See Also:

PropagateTags

withPropagateTags

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 the TagResource API action.

Parameters:

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.

Returns:

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

See Also:

PropagateTags

withPropagateTags

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 the TagResource API action.

Parameters:

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.

Returns:

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

See Also:

PropagateTags

setReferenceId

public void setReferenceId(String referenceId)

The reference ID to use for the task.

Parameters:

referenceId - The reference ID to use for the task.

getReferenceId

public String getReferenceId()

The reference ID to use for the task.

Returns:

The reference ID to use for the task.

withReferenceId

public EcsParameters withReferenceId(String referenceId)

The reference ID to use for the task.

Parameters:

referenceId - The reference ID to use for the task.

Returns:

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

getTags

public List<Tag> 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. To learn more, see RunTask in the Amazon ECS API Reference.

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

setTags

public void setTags(Collection<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.

Parameters:

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.

withTags

public EcsParameters withTags(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.

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.

Parameters:

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.

Returns:

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

withTags

public EcsParameters withTags(Collection<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.

Parameters:

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.

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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public EcsParameters clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.