Amazonka.ECS.Types.Container

Documentation

data Container

A Docker container that's part of a task.

See: newContainer smart constructor.

Constructors

Container'

Fields

• containerArn :: Maybe Text

  The Amazon Resource Name (ARN) of the container.

• cpu :: Maybe Text

  The number of CPU units set for the container. The value is 0 if no value was specified in the container definition when the task definition was registered.

• exitCode :: Maybe Int

  The exit code returned from the container.

• gpuIds :: Maybe [Text]

  The IDs of each GPU assigned to the container.

• healthStatus :: Maybe HealthStatus

  The health status of the container. If health checks aren't configured for this container in its task definition, then it reports the health status as UNKNOWN.

• image :: Maybe Text

  The image used for the container.

• imageDigest :: Maybe Text

  The container image manifest digest.

  The imageDigest is only returned if the container is using an image hosted in Amazon ECR, otherwise it is omitted.

• lastStatus :: Maybe Text

  The last known status of the container.

• managedAgents :: Maybe [ManagedAgent]

  The details of any Amazon ECS managed agents associated with the container.

• memory :: Maybe Text

  The hard limit (in MiB) of memory set for the container.

• memoryReservation :: Maybe Text

  The soft limit (in MiB) of memory set for the container.

• name :: Maybe Text

  The name of the container.

• networkBindings :: Maybe [NetworkBinding]

  The network bindings associated with the container.

• networkInterfaces :: Maybe [NetworkInterface]

  The network interfaces associated with the container.

• reason :: Maybe Text

  A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

• runtimeId :: Maybe Text

  The ID of the Docker container.

• taskArn :: Maybe Text

  The ARN of the task.

Instances

FromJSON Container

Defined in Amazonka.ECS.Types.Container

Methods

parseJSON :: Value -> Parser Container

parseJSONList :: Value -> Parser [Container]

Generic Container

Defined in Amazonka.ECS.Types.Container

Associated Types

type Rep Container :: Type -> Type

Methods

from :: Container -> Rep Container x

to :: Rep Container x -> Container

Read Container

Defined in Amazonka.ECS.Types.Container

Methods

readsPrec :: Int -> ReadS Container

readList :: ReadS [Container]

readPrec :: ReadPrec Container

readListPrec :: ReadPrec [Container]

Show Container

Defined in Amazonka.ECS.Types.Container

Methods

showsPrec :: Int -> Container -> ShowS

show :: Container -> String

showList :: [Container] -> ShowS

NFData Container

Defined in Amazonka.ECS.Types.Container

Methods

rnf :: Container -> ()

Eq Container

Defined in Amazonka.ECS.Types.Container

Methods

(==) :: Container -> Container -> Bool

(/=) :: Container -> Container -> Bool

Hashable Container

Defined in Amazonka.ECS.Types.Container

Methods

hashWithSalt :: Int -> Container -> Int

hash :: Container -> Int

type Rep Container

Defined in Amazonka.ECS.Types.Container

type Rep Container = D1 ('MetaData "Container" "Amazonka.ECS.Types.Container" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "Container'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "containerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "cpu") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "exitCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "gpuIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 ('MetaSel ('Just "healthStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HealthStatus)) :*: S1 ('MetaSel ('Just "image") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "imageDigest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "managedAgents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ManagedAgent])) :*: S1 ('MetaSel ('Just "memory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "memoryReservation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "networkBindings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [NetworkBinding])) :*: S1 ('MetaSel ('Just "networkInterfaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [NetworkInterface]))) :*: (S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "runtimeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "taskArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))))

newContainer :: Container

Create a value of Container 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:containerArn:Container', container_containerArn - The Amazon Resource Name (ARN) of the container.

$sel:cpu:Container', container_cpu - The number of CPU units set for the container. The value is 0 if no value was specified in the container definition when the task definition was registered.

$sel:exitCode:Container', container_exitCode - The exit code returned from the container.

$sel:gpuIds:Container', container_gpuIds - The IDs of each GPU assigned to the container.

$sel:healthStatus:Container', container_healthStatus - The health status of the container. If health checks aren't configured for this container in its task definition, then it reports the health status as UNKNOWN.

$sel:image:Container', container_image - The image used for the container.

$sel:imageDigest:Container', container_imageDigest - The container image manifest digest.

The imageDigest is only returned if the container is using an image hosted in Amazon ECR, otherwise it is omitted.

Container, container_lastStatus - The last known status of the container.

$sel:managedAgents:Container', container_managedAgents - The details of any Amazon ECS managed agents associated with the container.

$sel:memory:Container', container_memory - The hard limit (in MiB) of memory set for the container.

$sel:memoryReservation:Container', container_memoryReservation - The soft limit (in MiB) of memory set for the container.

Container, container_name - The name of the container.

$sel:networkBindings:Container', container_networkBindings - The network bindings associated with the container.

$sel:networkInterfaces:Container', container_networkInterfaces - The network interfaces associated with the container.

Container, container_reason - A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

$sel:runtimeId:Container', container_runtimeId - The ID of the Docker container.

$sel:taskArn:Container', container_taskArn - The ARN of the task.

container_containerArn :: Lens' Container (Maybe Text)

The Amazon Resource Name (ARN) of the container.

container_cpu :: Lens' Container (Maybe Text)

The number of CPU units set for the container. The value is 0 if no value was specified in the container definition when the task definition was registered.

container_exitCode :: Lens' Container (Maybe Int)

The exit code returned from the container.

container_gpuIds :: Lens' Container (Maybe [Text])

The IDs of each GPU assigned to the container.

container_healthStatus :: Lens' Container (Maybe HealthStatus)

The health status of the container. If health checks aren't configured for this container in its task definition, then it reports the health status as UNKNOWN.

container_image :: Lens' Container (Maybe Text)

The image used for the container.

container_imageDigest :: Lens' Container (Maybe Text)

The container image manifest digest.

The imageDigest is only returned if the container is using an image hosted in Amazon ECR, otherwise it is omitted.

container_lastStatus :: Lens' Container (Maybe Text)

The last known status of the container.

container_managedAgents :: Lens' Container (Maybe [ManagedAgent])

The details of any Amazon ECS managed agents associated with the container.

container_memory :: Lens' Container (Maybe Text)

The hard limit (in MiB) of memory set for the container.

container_memoryReservation :: Lens' Container (Maybe Text)

The soft limit (in MiB) of memory set for the container.

container_name :: Lens' Container (Maybe Text)

The name of the container.

container_networkBindings :: Lens' Container (Maybe [NetworkBinding])

The network bindings associated with the container.

container_networkInterfaces :: Lens' Container (Maybe [NetworkInterface])

The network interfaces associated with the container.

container_reason :: Lens' Container (Maybe Text)

A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

container_runtimeId :: Lens' Container (Maybe Text)

The ID of the Docker container.

container_taskArn :: Lens' Container (Maybe Text)

The ARN of the task.