Struct ContainerInstance

#[non_exhaustive]
pub struct ContainerInstance {

    pub container_instance_arn: Option<String>,
    pub ec2_instance_id: Option<String>,
    pub capacity_provider_name: Option<String>,
    pub version: i64,
    pub version_info: Option<VersionInfo>,
    pub remaining_resources: Option<Vec<Resource>>,
    pub registered_resources: Option<Vec<Resource>>,
    pub status: Option<String>,
    pub status_reason: Option<String>,
    pub agent_connected: bool,
    pub running_tasks_count: i32,
    pub pending_tasks_count: i32,
    pub agent_update_status: Option<AgentUpdateStatus>,
    pub attributes: Option<Vec<Attribute>>,
    pub registered_at: Option<DateTime>,
    pub attachments: Option<Vec<Attachment>>,
    pub tags: Option<Vec<Tag>>,
    pub health_status: Option<ContainerInstanceHealthStatus>,
}

An Amazon EC2 or External instance that's running the Amazon ECS agent and has been registered with a cluster.

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

container_instance_arn: Option<String>

The Amazon Resource Name (ARN) of the container instance. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

ec2_instance_id: Option<String>

The ID of the container instance. For Amazon EC2 instances, this value is the Amazon EC2 instance ID. For external instances, this value is the Amazon Web Services Systems Manager managed instance ID.

capacity_provider_name: Option<String>

The capacity provider that's associated with the container instance.

version: i64

The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you're replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the detail object) to verify that the version in your event stream is current.

version_info: Option<VersionInfo>

The version information for the Amazon ECS container agent and Docker daemon running on the container instance.

remaining_resources: Option<Vec<Resource>>

For CPU and memory resource types, this parameter describes the remaining CPU and memory that wasn't already allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the host or bridge network mode). Any port that's not specified here is available for new tasks.

registered_resources: Option<Vec<Resource>>

For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.

status: Option<String>

The status of the container instance. The valid values are REGISTERING, REGISTRATION_FAILED, ACTIVE, INACTIVE, DEREGISTERING, or DRAINING.

If your account has opted in to the awsvpcTrunking account setting, then any newly registered container instance will transition to a REGISTERING status while the trunk elastic network interface is provisioned for the instance. If the registration fails, the instance will transition to a REGISTRATION_FAILED status. You can describe the container instance and see the reason for failure in the statusReason parameter. Once the container instance is terminated, the instance transitions to a DEREGISTERING status while the trunk elastic network interface is deprovisioned. The instance then transitions to an INACTIVE status.

The ACTIVE status indicates that the container instance can accept tasks. The DRAINING indicates that new tasks aren't placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container instance draining in the Amazon Elastic Container Service Developer Guide.

status_reason: Option<String>

The reason that the container instance reached its current status.

agent_connected: bool

This parameter returns true if the agent is connected to Amazon ECS. An instance with an agent that may be unhealthy or stopped return false. Only instances connected to an agent can accept task placement requests.

running_tasks_count: i32

The number of tasks on the container instance that have a desired status (desiredStatus) of RUNNING.

pending_tasks_count: i32

The number of tasks on the container instance that are in the PENDING status.

agent_update_status: Option<AgentUpdateStatus>

The status of the most recent agent update. If an update wasn't ever requested, this value is NULL.

attributes: Option<Vec<Attribute>>

The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.

registered_at: Option<DateTime>

The Unix timestamp for the time when the container instance was registered.

attachments: Option<Vec<Attachment>>

The resources attached to a container instance, such as an elastic network interface.

tags: Option<Vec<Tag>>

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

health_status: Option<ContainerInstanceHealthStatus>

An object representing the health status of the container instance.

Implementations

impl ContainerInstance

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

The Amazon Resource Name (ARN) of the container instance. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

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

The ID of the container instance. For Amazon EC2 instances, this value is the Amazon EC2 instance ID. For external instances, this value is the Amazon Web Services Systems Manager managed instance ID.

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

The capacity provider that's associated with the container instance.

pub fn version(&self) -> i64

The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you're replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the detail object) to verify that the version in your event stream is current.

pub fn version_info(&self) -> Option<&VersionInfo>

The version information for the Amazon ECS container agent and Docker daemon running on the container instance.

pub fn remaining_resources(&self) -> &[Resource]

For CPU and memory resource types, this parameter describes the remaining CPU and memory that wasn't already allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the host or bridge network mode). Any port that's not specified here is available for new tasks.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .remaining_resources.is_none().

pub fn registered_resources(&self) -> &[Resource]

For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .registered_resources.is_none().

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

The status of the container instance. The valid values are REGISTERING, REGISTRATION_FAILED, ACTIVE, INACTIVE, DEREGISTERING, or DRAINING.

If your account has opted in to the awsvpcTrunking account setting, then any newly registered container instance will transition to a REGISTERING status while the trunk elastic network interface is provisioned for the instance. If the registration fails, the instance will transition to a REGISTRATION_FAILED status. You can describe the container instance and see the reason for failure in the statusReason parameter. Once the container instance is terminated, the instance transitions to a DEREGISTERING status while the trunk elastic network interface is deprovisioned. The instance then transitions to an INACTIVE status.

The ACTIVE status indicates that the container instance can accept tasks. The DRAINING indicates that new tasks aren't placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container instance draining in the Amazon Elastic Container Service Developer Guide.

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

The reason that the container instance reached its current status.

pub fn agent_connected(&self) -> bool

This parameter returns true if the agent is connected to Amazon ECS. An instance with an agent that may be unhealthy or stopped return false. Only instances connected to an agent can accept task placement requests.

pub fn running_tasks_count(&self) -> i32

The number of tasks on the container instance that have a desired status (desiredStatus) of RUNNING.

pub fn pending_tasks_count(&self) -> i32

The number of tasks on the container instance that are in the PENDING status.

pub fn agent_update_status(&self) -> Option<&AgentUpdateStatus>

The status of the most recent agent update. If an update wasn't ever requested, this value is NULL.

pub fn attributes(&self) -> &[Attribute]

The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .attributes.is_none().

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

The Unix timestamp for the time when the container instance was registered.

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

The resources attached to a container instance, such as an elastic network interface.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .attachments.is_none().

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

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn health_status(&self) -> Option<&ContainerInstanceHealthStatus>

An object representing the health status of the container instance.

impl ContainerInstance

pub fn builder() -> ContainerInstanceBuilder

Creates a new builder-style object to manufacture ContainerInstance.

Trait Implementations

impl Clone for ContainerInstance

fn clone(&self) -> ContainerInstance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContainerInstance

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

Formats the value using the given formatter.

impl PartialEq for ContainerInstance

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ContainerInstance