Struct aws_sdk_gamelift::types::ContainerDependency

#[non_exhaustive]
pub struct ContainerDependency {
    pub container_name: Option<String>,
    pub condition: Option<ContainerDependencyCondition>,
}

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

A container's dependency on another container in the same container group. The dependency impacts how the dependent container is able to start or shut down based the status of the other container.

For example, ContainerA is configured with the following dependency: a START dependency on ContainerB. This means that ContainerA can't start until ContainerB has started. It also means that ContainerA must shut down before ContainerB.

Part of: ContainerDefinition

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

container_name: Option<String>

A descriptive label for the container definition that this container depends on.

condition: Option<ContainerDependencyCondition>

The condition that the dependency container must reach before the dependent container can start. Valid conditions include:

• START - The dependency container must have started.

• COMPLETE - The dependency container has run to completion (exits). Use this condition with nonessential containers, such as those that run a script and then exit. The dependency container can't be an essential container.

• SUCCESS - The dependency container has run to completion and exited with a zero status. The dependency container can't be an essential container.

• HEALTHY - The dependency container has passed its Docker health check. Use this condition with dependency containers that have health checks configured. This condition is confirmed at container group startup only.

Implementations

impl ContainerDependency

pub fn container_name(&self) -> Option<&str>

A descriptive label for the container definition that this container depends on.

pub fn condition(&self) -> Option<&ContainerDependencyCondition>

The condition that the dependency container must reach before the dependent container can start. Valid conditions include:

• START - The dependency container must have started.

• COMPLETE - The dependency container has run to completion (exits). Use this condition with nonessential containers, such as those that run a script and then exit. The dependency container can't be an essential container.

• SUCCESS - The dependency container has run to completion and exited with a zero status. The dependency container can't be an essential container.

• HEALTHY - The dependency container has passed its Docker health check. Use this condition with dependency containers that have health checks configured. This condition is confirmed at container group startup only.

impl ContainerDependency

pub fn builder() -> ContainerDependencyBuilder

Creates a new builder-style object to manufacture ContainerDependency.

Trait Implementations

impl Clone for ContainerDependency

fn clone(&self) -> ContainerDependency

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ContainerDependency

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ContainerDependency

fn eq(&self, other: &ContainerDependency) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ContainerDependency