Struct aws_sdk_ecs::model::ContainerDependency
source · [−]#[non_exhaustive]pub struct ContainerDependency {
pub container_name: Option<String>,
pub condition: Option<ContainerCondition>,
}
Expand description
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 use 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're 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 that use the Fargate launch type, the task or service requires the following platforms:
-
Linux platform version
1.3.0
or later. -
Windows platform version
1.0.0
or later.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.container_name: Option<String>
The name of a container.
condition: Option<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 can't be set on an essential container. -
SUCCESS
- This condition is the same asCOMPLETE
, but it also requires that the container exits with azero
status. This condition can't 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.
Implementations
sourceimpl ContainerDependency
impl ContainerDependency
sourcepub fn container_name(&self) -> Option<&str>
pub fn container_name(&self) -> Option<&str>
The name of a container.
sourcepub fn condition(&self) -> Option<&ContainerCondition>
pub fn condition(&self) -> Option<&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 can't be set on an essential container. -
SUCCESS
- This condition is the same asCOMPLETE
, but it also requires that the container exits with azero
status. This condition can't 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.
sourceimpl ContainerDependency
impl ContainerDependency
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture ContainerDependency
Trait Implementations
sourceimpl Clone for ContainerDependency
impl Clone for ContainerDependency
sourcefn clone(&self) -> ContainerDependency
fn clone(&self) -> ContainerDependency
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for ContainerDependency
impl Debug for ContainerDependency
sourceimpl PartialEq<ContainerDependency> for ContainerDependency
impl PartialEq<ContainerDependency> for ContainerDependency
sourcefn eq(&self, other: &ContainerDependency) -> bool
fn eq(&self, other: &ContainerDependency) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &ContainerDependency) -> bool
fn ne(&self, other: &ContainerDependency) -> bool
This method tests for !=
.
impl StructuralPartialEq for ContainerDependency
Auto Trait Implementations
impl RefUnwindSafe for ContainerDependency
impl Send for ContainerDependency
impl Sync for ContainerDependency
impl Unpin for ContainerDependency
impl UnwindSafe for ContainerDependency
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more