Struct aws_sdk_ecs::model::task::Builder

#[non_exhaustive]
pub struct Builder { /* private fields */ }

A builder for Task

Implementations

impl Builder

pub fn attachments(self, input: Attachment) -> Self

Appends an item to attachments.

To override the contents of this collection use set_attachments.

The Elastic Network Adapter that's associated with the task if the task uses the awsvpc network mode.

pub fn set_attachments(self, input: Option<Vec<Attachment>>) -> Self

The Elastic Network Adapter that's associated with the task if the task uses the awsvpc network mode.

pub fn attributes(self, input: Attribute) -> Self

Appends an item to attributes.

To override the contents of this collection use set_attributes.

The attributes of the task

pub fn set_attributes(self, input: Option<Vec<Attribute>>) -> Self

The attributes of the task

pub fn availability_zone(self, input: impl Into<String>) -> Self

The Availability Zone for the task.

pub fn set_availability_zone(self, input: Option<String>) -> Self

The Availability Zone for the task.

pub fn capacity_provider_name(self, input: impl Into<String>) -> Self

The capacity provider that's associated with the task.

pub fn set_capacity_provider_name(self, input: Option<String>) -> Self

The capacity provider that's associated with the task.

pub fn cluster_arn(self, input: impl Into<String>) -> Self

The ARN of the cluster that hosts the task.

pub fn set_cluster_arn(self, input: Option<String>) -> Self

The ARN of the cluster that hosts the task.

pub fn connectivity(self, input: Connectivity) -> Self

The connectivity status of a task.

pub fn set_connectivity(self, input: Option<Connectivity>) -> Self

The connectivity status of a task.

pub fn connectivity_at(self, input: DateTime) -> Self

The Unix timestamp for the time when the task last went into CONNECTED status.

pub fn set_connectivity_at(self, input: Option<DateTime>) -> Self

The Unix timestamp for the time when the task last went into CONNECTED status.

pub fn container_instance_arn(self, input: impl Into<String>) -> Self

The ARN of the container instances that host the task.

pub fn set_container_instance_arn(self, input: Option<String>) -> Self

The ARN of the container instances that host the task.

pub fn containers(self, input: Container) -> Self

Appends an item to containers.

To override the contents of this collection use set_containers.

The containers that's associated with the task.

pub fn set_containers(self, input: Option<Vec<Container>>) -> Self

The containers that's associated with the task.

pub fn cpu(self, input: impl Into<String>) -> Self

The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units (for example, 1024). It can also be expressed as a string using vCPUs (for example, 1 vCPU or 1 vcpu). String values are converted to an integer that indicates the CPU units when the task definition is registered.

If you use the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).

If you use the Fargate launch type, this field is required. You must use one of the following values. These values determine the range of supported values for the memory parameter:

The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

• 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)

• 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)

• 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)

• 2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)

• 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)

pub fn set_cpu(self, input: Option<String>) -> Self

The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units (for example, 1024). It can also be expressed as a string using vCPUs (for example, 1 vCPU or 1 vcpu). String values are converted to an integer that indicates the CPU units when the task definition is registered.

If you use the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).

If you use the Fargate launch type, this field is required. You must use one of the following values. These values determine the range of supported values for the memory parameter:

The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

• 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)

• 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)

• 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)

• 2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)

• 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)

pub fn created_at(self, input: DateTime) -> Self

The Unix timestamp for the time when the task was created. More specifically, it's for the time when the task entered the PENDING state.

pub fn set_created_at(self, input: Option<DateTime>) -> Self

The Unix timestamp for the time when the task was created. More specifically, it's for the time when the task entered the PENDING state.

pub fn desired_status(self, input: impl Into<String>) -> Self

The desired status of the task. For more information, see Task Lifecycle.

pub fn set_desired_status(self, input: Option<String>) -> Self

The desired status of the task. For more information, see Task Lifecycle.

pub fn enable_execute_command(self, input: bool) -> Self

Determines whether execute command functionality is enabled for this task. If true, execute command functionality is enabled on all the containers in the task.

pub fn set_enable_execute_command(self, input: Option<bool>) -> Self

Determines whether execute command functionality is enabled for this task. If true, execute command functionality is enabled on all the containers in the task.

pub fn execution_stopped_at(self, input: DateTime) -> Self

The Unix timestamp for the time when the task execution stopped.

pub fn set_execution_stopped_at(self, input: Option<DateTime>) -> Self

The Unix timestamp for the time when the task execution stopped.

pub fn group(self, input: impl Into<String>) -> Self

The name of the task group that's associated with the task.

pub fn set_group(self, input: Option<String>) -> Self

The name of the task group that's associated with the task.

pub fn health_status(self, input: HealthStatus) -> Self

The health status for the task. It's determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY, the task status also reports as HEALTHY. If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN, the task status also reports as UNHEALTHY or UNKNOWN.

The Amazon ECS container agent doesn't monitor or report on Docker health checks that are embedded in a container image and not specified in the container definition. For example, this includes those specified in a parent image or from the image's Dockerfile. Health check parameters that are specified in a container definition override any Docker health checks that are found in the container image.

pub fn set_health_status(self, input: Option<HealthStatus>) -> Self

The health status for the task. It's determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY, the task status also reports as HEALTHY. If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN, the task status also reports as UNHEALTHY or UNKNOWN.

The Amazon ECS container agent doesn't monitor or report on Docker health checks that are embedded in a container image and not specified in the container definition. For example, this includes those specified in a parent image or from the image's Dockerfile. Health check parameters that are specified in a container definition override any Docker health checks that are found in the container image.

pub fn inference_accelerators(self, input: InferenceAccelerator) -> Self

Appends an item to inference_accelerators.

To override the contents of this collection use set_inference_accelerators.

The Elastic Inference accelerator that's associated with the task.

pub fn set_inference_accelerators(
    self,
    input: Option<Vec<InferenceAccelerator>>
) -> Self

The Elastic Inference accelerator that's associated with the task.

pub fn last_status(self, input: impl Into<String>) -> Self

The last known status for the task. For more information, see Task Lifecycle.

pub fn set_last_status(self, input: Option<String>) -> Self

The last known status for the task. For more information, see Task Lifecycle.

pub fn launch_type(self, input: LaunchType) -> Self

The infrastructure where your task runs on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

pub fn set_launch_type(self, input: Option<LaunchType>) -> Self

The infrastructure where your task runs on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

pub fn memory(self, input: impl Into<String>) -> Self

The amount of memory (in MiB) that the task uses as expressed in a task definition. It can be expressed as an integer using MiB (for example, 1024). If it's expressed as a string using GB (for example, 1GB or 1 GB), it's converted to an integer indicating the MiB when the task definition is registered.

If you use the EC2 launch type, this field is optional.

If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines the range of supported values for the cpu parameter.

• 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)

• 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)

• 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)

• Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)

• Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)

pub fn set_memory(self, input: Option<String>) -> Self

The amount of memory (in MiB) that the task uses as expressed in a task definition. It can be expressed as an integer using MiB (for example, 1024). If it's expressed as a string using GB (for example, 1GB or 1 GB), it's converted to an integer indicating the MiB when the task definition is registered.

If you use the EC2 launch type, this field is optional.

If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines the range of supported values for the cpu parameter.

• 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)

• 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)

• 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)

• Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)

• Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)

pub fn overrides(self, input: TaskOverride) -> Self

One or more container overrides.

pub fn set_overrides(self, input: Option<TaskOverride>) -> Self

One or more container overrides.

pub fn platform_version(self, input: impl Into<String>) -> Self

The platform version where your task runs on. A platform version is only specified for tasks that use the Fargate launch type. If you didn't specify one, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

pub fn set_platform_version(self, input: Option<String>) -> Self

The platform version where your task runs on. A platform version is only specified for tasks that use the Fargate launch type. If you didn't specify one, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

pub fn platform_family(self, input: impl Into<String>) -> Self

The operating system that your tasks are running on. A platform family is specified only for tasks that use the Fargate launch type.

All tasks that run as part of this service must use the same platformFamily value as the service (for example, LINUX.).

pub fn set_platform_family(self, input: Option<String>) -> Self

The operating system that your tasks are running on. A platform family is specified only for tasks that use the Fargate launch type.

All tasks that run as part of this service must use the same platformFamily value as the service (for example, LINUX.).

pub fn pull_started_at(self, input: DateTime) -> Self

The Unix timestamp for the time when the container image pull began.

pub fn set_pull_started_at(self, input: Option<DateTime>) -> Self

The Unix timestamp for the time when the container image pull began.

pub fn pull_stopped_at(self, input: DateTime) -> Self

The Unix timestamp for the time when the container image pull completed.

pub fn set_pull_stopped_at(self, input: Option<DateTime>) -> Self

The Unix timestamp for the time when the container image pull completed.

pub fn started_at(self, input: DateTime) -> Self

The Unix timestamp for the time when the task started. More specifically, it's for the time when the task transitioned from the PENDING state to the RUNNING state.

pub fn set_started_at(self, input: Option<DateTime>) -> Self

The Unix timestamp for the time when the task started. More specifically, it's for the time when the task transitioned from the PENDING state to the RUNNING state.

pub fn started_by(self, input: impl Into<String>) -> Self

The tag specified when a task is started. If an Amazon ECS service started the task, the startedBy parameter contains the deployment ID of that service.

pub fn set_started_by(self, input: Option<String>) -> Self

The tag specified when a task is started. If an Amazon ECS service started the task, the startedBy parameter contains the deployment ID of that service.

pub fn stop_code(self, input: TaskStopCode) -> Self

The stop code indicating why a task was stopped. The stoppedReason might contain additional details.

The following are valid values:

• TaskFailedToStart

• EssentialContainerExited

• UserInitiated

• TerminationNotice

• ServiceSchedulerInitiated

• SpotInterruption

pub fn set_stop_code(self, input: Option<TaskStopCode>) -> Self

The stop code indicating why a task was stopped. The stoppedReason might contain additional details.

The following are valid values:

• TaskFailedToStart

• EssentialContainerExited

• UserInitiated

• TerminationNotice

• ServiceSchedulerInitiated

• SpotInterruption

pub fn stopped_at(self, input: DateTime) -> Self

The Unix timestamp for the time when the task was stopped. More specifically, it's for the time when the task transitioned from the RUNNING state to the STOPPED state.

pub fn set_stopped_at(self, input: Option<DateTime>) -> Self

The Unix timestamp for the time when the task was stopped. More specifically, it's for the time when the task transitioned from the RUNNING state to the STOPPED state.

pub fn stopped_reason(self, input: impl Into<String>) -> Self

The reason that the task was stopped.

pub fn set_stopped_reason(self, input: Option<String>) -> Self

The reason that the task was stopped.

pub fn stopping_at(self, input: DateTime) -> Self

The Unix timestamp for the time when the task stops. More specifically, it's for the time when the task transitions from the RUNNING state to STOPPED.

pub fn set_stopping_at(self, input: Option<DateTime>) -> Self

The Unix timestamp for the time when the task stops. More specifically, it's for the time when the task transitions from the RUNNING state to STOPPED.

pub fn tags(self, input: Tag) -> Self

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 the task. Each tag consists of a key and an optional value. You define both the key and value.

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.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

The metadata that you apply to the task to help you categorize and organize the task. Each tag consists of a key and an optional value. You define both the key and value.

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.

pub fn task_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the task.

pub fn set_task_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the task.

pub fn task_definition_arn(self, input: impl Into<String>) -> Self

The ARN of the task definition that creates the task.

pub fn set_task_definition_arn(self, input: Option<String>) -> Self

The ARN of the task definition that creates the task.

pub fn version(self, input: i64) -> Self

The version counter for the task. Every time a task experiences a change that starts a CloudWatch event, the version counter is incremented. If you replicate your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API actions with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.

pub fn set_version(self, input: Option<i64>) -> Self

The version counter for the task. Every time a task experiences a change that starts a CloudWatch event, the version counter is incremented. If you replicate your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API actions with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.

pub fn ephemeral_storage(self, input: EphemeralStorage) -> Self

The ephemeral storage settings for the task.

pub fn set_ephemeral_storage(self, input: Option<EphemeralStorage>) -> Self

The ephemeral storage settings for the task.

pub fn build(self) -> Task

Consumes the builder and constructs a Task

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Builder