Package software.amazon.awscdk.services.gamelift

Interface CfnContainerGroupDefinition.ContainerDependencyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnContainerGroupDefinition.ContainerDependencyProperty.Jsii$Proxy

Enclosing class:

CfnContainerGroupDefinition

@Stability(Stable)
public static interface CfnContainerGroupDefinition.ContainerDependencyProperty
extends software.amazon.jsii.JsiiSerializable

*This data type is currently not available.

It is under improvement as we respond to customer feedback from the Containers 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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.gamelift.*;
 ContainerDependencyProperty containerDependencyProperty = ContainerDependencyProperty.builder()
         .condition("condition")
         .containerName("containerName")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdependency.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnContainerGroupDefinition.ContainerDependencyProperty.Builder	A builder for CfnContainerGroupDefinition.ContainerDependencyProperty
static final class	CfnContainerGroupDefinition.ContainerDependencyProperty.Jsii$Proxy	An implementation for CfnContainerGroupDefinition.ContainerDependencyProperty

Method Summary

Modifier and Type	Method	Description
static CfnContainerGroupDefinition.ContainerDependencyProperty.Builder	builder()
String	getCondition()	The condition that the dependency container must reach before the dependent container can start.
String	getContainerName()	A descriptive label for the container definition that this container depends on.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCondition

@Stability(Stable)
@NotNull
String getCondition()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdependency.html#cfn-gamelift-containergroupdefinition-containerdependency-condition

getContainerName

@Stability(Stable)
@NotNull
String getContainerName()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdependency.html#cfn-gamelift-containergroupdefinition-containerdependency-containername

builder

@Stability(Stable)
static CfnContainerGroupDefinition.ContainerDependencyProperty.Builder builder()

Returns:

a CfnContainerGroupDefinition.ContainerDependencyProperty.Builder of CfnContainerGroupDefinition.ContainerDependencyProperty