Struct aws_sdk_eventbridge::model::EcsParameters [−][src]
#[non_exhaustive]pub struct EcsParameters {Show 14 fields
pub task_definition_arn: Option<String>,
pub task_count: Option<i32>,
pub launch_type: Option<LaunchType>,
pub network_configuration: Option<NetworkConfiguration>,
pub platform_version: Option<String>,
pub group: Option<String>,
pub capacity_provider_strategy: Option<Vec<CapacityProviderStrategyItem>>,
pub enable_ecs_managed_tags: bool,
pub enable_execute_command: bool,
pub placement_constraints: Option<Vec<PlacementConstraint>>,
pub placement_strategy: Option<Vec<PlacementStrategy>>,
pub propagate_tags: Option<PropagateTags>,
pub reference_id: Option<String>,
pub tags: Option<Vec<Tag>>,
}
Expand description
The custom parameters to be used when the target is an Amazon ECS task.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.task_definition_arn: Option<String>
The ARN of the task definition to use if the event target is an Amazon ECS task.
task_count: Option<i32>
The number of tasks to create based on TaskDefinition
. The default is
1.
launch_type: Option<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.
network_configuration: Option<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.
platform_version: Option<String>
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.
group: Option<String>
Specifies an ECS task group for the task. The maximum length is 255 characters.
capacity_provider_strategy: Option<Vec<CapacityProviderStrategyItem>>
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.
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.
enable_execute_command: bool
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.
placement_constraints: Option<Vec<PlacementConstraint>>
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).
placement_strategy: Option<Vec<PlacementStrategy>>
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
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.
reference_id: Option<String>
The reference ID to use for the task.
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.
Implementations
The ARN of the task definition to use if the event target is an Amazon ECS task.
The number of tasks to create based on TaskDefinition
. The default is
1.
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.
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.
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.
Specifies an ECS task group for the task. The maximum length is 255 characters.
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.
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.
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.
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).
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
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.
The reference ID to use for the task.
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.
Creates a new builder-style object to manufacture EcsParameters
Trait Implementations
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for EcsParameters
impl Send for EcsParameters
impl Sync for EcsParameters
impl Unpin for EcsParameters
impl UnwindSafe for EcsParameters
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more