EcsParameters

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

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The capacity provider strategy to use for the task.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

The reference ID to use for the task.

Link copied to clipboard
val tags: List<Tag>?

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.

Link copied to clipboard

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

Link copied to clipboard

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

Functions

Link copied to clipboard
inline fun copy(block: EcsParameters.Builder.() -> Unit = {}): EcsParameters
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String