Struct aws_sdk_ecs::input::RunTaskInput

source · [−]

#[non_exhaustive]
pub struct RunTaskInput {Show 17 fields
    pub capacity_provider_strategy: Option<Vec<CapacityProviderStrategyItem>>,
    pub cluster: Option<String>,
    pub count: Option<i32>,
    pub enable_ecs_managed_tags: bool,
    pub enable_execute_command: bool,
    pub group: Option<String>,
    pub launch_type: Option<LaunchType>,
    pub network_configuration: Option<NetworkConfiguration>,
    pub overrides: Option<TaskOverride>,
    pub placement_constraints: Option<Vec<PlacementConstraint>>,
    pub placement_strategy: Option<Vec<PlacementStrategy>>,
    pub platform_version: Option<String>,
    pub propagate_tags: Option<PropagateTags>,
    pub reference_id: Option<String>,
    pub started_by: Option<String>,
    pub tags: Option<Vec<Tag>>,
    pub task_definition: Option<String>,
}

Fields (Non-exhaustive)

This struct is marked as non-exhaustive

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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.

When you use cluster auto scaling, you must specify capacityProviderStrategy and not launchType.

A capacity provider strategy may contain a maximum of 6 capacity providers.

cluster: 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.

count: 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.

enable_ecs_managed_tags: bool

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.

enable_execute_command: 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.

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

launch_type: 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 User Guide for Fargate.

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.

network_configuration: 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.

overrides: 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.

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

placement_strategy: Option<Vec<PlacementStrategy>>

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

platform_version: 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.

propagate_tags: Option<PropagateTags>

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

An error will be received if you specify the SERVICE option when running a task.

reference_id: Option<String>

The reference ID to use for the task. The reference ID can have a maximum length of 1024 characters.

started_by: 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 36 letters (uppercase and lowercase), numbers, hyphens (-), 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.

tags: Option<Vec<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.

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.

task_definition: 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.

When you create an IAM policy for run-task, you can set the resource to be the latest task definition revision, or a specific revision.

The full ARN value must match the value that you specified as the Resource of the IAM principal's permissions policy.

When you specify the policy resource as the latest task definition version (by setting the Resource in the policy to arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName), then set this value to arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName.

When you specify the policy resource as a specific task definition version (by setting the Resource in the policy to arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1 or arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*), then set this value to arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1.

For more information, see Policy Resources for Amazon ECS in the Amazon Elastic Container Service developer Guide.

Struct aws_sdk_ecs::input::RunTaskInput

Fields (Non-exhaustive)

Implementations

impl RunTaskInput

pub async fn make_operation( &self, _config: &Config) -> Result<Operation<RunTask, AwsErrorRetryPolicy>, BuildError>

pub fn builder() -> Builder

impl RunTaskInput

pub fn capacity_provider_strategy( &self) -> Option<&[CapacityProviderStrategyItem]>

pub fn cluster(&self) -> Option<&str>

pub fn count(&self) -> Option<i32>

pub fn enable_ecs_managed_tags(&self) -> bool

pub fn enable_execute_command(&self) -> bool

pub fn group(&self) -> Option<&str>

pub fn launch_type(&self) -> Option<&LaunchType>

pub fn network_configuration(&self) -> Option<&NetworkConfiguration>

pub fn overrides(&self) -> Option<&TaskOverride>

pub fn placement_constraints(&self) -> Option<&[PlacementConstraint]>

pub fn placement_strategy(&self) -> Option<&[PlacementStrategy]>

pub fn platform_version(&self) -> Option<&str>

pub fn propagate_tags(&self) -> Option<&PropagateTags>

pub fn reference_id(&self) -> Option<&str>

pub fn started_by(&self) -> Option<&str>

pub fn tags(&self) -> Option<&[Tag]>

pub fn task_definition(&self) -> Option<&str>

Trait Implementations

impl Clone for RunTaskInput

fn clone(&self) -> RunTaskInput

fn clone_from(&mut self, source: &Self)

impl Debug for RunTaskInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl PartialEq<RunTaskInput> for RunTaskInput

fn eq(&self, other: &RunTaskInput) -> bool

fn ne(&self, other: &RunTaskInput) -> bool

impl StructuralPartialEq for RunTaskInput

Auto Trait Implementations

impl RefUnwindSafe for RunTaskInput

impl Send for RunTaskInput

impl Sync for RunTaskInput

impl Unpin for RunTaskInput

impl UnwindSafe for RunTaskInput

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<RunTask, AwsErrorRetryPolicy>, BuildError>

pub fn capacity_provider_strategy(
&self
) -> Option<&[CapacityProviderStrategyItem ]>

pub fn placement_constraints(&self) -> Option<&[PlacementConstraint ]>

pub fn placement_strategy(&self) -> Option<&[PlacementStrategy ]>

pub fn tags(&self) -> Option<&[Tag ]>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,