Struct aws_sdk_ecs::model::TaskSet

source · [−]

#[non_exhaustive]
pub struct TaskSet {Show 24 fields
    pub id: Option<String>,
    pub task_set_arn: Option<String>,
    pub service_arn: Option<String>,
    pub cluster_arn: Option<String>,
    pub started_by: Option<String>,
    pub external_id: Option<String>,
    pub status: Option<String>,
    pub task_definition: Option<String>,
    pub computed_desired_count: i32,
    pub pending_count: i32,
    pub running_count: i32,
    pub created_at: Option<DateTime>,
    pub updated_at: Option<DateTime>,
    pub launch_type: Option<LaunchType>,
    pub capacity_provider_strategy: Option<Vec<CapacityProviderStrategyItem>>,
    pub platform_version: Option<String>,
    pub platform_family: Option<String>,
    pub network_configuration: Option<NetworkConfiguration>,
    pub load_balancers: Option<Vec<LoadBalancer>>,
    pub service_registries: Option<Vec<ServiceRegistry>>,
    pub scale: Option<Scale>,
    pub stability_status: Option<StabilityStatus>,
    pub stability_status_at: Option<DateTime>,
    pub tags: Option<Vec<Tag>>,
}

Expand description

Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.

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.

id: Option<String>

The ID of the task set.

task_set_arn: Option<String>

The Amazon Resource Name (ARN) of the task set.

service_arn: Option<String>

The Amazon Resource Name (ARN) of the service the task set exists in.

cluster_arn: Option<String>

The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.

started_by: Option<String>

The tag specified when a task set is started. If an CodeDeploy deployment created the task set, the startedBy parameter is CODE_DEPLOY. If an external deployment created the task set, the startedBy field isn't used.

external_id: Option<String>

The external ID associated with the task set.

If an CodeDeploy deployment created a task set, the externalId parameter contains the CodeDeploy deployment ID.

If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute.

status: Option<String>

The status of the task set. The following describes each state.

PRIMARY: The task set is serving production traffic.
ACTIVE: The task set isn't serving production traffic.
DRAINING: The tasks in the task set are being stopped, and their corresponding targets are being deregistered from their target group.

task_definition: Option<String>

The task definition that the task set is using.

computed_desired_count: i32

The computed desired count for the task set. This is calculated by multiplying the service's desiredCount by the task set's scale percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.

pending_count: i32

The number of tasks in the task set that are in the PENDING status during a deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time or when it's restarted after being in the STOPPED state.

running_count: i32

The number of tasks in the task set that are in the RUNNING status during a deployment. A task in the RUNNING state is running and ready for use.

created_at: Option<DateTime>

The Unix timestamp for the time when the task set was created.

updated_at: Option<DateTime>

The Unix timestamp for the time when the task set was last updated.

launch_type: Option<LaunchType>

The launch type the tasks in the task set are using. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

capacity_provider_strategy: Option<Vec<CapacityProviderStrategyItem>>

The capacity provider strategy that are associated with the task set.

platform_version: Option<String>

The Fargate platform version where the tasks in the task set are running. A platform version is only specified for tasks run on Fargate. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

platform_family: Option<String>

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

All tasks in the set must have the same value.

network_configuration: Option<NetworkConfiguration>

The network configuration for the task set.

load_balancers: Option<Vec<LoadBalancer>>

Details on a load balancer that are used with a task set.

service_registries: Option<Vec<ServiceRegistry>>

The details for the service discovery registries to assign to this task set. For more information, see Service discovery.

scale: Option<Scale>

A floating-point percentage of your desired number of tasks to place and keep running in the task set.

stability_status: Option<StabilityStatus>

The stability status. This indicates whether the task set has reached a steady state. If the following conditions are met, the task set sre in STEADY_STATE:

The task runningCount is equal to the computedDesiredCount.
The pendingCount is 0.
There are no tasks that are running on container instances in the DRAINING status.
All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.

If any of those conditions aren't met, the stability status returns STABILIZING.

stability_status_at: Option<DateTime>

The Unix timestamp for the time when the task set stability status was retrieved.

tags: Option<Vec<Tag>>

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

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.

Struct aws_sdk_ecs::model::TaskSet

Fields (Non-exhaustive)

Implementations

impl TaskSet

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

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

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

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

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

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

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

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

pub fn computed_desired_count(&self) -> i32

pub fn pending_count(&self) -> i32

pub fn running_count(&self) -> i32

pub fn created_at(&self) -> Option<&DateTime>

pub fn updated_at(&self) -> Option<&DateTime>

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

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

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

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

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

pub fn load_balancers(&self) -> Option<&[LoadBalancer]>

pub fn service_registries(&self) -> Option<&[ServiceRegistry]>

pub fn scale(&self) -> Option<&Scale>

pub fn stability_status(&self) -> Option<&StabilityStatus>

pub fn stability_status_at(&self) -> Option<&DateTime>

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

impl TaskSet

pub fn builder() -> Builder

Trait Implementations

impl Clone for TaskSet

fn clone(&self) -> TaskSet

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

impl Debug for TaskSet

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

impl PartialEq<TaskSet> for TaskSet

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

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

impl StructuralPartialEq for TaskSet

Auto Trait Implementations

impl RefUnwindSafe for TaskSet

impl Send for TaskSet

impl Sync for TaskSet

impl Unpin for TaskSet

impl UnwindSafe for TaskSet

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 fn capacity_provider_strategy(
&self
) -> Option<&[CapacityProviderStrategyItem ]>

pub fn load_balancers(&self) -> Option<&[LoadBalancer ]>

pub fn service_registries(&self) -> Option<&[ServiceRegistry ]>

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>,