Struct SupportContainerDefinition 

#[non_exhaustive]
pub struct SupportContainerDefinition {
    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 resolved_image_digest: Option<String>,
    pub vcpu: Option<f64>,
}

Describes a support container in a container group. A support container might be in a game server container group or a per-instance container group. Support containers don't run game server processes.

You can update a support container definition and deploy the updates to an existing fleet. When creating or updating a game server container group definition, use the property GameServerContainerDefinitionInput.

Part of: ContainerGroupDefinition

Returned by: DescribeContainerGroupDefinition, ListContainerGroupDefinitions, 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>

The container definition identifier. Container names are unique within a container group definition.

depends_on: Option<Vec<ContainerDependency>>

Indicates that the container relies on the status of other containers in the same container group during its startup and shutdown sequences. A container might have dependencies on multiple containers.

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 that's passed to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API Reference.

essential: Option<bool>

Indicates whether the container is vital to the container group. If an essential container fails, the entire container group restarts.

health_check: Option<ContainerHealthCheck>

A configuration for a non-terminal health check. A support container automatically restarts if it stops functioning or if it fails this health check.

image_uri: Option<String>

The URI to the image that Amazon GameLift Servers deploys to a container fleet. For a more specific identifier, see ResolvedImageDigest.

memory_hard_limit_mebibytes: Option<i32>

The amount of memory that Amazon GameLift Servers makes available to the container. If memory limits aren't set for an individual container, the container shares the container group's total memory allocation.

Related data type: ContainerGroupDefinition TotalMemoryLimitMebibytes

port_configuration: Option<ContainerPortConfiguration>

A set of ports that allow access to the container from external users. Processes running in the container can bind to a one of these ports. Container ports aren't directly accessed by inbound traffic. Amazon GameLift Servers maps these container ports to externally accessible connection ports, which are assigned as needed from the container fleet's ConnectionPortRange.

resolved_image_digest: Option<String>

A unique and immutable identifier for the container image. The digest is a SHA 256 hash of the container image manifest.

vcpu: Option<f64>

The number of vCPU units that are reserved for the container. If no resources are reserved, the container shares the total vCPU limit for the container group.

Related data type: ContainerGroupDefinition TotalVcpuLimit

Implementations

impl SupportContainerDefinition

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

The container definition identifier. Container names are unique within a container group definition.

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

Indicates that the container relies on the status of other containers in the same container group during its startup and shutdown sequences. A container might have dependencies on multiple containers.

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 that's passed 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>

Indicates whether the container is vital to the container group. If an essential container fails, the entire container group restarts.

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

A configuration for a non-terminal health check. A support container automatically restarts if it stops functioning or if it fails this health check.

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

The URI to the image that Amazon GameLift Servers deploys to a container fleet. For a more specific identifier, see ResolvedImageDigest.

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

The amount of memory that Amazon GameLift Servers makes available to the container. If memory limits aren't set for an individual container, the container shares the container group's total memory allocation.

Related data type: ContainerGroupDefinition TotalMemoryLimitMebibytes

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

A set of ports that allow access to the container from external users. Processes running in the container can bind to a one of these ports. Container ports aren't directly accessed by inbound traffic. Amazon GameLift Servers maps these container ports to externally accessible connection ports, which are assigned as needed from the container fleet's ConnectionPortRange.

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

A unique and immutable identifier for the container image. The digest is a SHA 256 hash of the container image manifest.

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

The number of vCPU units that are reserved for the container. If no resources are reserved, the container shares the total vCPU limit for the container group.

Related data type: ContainerGroupDefinition TotalVcpuLimit

impl SupportContainerDefinition

pub fn builder() -> SupportContainerDefinitionBuilder

Creates a new builder-style object to manufacture SupportContainerDefinition.

Trait Implementations

impl Clone for SupportContainerDefinition

fn clone(&self) -> SupportContainerDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SupportContainerDefinition

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

Formats the value using the given formatter.

impl PartialEq for SupportContainerDefinition

fn eq(&self, other: &SupportContainerDefinition) -> 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 SupportContainerDefinition