Struct aws_sdk_ecs::model::Cluster

source · [−]

#[non_exhaustive]
pub struct Cluster {Show 15 fields
    pub cluster_arn: Option<String>,
    pub cluster_name: Option<String>,
    pub configuration: Option<ClusterConfiguration>,
    pub status: Option<String>,
    pub registered_container_instances_count: i32,
    pub running_tasks_count: i32,
    pub pending_tasks_count: i32,
    pub active_services_count: i32,
    pub statistics: Option<Vec<KeyValuePair>>,
    pub tags: Option<Vec<Tag>>,
    pub settings: Option<Vec<ClusterSetting>>,
    pub capacity_providers: Option<Vec<String>>,
    pub default_capacity_provider_strategy: Option<Vec<CapacityProviderStrategyItem>>,
    pub attachments: Option<Vec<Attachment>>,
    pub attachments_status: Option<String>,
}

Expand description

A regional grouping of one or more container instances where you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.

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.

cluster_arn: Option<String>

The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the Region of the cluster, the Amazon Web Services account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.

cluster_name: Option<String>

A user-generated string that you use to identify your cluster.

configuration: Option<ClusterConfiguration>

The execute command configuration for the cluster.

status: Option<String>

The status of the cluster. The following are the possible states that are returned.

ACTIVE: The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.
PROVISIONING: The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being created.
DEPROVISIONING: The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being deleted.
FAILED: The cluster has capacity providers that are associated with it and the resources needed for the capacity provider have failed to create.
INACTIVE: The cluster has been deleted. Clusters with an INACTIVE status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don't recommend that you rely on INACTIVE clusters persisting.

registered_container_instances_count: i32

The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.

running_tasks_count: i32

The number of tasks in the cluster that are in the RUNNING state.

pending_tasks_count: i32

The number of tasks in the cluster that are in the PENDING state.

active_services_count: i32

The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.

statistics: Option<Vec<KeyValuePair>>

Additional information about your clusters that are separated by launch type. They include the following:

runningEC2TasksCount
RunningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount

tags: Option<Vec<Tag>>

The metadata that you apply to the cluster 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.

settings: Option<Vec<ClusterSetting>>

The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.

capacity_providers: Option<Vec<String>>

The capacity providers associated with the cluster.

default_capacity_provider_strategy: Option<Vec<CapacityProviderStrategyItem>>

The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.

attachments: Option<Vec<Attachment>>

The resources attached to a cluster. When using a capacity provider with a cluster, the Auto Scaling plan that's created is returned as a cluster attachment.

attachments_status: Option<String>

The status of the capacity providers associated with the cluster. The following are the states that are returned.

UPDATE_IN_PROGRESS: The available capacity providers for the cluster are updating. This occurs when the Auto Scaling plan is provisioning or deprovisioning.
UPDATE_COMPLETE: The capacity providers have successfully updated.
UPDATE_FAILED: The capacity provider updates failed.

Struct aws_sdk_ecs::model::Cluster

Fields (Non-exhaustive)

Implementations

impl Cluster

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

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

pub fn configuration(&self) -> Option<&ClusterConfiguration>

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

pub fn registered_container_instances_count(&self) -> i32

pub fn running_tasks_count(&self) -> i32

pub fn pending_tasks_count(&self) -> i32

pub fn active_services_count(&self) -> i32

pub fn statistics(&self) -> Option<&[KeyValuePair]>

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

pub fn settings(&self) -> Option<&[ClusterSetting]>

pub fn capacity_providers(&self) -> Option<&[String]>

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

pub fn attachments(&self) -> Option<&[Attachment]>

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

impl Cluster

pub fn builder() -> Builder

Trait Implementations

impl Clone for Cluster

fn clone(&self) -> Cluster

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

impl Debug for Cluster

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

impl PartialEq<Cluster> for Cluster

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

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

impl StructuralPartialEq for Cluster

Auto Trait Implementations

impl RefUnwindSafe for Cluster

impl Send for Cluster

impl Sync for Cluster

impl Unpin for Cluster

impl UnwindSafe for Cluster

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 statistics(&self) -> Option<&[KeyValuePair ]>

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

pub fn settings(&self) -> Option<&[ClusterSetting ]>

pub fn capacity_providers(&self) -> Option<&[String ]>

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

pub fn attachments(&self) -> Option<&[Attachment ]>

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