Struct SupportContainerDefinitionInput 

#[non_exhaustive]
pub struct SupportContainerDefinitionInput {
    pub container_name: Option<String>,
    pub depends_on: Option<Vec<ContainerDependency>>,
    pub mount_points: Option<Vec<ContainerMountPoint>>,
    pub environment_override: Option<Vec<ContainerEnvironment>>,
    pub essential: Option<bool>,
    pub health_check: Option<ContainerHealthCheck>,
    pub image_uri: Option<String>,
    pub memory_hard_limit_mebibytes: Option<i32>,
    pub port_configuration: Option<ContainerPortConfiguration>,
    pub vcpu: Option<f64>,
}

Describes a support container in a container group. You can define a support container in either a game server container group or a per-instance container group. Support containers don't run game server processes.

This definition includes container configuration, resources, and start instructions. Use this data type when creating or updating a container group definition. For properties of a deployed support container, see SupportContainerDefinition.

Use with: CreateContainerGroupDefinition, UpdateContainerGroupDefinition

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 string that uniquely identifies the container definition within a container group.

depends_on: Option<Vec<ContainerDependency>>

Establishes dependencies between this container and the status of other containers in the same container group. A container can have dependencies on multiple different containers.

.

You can use dependencies to establish a startup/shutdown sequence across the container group. For example, you might specify that ContainerB has a START dependency on ContainerA. This dependency means that ContainerB can't start until after ContainerA has started. This dependency is reversed on shutdown, which means that ContainerB must shut down before ContainerA can shut down.

mount_points: Option<Vec<ContainerMountPoint>>

A mount point that binds a path inside the container to a file or directory on the host system and lets it access the file or directory.

environment_override: Option<Vec<ContainerEnvironment>>

A set of environment variables to pass to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API Reference.

essential: Option<bool>

Flags the container as vital for the container group to function properly. If an essential container fails, the entire container group restarts. At least one support container in a per-instance container group must be essential. When flagging a container as essential, also configure a health check so that the container can signal that it's healthy.

health_check: Option<ContainerHealthCheck>

Configuration for a non-terminal health check. A container automatically restarts if it stops functioning. With a health check, you can define additional reasons to flag a container as unhealthy and restart it. If an essential container fails a health check, the entire container group restarts.

image_uri: Option<String>

The location of the container image to deploy to a container fleet. Provide an image in an Amazon Elastic Container Registry public or private repository. The repository must be in the same Amazon Web Services account and Amazon Web Services Region where you're creating the container group definition. For limits on image size, see Amazon GameLift Servers endpoints and quotas. You can use any of the following image URI formats:

• Image ID only: \[AWS account\].dkr.ecr.\[AWS region\].amazonaws.com/\[repository ID\]

• Image ID and digest: \[AWS account\].dkr.ecr.\[AWS region\].amazonaws.com/\[repository ID\]@\[digest\]

• Image ID and tag: \[AWS account\].dkr.ecr.\[AWS region\].amazonaws.com/\[repository ID\]:\[tag\]

memory_hard_limit_mebibytes: Option<i32>

A specified amount of memory (in MiB) to reserve for this container. If you don't specify a container-specific memory limit, the container shares the container group's total memory allocation.

Related data type: ContainerGroupDefinitionTotalMemoryLimitMebibytes

port_configuration: Option<ContainerPortConfiguration>

A set of ports that Amazon GameLift Servers can assign to processes in a container. The container port configuration must have enough ports for each container process that accepts inbound traffic connections. A container port configuration can have can have one or more container port ranges. Each range specifies starting and ending values as well as the supported network protocol.

Container ports aren't directly accessed by inbound traffic. Amazon GameLift Servers maps each container port to an externally accessible connection port (see the container fleet property ConnectionPortRange).

vcpu: Option<f64>

The number of vCPU units to reserve for this container. The container can use more resources when needed, if available. If you don't reserve CPU units for this container, it shares the container group's total vCPU limit.

Related data type: ContainerGroupDefinition TotalCpuLimit

Implementations

impl SupportContainerDefinitionInput

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

A string that uniquely identifies the container definition within a container group.

pub fn depends_on(&self) -> &[ContainerDependency]

Establishes dependencies between this container and the status of other containers in the same container group. A container can have dependencies on multiple different containers.

.

You can use dependencies to establish a startup/shutdown sequence across the container group. For example, you might specify that ContainerB has a START dependency on ContainerA. This dependency means that ContainerB can't start until after ContainerA has started. This dependency is reversed on shutdown, which means that ContainerB must shut down before ContainerA can shut down.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .depends_on.is_none().

pub fn mount_points(&self) -> &[ContainerMountPoint]

A mount point that binds a path inside the container to a file or directory on the host system and lets it access the file or directory.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .mount_points.is_none().

pub fn environment_override(&self) -> &[ContainerEnvironment]

A set of environment variables to pass to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API Reference.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .environment_override.is_none().

pub fn essential(&self) -> Option<bool>

Flags the container as vital for the container group to function properly. If an essential container fails, the entire container group restarts. At least one support container in a per-instance container group must be essential. When flagging a container as essential, also configure a health check so that the container can signal that it's healthy.

pub fn health_check(&self) -> Option<&ContainerHealthCheck>

Configuration for a non-terminal health check. A container automatically restarts if it stops functioning. With a health check, you can define additional reasons to flag a container as unhealthy and restart it. If an essential container fails a health check, the entire container group restarts.

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

The location of the container image to deploy to a container fleet. Provide an image in an Amazon Elastic Container Registry public or private repository. The repository must be in the same Amazon Web Services account and Amazon Web Services Region where you're creating the container group definition. For limits on image size, see Amazon GameLift Servers endpoints and quotas. You can use any of the following image URI formats:

• Image ID only: \[AWS account\].dkr.ecr.\[AWS region\].amazonaws.com/\[repository ID\]

• Image ID and digest: \[AWS account\].dkr.ecr.\[AWS region\].amazonaws.com/\[repository ID\]@\[digest\]

• Image ID and tag: \[AWS account\].dkr.ecr.\[AWS region\].amazonaws.com/\[repository ID\]:\[tag\]

pub fn memory_hard_limit_mebibytes(&self) -> Option<i32>

A specified amount of memory (in MiB) to reserve for this container. If you don't specify a container-specific memory limit, the container shares the container group's total memory allocation.

Related data type: ContainerGroupDefinitionTotalMemoryLimitMebibytes

pub fn port_configuration(&self) -> Option<&ContainerPortConfiguration>

A set of ports that Amazon GameLift Servers can assign to processes in a container. The container port configuration must have enough ports for each container process that accepts inbound traffic connections. A container port configuration can have can have one or more container port ranges. Each range specifies starting and ending values as well as the supported network protocol.

Container ports aren't directly accessed by inbound traffic. Amazon GameLift Servers maps each container port to an externally accessible connection port (see the container fleet property ConnectionPortRange).

pub fn vcpu(&self) -> Option<f64>

The number of vCPU units to reserve for this container. The container can use more resources when needed, if available. If you don't reserve CPU units for this container, it shares the container group's total vCPU limit.

Related data type: ContainerGroupDefinition TotalCpuLimit

impl SupportContainerDefinitionInput

pub fn builder() -> SupportContainerDefinitionInputBuilder

Creates a new builder-style object to manufacture SupportContainerDefinitionInput.

Trait Implementations

impl Clone for SupportContainerDefinitionInput

fn clone(&self) -> SupportContainerDefinitionInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SupportContainerDefinitionInput

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

Formats the value using the given formatter.

impl PartialEq for SupportContainerDefinitionInput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for SupportContainerDefinitionInput