pub struct Builder { /* private fields */ }
Expand description
A builder for PipeTargetEcsTaskParameters
.
Implementations§
source§impl Builder
impl Builder
sourcepub fn task_definition_arn(self, input: impl Into<String>) -> Self
pub fn task_definition_arn(self, input: impl Into<String>) -> Self
The ARN of the task definition to use if the event target is an Amazon ECS task.
sourcepub fn set_task_definition_arn(self, input: Option<String>) -> Self
pub fn set_task_definition_arn(self, input: Option<String>) -> Self
The ARN of the task definition to use if the event target is an Amazon ECS task.
sourcepub fn task_count(self, input: i32) -> Self
pub fn task_count(self, input: i32) -> Self
The number of tasks to create based on TaskDefinition
. The default is 1.
sourcepub fn set_task_count(self, input: Option<i32>) -> Self
pub fn set_task_count(self, input: Option<i32>) -> Self
The number of tasks to create based on TaskDefinition
. The default is 1.
sourcepub fn launch_type(self, input: LaunchType) -> Self
pub fn launch_type(self, input: LaunchType) -> Self
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.
sourcepub fn set_launch_type(self, input: Option<LaunchType>) -> Self
pub fn set_launch_type(self, input: Option<LaunchType>) -> Self
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.
sourcepub fn network_configuration(self, input: NetworkConfiguration) -> Self
pub fn network_configuration(self, input: NetworkConfiguration) -> Self
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.
sourcepub fn set_network_configuration(
self,
input: Option<NetworkConfiguration>
) -> Self
pub fn set_network_configuration(
self,
input: Option<NetworkConfiguration>
) -> Self
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.
sourcepub fn platform_version(self, input: impl Into<String>) -> Self
pub fn platform_version(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_platform_version(self, input: Option<String>) -> Self
pub fn set_platform_version(self, input: Option<String>) -> Self
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.
sourcepub fn group(self, input: impl Into<String>) -> Self
pub fn group(self, input: impl Into<String>) -> Self
Specifies an Amazon ECS task group for the task. The maximum length is 255 characters.
sourcepub fn set_group(self, input: Option<String>) -> Self
pub fn set_group(self, input: Option<String>) -> Self
Specifies an Amazon ECS task group for the task. The maximum length is 255 characters.
sourcepub fn capacity_provider_strategy(
self,
input: CapacityProviderStrategyItem
) -> Self
pub fn capacity_provider_strategy(
self,
input: CapacityProviderStrategyItem
) -> Self
Appends an item to capacity_provider_strategy
.
To override the contents of this collection use set_capacity_provider_strategy
.
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.
sourcepub fn set_capacity_provider_strategy(
self,
input: Option<Vec<CapacityProviderStrategyItem>>
) -> Self
pub fn set_capacity_provider_strategy(
self,
input: Option<Vec<CapacityProviderStrategyItem>>
) -> Self
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.
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.
sourcepub fn enable_execute_command(self, input: bool) -> Self
pub fn enable_execute_command(self, input: bool) -> Self
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.
sourcepub fn set_enable_execute_command(self, input: Option<bool>) -> Self
pub fn set_enable_execute_command(self, input: Option<bool>) -> Self
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.
sourcepub fn placement_constraints(self, input: PlacementConstraint) -> Self
pub fn placement_constraints(self, input: PlacementConstraint) -> Self
Appends an item to placement_constraints
.
To override the contents of this collection use set_placement_constraints
.
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).
sourcepub fn set_placement_constraints(
self,
input: Option<Vec<PlacementConstraint>>
) -> Self
pub fn set_placement_constraints(
self,
input: Option<Vec<PlacementConstraint>>
) -> Self
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).
sourcepub fn placement_strategy(self, input: PlacementStrategy) -> Self
pub fn placement_strategy(self, input: PlacementStrategy) -> Self
Appends an item to placement_strategy
.
To override the contents of this collection use set_placement_strategy
.
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
sourcepub fn set_placement_strategy(
self,
input: Option<Vec<PlacementStrategy>>
) -> Self
pub fn set_placement_strategy(
self,
input: Option<Vec<PlacementStrategy>>
) -> Self
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.
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.
sourcepub fn reference_id(self, input: impl Into<String>) -> Self
pub fn reference_id(self, input: impl Into<String>) -> Self
The reference ID to use for the task.
sourcepub fn set_reference_id(self, input: Option<String>) -> Self
pub fn set_reference_id(self, input: Option<String>) -> Self
The reference ID to use for the task.
sourcepub fn overrides(self, input: EcsTaskOverride) -> Self
pub fn overrides(self, input: EcsTaskOverride) -> Self
The overrides that are associated with a task.
sourcepub fn set_overrides(self, input: Option<EcsTaskOverride>) -> Self
pub fn set_overrides(self, input: Option<EcsTaskOverride>) -> Self
The overrides that are associated with a task.
Appends an item to tags
.
To override the contents of this collection use set_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.
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.
sourcepub fn build(self) -> PipeTargetEcsTaskParameters
pub fn build(self) -> PipeTargetEcsTaskParameters
Consumes the builder and constructs a PipeTargetEcsTaskParameters
.