Struct aws_sdk_ecs::model::cluster::Builder

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

A builder for Cluster

Implementations

impl Builder

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

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.

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

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.

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

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

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

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

pub fn configuration(self, input: ClusterConfiguration) -> Self

The execute command configuration for the cluster.

pub fn set_configuration(self, input: Option<ClusterConfiguration>) -> Self

The execute command configuration for the cluster.

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

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.

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

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.

pub fn registered_container_instances_count(self, input: i32) -> Self

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

pub fn set_registered_container_instances_count(
    self,
    input: Option<i32>
) -> Self

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

pub fn running_tasks_count(self, input: i32) -> Self

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

pub fn set_running_tasks_count(self, input: Option<i32>) -> Self

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

pub fn pending_tasks_count(self, input: i32) -> Self

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

pub fn set_pending_tasks_count(self, input: Option<i32>) -> Self

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

pub fn active_services_count(self, input: i32) -> Self

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

pub fn set_active_services_count(self, input: Option<i32>) -> Self

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

pub fn statistics(self, input: KeyValuePair) -> Self

Appends an item to statistics.

To override the contents of this collection use set_statistics.

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

• runningEC2TasksCount

• RunningFargateTasksCount

• pendingEC2TasksCount

• pendingFargateTasksCount

• activeEC2ServiceCount

• activeFargateServiceCount

• drainingEC2ServiceCount

• drainingFargateServiceCount

pub fn set_statistics(self, input: Option<Vec<KeyValuePair>>) -> Self

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

• runningEC2TasksCount

• RunningFargateTasksCount

• pendingEC2TasksCount

• pendingFargateTasksCount

• activeEC2ServiceCount

• activeFargateServiceCount

• drainingEC2ServiceCount

• drainingFargateServiceCount

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

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

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.

pub fn settings(self, input: ClusterSetting) -> Self

Appends an item to settings.

To override the contents of this collection use set_settings.

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

pub fn set_settings(self, input: Option<Vec<ClusterSetting>>) -> Self

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

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

Appends an item to capacity_providers.

To override the contents of this collection use set_capacity_providers.

The capacity providers associated with the cluster.

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

The capacity providers associated with the cluster.

pub fn default_capacity_provider_strategy(
    self,
    input: CapacityProviderStrategyItem
) -> Self

Appends an item to default_capacity_provider_strategy.

To override the contents of this collection use set_default_capacity_provider_strategy.

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.

pub fn set_default_capacity_provider_strategy(
    self,
    input: Option<Vec<CapacityProviderStrategyItem>>
) -> Self

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.

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

Appends an item to attachments.

To override the contents of this collection use set_attachments.

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.

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

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.

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

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.

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

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.

pub fn build(self) -> Cluster

Consumes the builder and constructs a Cluster

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