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 Amazon EC2 or External instance that's running the Amazon ECS agent and has been registered with a cluster.
Namespace: Amazon.ECS.Model
Assembly: AWSSDK.ECS.dll
Version: 3.x.y.z
public class ContainerInstance
The ContainerInstance type exposes the following members
Name | Description | |
---|---|---|
ContainerInstance() |
Name | Type | Description | |
---|---|---|---|
AgentConnected | System.Boolean |
Gets and sets the property AgentConnected.
This parameter returns |
|
AgentUpdateStatus | Amazon.ECS.AgentUpdateStatus |
Gets and sets the property AgentUpdateStatus.
The status of the most recent agent update. If an update wasn't ever requested, this
value is |
|
Attachments | System.Collections.Generic.List<Amazon.ECS.Model.Attachment> |
Gets and sets the property Attachments. The resources attached to a container instance, such as an elastic network interface. |
|
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. |
|
CapacityProviderName | System.String |
Gets and sets the property CapacityProviderName. The capacity provider that's associated with the container instance. |
|
ContainerInstanceArn | System.String |
Gets and sets the property ContainerInstanceArn. 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. |
|
Ec2InstanceId | System.String |
Gets and sets the property Ec2InstanceId. 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. |
|
HealthStatus | Amazon.ECS.Model.ContainerInstanceHealthStatus |
Gets and sets the property HealthStatus. An object representing the health status of the container instance. |
|
PendingTasksCount | System.Int32 |
Gets and sets the property PendingTasksCount.
The number of tasks on the container instance that are in the |
|
RegisteredAt | System.DateTime |
Gets and sets the property RegisteredAt. The Unix timestamp for the time when the container instance was registered. |
|
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. |
|
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 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 |
|
RunningTasksCount | System.Int32 |
Gets and sets the property RunningTasksCount.
The number of tasks on the container instance that have a desired status ( |
|
Status | System.String |
Gets and sets the property Status.
The status of the container instance. The valid values are
If your account has opted in to the
The |
|
StatusReason | System.String |
Gets and sets the property StatusReason. The reason that the container instance reached its current status. |
|
Tags | System.Collections.Generic.List<Amazon.ECS.Model.Tag> |
Gets and sets the property Tags. 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:
|
|
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'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 |
|
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. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5