Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ECS.Types.ContainerDependency

Description

Synopsis

data ContainerDependency = ContainerDependency' {
- containerName :: Text
- condition :: ContainerCondition
}
newContainerDependency :: Text -> ContainerCondition -> ContainerDependency
containerDependency_containerName :: Lens' ContainerDependency Text
containerDependency_condition :: Lens' ContainerDependency ContainerCondition

Documentation

data ContainerDependency Source #

The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.

Your Amazon ECS container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

For tasks using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later.

See: newContainerDependency smart constructor.

Constructors

ContainerDependency'

Fields

containerName :: Text
The name of a container.
condition :: ContainerCondition
The dependency condition of the container. The following are the available conditions and their behavior:
- START - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.
- COMPLETE - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition cannot be set on an essential container.
- SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status. This condition cannot be set on an essential container.
- HEALTHY - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.

Instances

Instances details

Eq ContainerDependency Source #
Instance details Defined in Amazonka.ECS.Types.ContainerDependency Methods (==) :: ContainerDependency -> ContainerDependency -> Bool # (/=) :: ContainerDependency -> ContainerDependency -> Bool #
Read ContainerDependency Source #
Instance details Defined in Amazonka.ECS.Types.ContainerDependency Methods readsPrec :: Int -> ReadS ContainerDependency # readList :: ReadS [ContainerDependency] # readPrec :: ReadPrec ContainerDependency # readListPrec :: ReadPrec [ContainerDependency] #
Show ContainerDependency Source #
Instance details Defined in Amazonka.ECS.Types.ContainerDependency Methods showsPrec :: Int -> ContainerDependency -> ShowS # show :: ContainerDependency -> String # showList :: [ContainerDependency] -> ShowS #
Generic ContainerDependency Source #
Instance details Defined in Amazonka.ECS.Types.ContainerDependency Associated Types type Rep ContainerDependency :: Type -> Type # Methods from :: ContainerDependency -> Rep ContainerDependency x # to :: Rep ContainerDependency x -> ContainerDependency #
NFData ContainerDependency Source #
Instance details Defined in Amazonka.ECS.Types.ContainerDependency Methods rnf :: ContainerDependency -> () #
Hashable ContainerDependency Source #
Instance details Defined in Amazonka.ECS.Types.ContainerDependency Methods hashWithSalt :: Int -> ContainerDependency -> Int # hash :: ContainerDependency -> Int #
ToJSON ContainerDependency Source #
Instance details Defined in Amazonka.ECS.Types.ContainerDependency Methods toJSON :: ContainerDependency -> Value # toEncoding :: ContainerDependency -> Encoding # toJSONList :: [ContainerDependency] -> Value # toEncodingList :: [ContainerDependency] -> Encoding #
FromJSON ContainerDependency Source #
Instance details Defined in Amazonka.ECS.Types.ContainerDependency Methods parseJSON :: Value -> Parser ContainerDependency # parseJSONList :: Value -> Parser [ContainerDependency] #
type Rep ContainerDependency Source #
Instance details Defined in Amazonka.ECS.Types.ContainerDependency type Rep ContainerDependency = D1 ('MetaData "ContainerDependency" "Amazonka.ECS.Types.ContainerDependency" "libZSservicesZSamazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "ContainerDependency'" 'PrefixI 'True) (S1 ('MetaSel ('Just "containerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "condition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ContainerCondition)))

newContainerDependency Source #

Arguments

:: Text	`$sel:containerName:ContainerDependency'`
-> ContainerCondition	`$sel:condition:ContainerDependency'`
-> ContainerDependency

Create a value of ContainerDependency 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:containerName:ContainerDependency', containerDependency_containerName - The name of a container.

$sel:condition:ContainerDependency', containerDependency_condition - The dependency condition of the container. The following are the available conditions and their behavior:

START - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.
COMPLETE - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition cannot be set on an essential container.
SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status. This condition cannot be set on an essential container.
HEALTHY - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.

containerDependency_containerName :: Lens' ContainerDependency Text Source #

The name of a container.

containerDependency_condition :: Lens' ContainerDependency ContainerCondition Source #

The dependency condition of the container. The following are the available conditions and their behavior:

START - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.
COMPLETE - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition cannot be set on an essential container.
SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status. This condition cannot be set on an essential container.
HEALTHY - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.