AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.

Inheritance Hierarchy

System.Object
  Amazon.ECS.Model.ContainerInstance

Namespace: Amazon.ECS.Model
Assembly: AWSSDK.ECS.dll
Version: 3.x.y.z

Syntax

C#
public class ContainerInstance

The ContainerInstance type exposes the following members

Constructors

NameDescription
Public Method ContainerInstance()

Properties

NameTypeDescription
Public Property AgentConnected System.Boolean

Gets and sets the property AgentConnected.

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

Public Property AgentUpdateStatus Amazon.ECS.AgentUpdateStatus

Gets and sets the property AgentUpdateStatus.

The status of the most recent agent update. If an update has never been requested, this value is NULL.

Public Property Attachments System.Collections.Generic.List<Amazon.ECS.Model.Attachment>

Gets and sets the property Attachments.

The elastic network interfaces associated with the container instance.

Public Property Attributes System.Collections.Generic.List<Amazon.ECS.Model.Attribute>

Gets and sets the property Attributes.

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

Public Property ContainerInstanceArn System.String

Gets and sets the property ContainerInstanceArn.

The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.

Public Property Ec2InstanceId System.String

Gets and sets the property Ec2InstanceId.

The EC2 instance ID of the container instance.

Public Property PendingTasksCount System.Int32

Gets and sets the property PendingTasksCount.

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

Public Property RegisteredAt System.DateTime

Gets and sets the property RegisteredAt.

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

Public Property RegisteredResources System.Collections.Generic.List<Amazon.ECS.Model.Resource>

Gets and sets the property RegisteredResources.

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.

Public Property RemainingResources System.Collections.Generic.List<Amazon.ECS.Model.Resource>

Gets and sets the property RemainingResources.

For CPU and memory resource types, this parameter describes the remaining CPU and memory that has not already been 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 is not specified here is available for new tasks.

Public Property RunningTasksCount System.Int32

Gets and sets the property RunningTasksCount.

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

Public Property Status System.String

Gets and sets the property Status.

The status of the container instance. The valid values are ACTIVE, INACTIVE, or DRAINING. ACTIVE indicates that the container instance can accept tasks. DRAINING indicates that new tasks are not 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.

Public Property Version System.Int64

Gets and sets the property Version.

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

Public Property VersionInfo Amazon.ECS.Model.VersionInfo

Gets and sets the property VersionInfo.

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

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms