pub struct RunTaskFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to RunTask
.
Starts a new task using the specified task definition.
On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
Amazon Elastic Inference (EI) is no longer available to customers.
You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.
Alternatively, you can use StartTask
to use your own scheduler or place tasks manually on specific container instances.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more information, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
The Amazon ECS API follows an eventual consistency model. This is because of the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.
To manage eventual consistency, you can do the following:
-
Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.
-
Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.
If you get a ConflictException
error, the RunTask
request could not be processed due to conflicts. The provided clientToken
is already in use with a different RunTask
request. The resourceIds
are the existing task ARNs which are already associated with the clientToken
.
To fix this issue:
-
Run
RunTask
with a uniqueclientToken
. -
Run
RunTask
with theclientToken
and the original set of parameters
If you get a ClientException
error, the RunTask
could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING
per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.
Implementations§
Source§impl RunTaskFluentBuilder
impl RunTaskFluentBuilder
Sourcepub fn as_input(&self) -> &RunTaskInputBuilder
pub fn as_input(&self) -> &RunTaskInputBuilder
Access the RunTask as a reference.
Sourcepub async fn send(
self,
) -> Result<RunTaskOutput, SdkError<RunTaskError, HttpResponse>>
pub async fn send( self, ) -> Result<RunTaskOutput, SdkError<RunTaskError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<RunTaskOutput, RunTaskError, Self>
pub fn customize( self, ) -> CustomizableOperation<RunTaskOutput, RunTaskError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn capacity_provider_strategy(
self,
input: CapacityProviderStrategyItem,
) -> Self
pub fn capacity_provider_strategy( self, input: CapacityProviderStrategyItem, ) -> Self
Appends an item to capacityProviderStrategy
.
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.
When you use cluster auto scaling, you must specify capacityProviderStrategy
and not launchType
.
A capacity provider strategy can contain a maximum of 20 capacity providers.
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.
When you use cluster auto scaling, you must specify capacityProviderStrategy
and not launchType
.
A capacity provider strategy can contain a maximum of 20 capacity providers.
Sourcepub fn get_capacity_provider_strategy(
&self,
) -> &Option<Vec<CapacityProviderStrategyItem>>
pub fn get_capacity_provider_strategy( &self, ) -> &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.
When you use cluster auto scaling, you must specify capacityProviderStrategy
and not launchType
.
A capacity provider strategy can contain a maximum of 20 capacity providers.
Sourcepub fn cluster(self, input: impl Into<String>) -> Self
pub fn cluster(self, input: impl Into<String>) -> Self
The short name or full Amazon Resource Name (ARN) of the cluster to run your task on. If you do not specify a cluster, the default cluster is assumed.
Each account receives a default cluster the first time you use the service, but you may also create other clusters.
Sourcepub fn set_cluster(self, input: Option<String>) -> Self
pub fn set_cluster(self, input: Option<String>) -> Self
The short name or full Amazon Resource Name (ARN) of the cluster to run your task on. If you do not specify a cluster, the default cluster is assumed.
Each account receives a default cluster the first time you use the service, but you may also create other clusters.
Sourcepub fn get_cluster(&self) -> &Option<String>
pub fn get_cluster(&self) -> &Option<String>
The short name or full Amazon Resource Name (ARN) of the cluster to run your task on. If you do not specify a cluster, the default cluster is assumed.
Each account receives a default cluster the first time you use the service, but you may also create other clusters.
Sourcepub fn count(self, input: i32) -> Self
pub fn count(self, input: i32) -> Self
The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks for each call.
Sourcepub fn set_count(self, input: Option<i32>) -> Self
pub fn set_count(self, input: Option<i32>) -> Self
The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks for each call.
Sourcepub fn get_count(&self) -> &Option<i32>
pub fn get_count(&self) -> &Option<i32>
The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks for each call.
Specifies whether to use 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 use 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 use 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
Determines whether to use the execute command functionality for the containers in this task. If true
, this enables execute command functionality on all containers in the task.
If true
, then the task definition must have a task role, or you must provide one as an override.
Sourcepub fn set_enable_execute_command(self, input: Option<bool>) -> Self
pub fn set_enable_execute_command(self, input: Option<bool>) -> Self
Determines whether to use the execute command functionality for the containers in this task. If true
, this enables execute command functionality on all containers in the task.
If true
, then the task definition must have a task role, or you must provide one as an override.
Sourcepub fn get_enable_execute_command(&self) -> &Option<bool>
pub fn get_enable_execute_command(&self) -> &Option<bool>
Determines whether to use the execute command functionality for the containers in this task. If true
, this enables execute command functionality on all containers in the task.
If true
, then the task definition must have a task role, or you must provide one as an override.
Sourcepub fn group(self, input: impl Into<String>) -> Self
pub fn group(self, input: impl Into<String>) -> Self
The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name
).
Sourcepub fn set_group(self, input: Option<String>) -> Self
pub fn set_group(self, input: Option<String>) -> Self
The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name
).
Sourcepub fn get_group(&self) -> &Option<String>
pub fn get_group(&self) -> &Option<String>
The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name
).
Sourcepub fn launch_type(self, input: LaunchType) -> Self
pub fn launch_type(self, input: LaunchType) -> Self
The infrastructure to run your standalone task on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
The FARGATE
launch type runs your tasks on Fargate On-Demand infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS Developer Guide.
The EC2
launch type runs your tasks on Amazon EC2 instances registered to your cluster.
The EXTERNAL
launch type runs your tasks on your on-premises server or virtual machine (VM) capacity registered to your cluster.
A task can use either a launch type or a capacity provider strategy. If a launchType
is specified, the capacityProviderStrategy
parameter must be omitted.
When you use cluster auto scaling, you must specify capacityProviderStrategy
and not launchType
.
Sourcepub fn set_launch_type(self, input: Option<LaunchType>) -> Self
pub fn set_launch_type(self, input: Option<LaunchType>) -> Self
The infrastructure to run your standalone task on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
The FARGATE
launch type runs your tasks on Fargate On-Demand infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS Developer Guide.
The EC2
launch type runs your tasks on Amazon EC2 instances registered to your cluster.
The EXTERNAL
launch type runs your tasks on your on-premises server or virtual machine (VM) capacity registered to your cluster.
A task can use either a launch type or a capacity provider strategy. If a launchType
is specified, the capacityProviderStrategy
parameter must be omitted.
When you use cluster auto scaling, you must specify capacityProviderStrategy
and not launchType
.
Sourcepub fn get_launch_type(&self) -> &Option<LaunchType>
pub fn get_launch_type(&self) -> &Option<LaunchType>
The infrastructure to run your standalone task on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
The FARGATE
launch type runs your tasks on Fargate On-Demand infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS Developer Guide.
The EC2
launch type runs your tasks on Amazon EC2 instances registered to your cluster.
The EXTERNAL
launch type runs your tasks on your on-premises server or virtual machine (VM) capacity registered to your cluster.
A task can use either a launch type or a capacity provider strategy. If a launchType
is specified, the capacityProviderStrategy
parameter must be omitted.
When you use cluster auto scaling, you must specify capacityProviderStrategy
and not launchType
.
Sourcepub fn network_configuration(self, input: NetworkConfiguration) -> Self
pub fn network_configuration(self, input: NetworkConfiguration) -> Self
The network configuration for the task. This parameter is required for task definitions that use the awsvpc
network mode to receive their own elastic network interface, and it isn't supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.
Sourcepub fn set_network_configuration(
self,
input: Option<NetworkConfiguration>,
) -> Self
pub fn set_network_configuration( self, input: Option<NetworkConfiguration>, ) -> Self
The network configuration for the task. This parameter is required for task definitions that use the awsvpc
network mode to receive their own elastic network interface, and it isn't supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.
Sourcepub fn get_network_configuration(&self) -> &Option<NetworkConfiguration>
pub fn get_network_configuration(&self) -> &Option<NetworkConfiguration>
The network configuration for the task. This parameter is required for task definitions that use the awsvpc
network mode to receive their own elastic network interface, and it isn't supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.
Sourcepub fn overrides(self, input: TaskOverride) -> Self
pub fn overrides(self, input: TaskOverride) -> Self
A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that's specified in the task definition or Docker image) with a command
override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment
override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
Sourcepub fn set_overrides(self, input: Option<TaskOverride>) -> Self
pub fn set_overrides(self, input: Option<TaskOverride>) -> Self
A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that's specified in the task definition or Docker image) with a command
override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment
override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
Sourcepub fn get_overrides(&self) -> &Option<TaskOverride>
pub fn get_overrides(&self) -> &Option<TaskOverride>
A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that's specified in the task definition or Docker image) with a command
override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment
override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
Sourcepub fn placement_constraints(self, input: PlacementConstraint) -> Self
pub fn placement_constraints(self, input: PlacementConstraint) -> Self
Appends an item to placementConstraints
.
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 for each 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 for each task (including constraints in the task definition and those specified at runtime).
Sourcepub fn get_placement_constraints(&self) -> &Option<Vec<PlacementConstraint>>
pub fn get_placement_constraints(&self) -> &Option<Vec<PlacementConstraint>>
An array of placement constraint objects to use for the task. You can specify up to 10 constraints for each 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 placementStrategy
.
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 5 strategy rules for each 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 5 strategy rules for each task.
Sourcepub fn get_placement_strategy(&self) -> &Option<Vec<PlacementStrategy>>
pub fn get_placement_strategy(&self) -> &Option<Vec<PlacementStrategy>>
The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules for each task.
Sourcepub fn platform_version(self, input: impl Into<String>) -> Self
pub fn platform_version(self, input: impl Into<String>) -> Self
The platform version the task uses. A platform version is only specified for tasks hosted on Fargate. If one isn't specified, the LATEST
platform version is used. For more information, 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
The platform version the task uses. A platform version is only specified for tasks hosted on Fargate. If one isn't specified, the LATEST
platform version is used. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
Sourcepub fn get_platform_version(&self) -> &Option<String>
pub fn get_platform_version(&self) -> &Option<String>
The platform version the task uses. A platform version is only specified for tasks hosted on Fargate. If one isn't specified, the LATEST
platform version is used. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use theTagResource API action.
An error will be received if you specify the SERVICE
option when running a task.
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use theTagResource API action.
An error will be received if you specify the SERVICE
option when running a task.
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use theTagResource API action.
An error will be received if you specify the SERVICE
option when running a task.
Sourcepub fn reference_id(self, input: impl Into<String>) -> Self
pub fn reference_id(self, input: impl Into<String>) -> Self
This parameter is only used by Amazon ECS. It is not intended for use by customers.
Sourcepub fn set_reference_id(self, input: Option<String>) -> Self
pub fn set_reference_id(self, input: Option<String>) -> Self
This parameter is only used by Amazon ECS. It is not intended for use by customers.
Sourcepub fn get_reference_id(&self) -> &Option<String>
pub fn get_reference_id(&self) -> &Option<String>
This parameter is only used by Amazon ECS. It is not intended for use by customers.
Sourcepub fn started_by(self, input: impl Into<String>) -> Self
pub fn started_by(self, input: impl Into<String>) -> Self
An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy
parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy
value. Up to 128 letters (uppercase and lowercase), numbers, hyphens (-), forward slash (/), and underscores (_) are allowed.
If a task is started by an Amazon ECS service, then the startedBy
parameter contains the deployment ID of the service that starts it.
Sourcepub fn set_started_by(self, input: Option<String>) -> Self
pub fn set_started_by(self, input: Option<String>) -> Self
An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy
parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy
value. Up to 128 letters (uppercase and lowercase), numbers, hyphens (-), forward slash (/), and underscores (_) are allowed.
If a task is started by an Amazon ECS service, then the startedBy
parameter contains the deployment ID of the service that starts it.
Sourcepub fn get_started_by(&self) -> &Option<String>
pub fn get_started_by(&self) -> &Option<String>
An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy
parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy
value. Up to 128 letters (uppercase and lowercase), numbers, hyphens (-), forward slash (/), and underscores (_) are allowed.
If a task is started by an Amazon ECS service, then the startedBy
parameter contains the deployment ID of the service that starts it.
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.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
Sourcepub fn task_definition(self, input: impl Into<String>) -> Self
pub fn task_definition(self, input: impl Into<String>) -> Self
The family
and revision
(family:revision
) or full ARN of the task definition to run. If a revision
isn't specified, the latest ACTIVE
revision is used.
The full ARN value must match the value that you specified as the Resource
of the principal's permissions policy.
When you specify a task definition, you must either specify a specific revision, or all revisions in the ARN.
To specify a specific revision, include the revision number in the ARN. For example, to specify revision 2, use arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:2
.
To specify all revisions, use the wildcard (*) in the ARN. For example, to specify all revisions, use arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*
.
For more information, see Policy Resources for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
Sourcepub fn set_task_definition(self, input: Option<String>) -> Self
pub fn set_task_definition(self, input: Option<String>) -> Self
The family
and revision
(family:revision
) or full ARN of the task definition to run. If a revision
isn't specified, the latest ACTIVE
revision is used.
The full ARN value must match the value that you specified as the Resource
of the principal's permissions policy.
When you specify a task definition, you must either specify a specific revision, or all revisions in the ARN.
To specify a specific revision, include the revision number in the ARN. For example, to specify revision 2, use arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:2
.
To specify all revisions, use the wildcard (*) in the ARN. For example, to specify all revisions, use arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*
.
For more information, see Policy Resources for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
Sourcepub fn get_task_definition(&self) -> &Option<String>
pub fn get_task_definition(&self) -> &Option<String>
The family
and revision
(family:revision
) or full ARN of the task definition to run. If a revision
isn't specified, the latest ACTIVE
revision is used.
The full ARN value must match the value that you specified as the Resource
of the principal's permissions policy.
When you specify a task definition, you must either specify a specific revision, or all revisions in the ARN.
To specify a specific revision, include the revision number in the ARN. For example, to specify revision 2, use arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:2
.
To specify all revisions, use the wildcard (*) in the ARN. For example, to specify all revisions, use arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*
.
For more information, see Policy Resources for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 64 characters are allowed. The valid characters are characters in the range of 33-126, inclusive. For more information, see Ensuring idempotency.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 64 characters are allowed. The valid characters are characters in the range of 33-126, inclusive. For more information, see Ensuring idempotency.
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 64 characters are allowed. The valid characters are characters in the range of 33-126, inclusive. For more information, see Ensuring idempotency.
Sourcepub fn volume_configurations(self, input: TaskVolumeConfiguration) -> Self
pub fn volume_configurations(self, input: TaskVolumeConfiguration) -> Self
Appends an item to volumeConfigurations
.
To override the contents of this collection use set_volume_configurations
.
The details of the volume that was configuredAtLaunch
. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in in TaskManagedEBSVolumeConfiguration. The name
of the volume must match the name
from the task definition.
Sourcepub fn set_volume_configurations(
self,
input: Option<Vec<TaskVolumeConfiguration>>,
) -> Self
pub fn set_volume_configurations( self, input: Option<Vec<TaskVolumeConfiguration>>, ) -> Self
The details of the volume that was configuredAtLaunch
. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in in TaskManagedEBSVolumeConfiguration. The name
of the volume must match the name
from the task definition.
Sourcepub fn get_volume_configurations(&self) -> &Option<Vec<TaskVolumeConfiguration>>
pub fn get_volume_configurations(&self) -> &Option<Vec<TaskVolumeConfiguration>>
The details of the volume that was configuredAtLaunch
. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in in TaskManagedEBSVolumeConfiguration. The name
of the volume must match the name
from the task definition.
Trait Implementations§
Source§impl Clone for RunTaskFluentBuilder
impl Clone for RunTaskFluentBuilder
Source§fn clone(&self) -> RunTaskFluentBuilder
fn clone(&self) -> RunTaskFluentBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for RunTaskFluentBuilder
impl !RefUnwindSafe for RunTaskFluentBuilder
impl Send for RunTaskFluentBuilder
impl Sync for RunTaskFluentBuilder
impl Unpin for RunTaskFluentBuilder
impl !UnwindSafe for RunTaskFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);