Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data ContainerInstance = ContainerInstance' {
- agentConnected :: Maybe Bool
- agentUpdateStatus :: Maybe AgentUpdateStatus
- attachments :: Maybe [Attachment]
- attributes :: Maybe [Attribute]
- capacityProviderName :: Maybe Text
- containerInstanceArn :: Maybe Text
- ec2InstanceId :: Maybe Text
- healthStatus :: Maybe ContainerInstanceHealthStatus
- pendingTasksCount :: Maybe Int
- registeredAt :: Maybe POSIX
- registeredResources :: Maybe [Resource]
- remainingResources :: Maybe [Resource]
- runningTasksCount :: Maybe Int
- status :: Maybe Text
- statusReason :: Maybe Text
- tags :: Maybe [Tag]
- version :: Maybe Integer
- versionInfo :: Maybe VersionInfo
- newContainerInstance :: ContainerInstance
- containerInstance_agentConnected :: Lens' ContainerInstance (Maybe Bool)
- containerInstance_agentUpdateStatus :: Lens' ContainerInstance (Maybe AgentUpdateStatus)
- containerInstance_attachments :: Lens' ContainerInstance (Maybe [Attachment])
- containerInstance_attributes :: Lens' ContainerInstance (Maybe [Attribute])
- containerInstance_capacityProviderName :: Lens' ContainerInstance (Maybe Text)
- containerInstance_containerInstanceArn :: Lens' ContainerInstance (Maybe Text)
- containerInstance_ec2InstanceId :: Lens' ContainerInstance (Maybe Text)
- containerInstance_healthStatus :: Lens' ContainerInstance (Maybe ContainerInstanceHealthStatus)
- containerInstance_pendingTasksCount :: Lens' ContainerInstance (Maybe Int)
- containerInstance_registeredAt :: Lens' ContainerInstance (Maybe UTCTime)
- containerInstance_registeredResources :: Lens' ContainerInstance (Maybe [Resource])
- containerInstance_remainingResources :: Lens' ContainerInstance (Maybe [Resource])
- containerInstance_runningTasksCount :: Lens' ContainerInstance (Maybe Int)
- containerInstance_status :: Lens' ContainerInstance (Maybe Text)
- containerInstance_statusReason :: Lens' ContainerInstance (Maybe Text)
- containerInstance_tags :: Lens' ContainerInstance (Maybe [Tag])
- containerInstance_version :: Lens' ContainerInstance (Maybe Integer)
- containerInstance_versionInfo :: Lens' ContainerInstance (Maybe VersionInfo)
Documentation
data ContainerInstance Source #
An Amazon EC2 or External instance that's running the Amazon ECS agent and has been registered with a cluster.
See: newContainerInstance
smart constructor.
ContainerInstance' | |
|
Instances
newContainerInstance :: ContainerInstance Source #
Create a value of ContainerInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:agentConnected:ContainerInstance'
, containerInstance_agentConnected
- 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.
$sel:agentUpdateStatus:ContainerInstance'
, containerInstance_agentUpdateStatus
- The status of the most recent agent update. If an update wasn't ever
requested, this value is NULL
.
$sel:attachments:ContainerInstance'
, containerInstance_attachments
- The resources attached to a container instance, such as an elastic
network interface.
$sel:attributes:ContainerInstance'
, containerInstance_attributes
- The attributes set for the container instance, either by the Amazon ECS
container agent at instance registration or manually with the
PutAttributes operation.
$sel:capacityProviderName:ContainerInstance'
, containerInstance_capacityProviderName
- The capacity provider that's associated with the container instance.
$sel:containerInstanceArn:ContainerInstance'
, containerInstance_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.
$sel:ec2InstanceId:ContainerInstance'
, containerInstance_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.
$sel:healthStatus:ContainerInstance'
, containerInstance_healthStatus
- An object representing the health status of the container instance.
$sel:pendingTasksCount:ContainerInstance'
, containerInstance_pendingTasksCount
- The number of tasks on the container instance that are in the PENDING
status.
$sel:registeredAt:ContainerInstance'
, containerInstance_registeredAt
- The Unix timestamp for the time when the container instance was
registered.
$sel:registeredResources:ContainerInstance'
, containerInstance_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.
$sel:remainingResources:ContainerInstance'
, containerInstance_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 host
or
bridge
network mode). Any port that's not specified here is available
for new tasks.
$sel:runningTasksCount:ContainerInstance'
, containerInstance_runningTasksCount
- The number of tasks on the container instance that are in the RUNNING
status.
ContainerInstance
, containerInstance_status
- 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.
$sel:statusReason:ContainerInstance'
, containerInstance_statusReason
- The reason that the container instance reached its current status.
$sel:tags:ContainerInstance'
, containerInstance_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:
- 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.
$sel:version:ContainerInstance'
, containerInstance_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 detail
object) to verify that the version in your event stream is
current.
$sel:versionInfo:ContainerInstance'
, containerInstance_versionInfo
- The version information for the Amazon ECS container agent and Docker
daemon running on the container instance.
containerInstance_agentConnected :: Lens' ContainerInstance (Maybe Bool) Source #
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.
containerInstance_agentUpdateStatus :: Lens' ContainerInstance (Maybe AgentUpdateStatus) Source #
The status of the most recent agent update. If an update wasn't ever
requested, this value is NULL
.
containerInstance_attachments :: Lens' ContainerInstance (Maybe [Attachment]) Source #
The resources attached to a container instance, such as an elastic network interface.
containerInstance_attributes :: Lens' ContainerInstance (Maybe [Attribute]) Source #
The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.
containerInstance_capacityProviderName :: Lens' ContainerInstance (Maybe Text) Source #
The capacity provider that's associated with the container instance.
containerInstance_containerInstanceArn :: Lens' ContainerInstance (Maybe Text) Source #
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.
containerInstance_ec2InstanceId :: Lens' ContainerInstance (Maybe Text) Source #
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.
containerInstance_healthStatus :: Lens' ContainerInstance (Maybe ContainerInstanceHealthStatus) Source #
An object representing the health status of the container instance.
containerInstance_pendingTasksCount :: Lens' ContainerInstance (Maybe Int) Source #
The number of tasks on the container instance that are in the PENDING
status.
containerInstance_registeredAt :: Lens' ContainerInstance (Maybe UTCTime) Source #
The Unix timestamp for the time when the container instance was registered.
containerInstance_registeredResources :: Lens' ContainerInstance (Maybe [Resource]) Source #
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.
containerInstance_remainingResources :: Lens' ContainerInstance (Maybe [Resource]) Source #
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.
containerInstance_runningTasksCount :: Lens' ContainerInstance (Maybe Int) Source #
The number of tasks on the container instance that are in the RUNNING
status.
containerInstance_status :: Lens' ContainerInstance (Maybe Text) Source #
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.
containerInstance_statusReason :: Lens' ContainerInstance (Maybe Text) Source #
The reason that the container instance reached its current status.
containerInstance_tags :: Lens' ContainerInstance (Maybe [Tag]) Source #
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.
containerInstance_version :: Lens' ContainerInstance (Maybe Integer) Source #
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.
containerInstance_versionInfo :: Lens' ContainerInstance (Maybe VersionInfo) Source #
The version information for the Amazon ECS container agent and Docker daemon running on the container instance.