Struct aws_sdk_gamelift::types::ContainerGroupDefinition

#[non_exhaustive]
pub struct ContainerGroupDefinition {
    pub container_group_definition_arn: Option<String>,
    pub creation_time: Option<DateTime>,
    pub operating_system: Option<ContainerOperatingSystem>,
    pub name: Option<String>,
    pub scheduling_strategy: Option<ContainerSchedulingStrategy>,
    pub total_memory_limit: Option<i32>,
    pub total_cpu_limit: Option<i32>,
    pub container_definitions: Option<Vec<ContainerDefinition>>,
    pub status: Option<ContainerGroupDefinitionStatus>,
    pub status_reason: Option<String>,
}

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

The properties that describe a container group resource. Container group definition properties can't be updated. To change a property, create a new container group definition.

Used with: CreateContainerGroupDefinition

Returned by: DescribeContainerGroupDefinition, ListContainerGroupDefinitions

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_group_definition_arn: Option<String>

The Amazon Resource Name (ARN) that is assigned to an Amazon GameLift ContainerGroupDefinition resource. It uniquely identifies the resource across all Amazon Web Services Regions. Format is arn:aws:gamelift: ::containergroupdefinition/[container group definition name] .

creation_time: Option<DateTime>

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

operating_system: Option<ContainerOperatingSystem>

The platform required for all containers in the container group definition.

name: Option<String>

A descriptive identifier for the container group definition. The name value is unique in an Amazon Web Services Region.

scheduling_strategy: Option<ContainerSchedulingStrategy>

The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group maintains only one copy per fleet instance.

total_memory_limit: Option<i32>

The amount of memory (in MiB) on a fleet instance to allocate for the container group. All containers in the group share these resources.

You can set additional limits for each ContainerDefinition in the group. If individual containers have limits, this value must meet the following requirements:

• Equal to or greater than the sum of all container-specific soft memory limits in the group.

• Equal to or greater than any container-specific hard limits in the group.

For more details on memory allocation, see the Container fleet design guide.

total_cpu_limit: Option<i32>

The amount of CPU units on a fleet instance to allocate for the container group. All containers in the group share these resources. This property is an integer value in CPU units (1 vCPU is equal to 1024 CPU units).

You can set additional limits for each ContainerDefinition in the group. If individual containers have limits, this value must be equal to or greater than the sum of all container-specific CPU limits in the group.

For more details on memory allocation, see the Container fleet design guide.

container_definitions: Option<Vec<ContainerDefinition>>

The set of container definitions that are included in the container group.

status: Option<ContainerGroupDefinitionStatus>

Current status of the container group definition resource. Values include:

• COPYING -- Amazon GameLift is in the process of making copies of all container images that are defined in the group. While in this state, the resource can't be used to create a container fleet.

• READY -- Amazon GameLift has copied the registry images for all containers that are defined in the group. You can use a container group definition in this status to create a container fleet.

• FAILED -- Amazon GameLift failed to create a valid container group definition resource. For more details on the cause of the failure, see StatusReason. A container group definition resource in failed status will be deleted within a few minutes.

status_reason: Option<String>

Additional information about a container group definition that's in FAILED status. Possible reasons include:

• An internal issue prevented Amazon GameLift from creating the container group definition resource. Delete the failed resource and call CreateContainerGroupDefinitionagain.

• An access-denied message means that you don't have permissions to access the container image on ECR. See IAM permission examples for help setting up required IAM permissions for Amazon GameLift.

• The ImageUri value for at least one of the containers in the container group definition was invalid or not found in the current Amazon Web Services account.

• At least one of the container images referenced in the container group definition exceeds the allowed size. For size limits, see Amazon GameLift endpoints and quotas.

• At least one of the container images referenced in the container group definition uses a different operating system than the one defined for the container group.

Implementations

impl ContainerGroupDefinition

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

The Amazon Resource Name (ARN) that is assigned to an Amazon GameLift ContainerGroupDefinition resource. It uniquely identifies the resource across all Amazon Web Services Regions. Format is arn:aws:gamelift: ::containergroupdefinition/[container group definition name] .

pub fn creation_time(&self) -> Option<&DateTime>

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

pub fn operating_system(&self) -> Option<&ContainerOperatingSystem>

The platform required for all containers in the container group definition.

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

A descriptive identifier for the container group definition. The name value is unique in an Amazon Web Services Region.

pub fn scheduling_strategy(&self) -> Option<&ContainerSchedulingStrategy>

The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group maintains only one copy per fleet instance.

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

The amount of memory (in MiB) on a fleet instance to allocate for the container group. All containers in the group share these resources.

You can set additional limits for each ContainerDefinition in the group. If individual containers have limits, this value must meet the following requirements:

• Equal to or greater than the sum of all container-specific soft memory limits in the group.

• Equal to or greater than any container-specific hard limits in the group.

For more details on memory allocation, see the Container fleet design guide.

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

The amount of CPU units on a fleet instance to allocate for the container group. All containers in the group share these resources. This property is an integer value in CPU units (1 vCPU is equal to 1024 CPU units).

You can set additional limits for each ContainerDefinition in the group. If individual containers have limits, this value must be equal to or greater than the sum of all container-specific CPU limits in the group.

For more details on memory allocation, see the Container fleet design guide.

pub fn container_definitions(&self) -> &[ContainerDefinition]

The set of container definitions that are included in the container group.

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

pub fn status(&self) -> Option<&ContainerGroupDefinitionStatus>

Current status of the container group definition resource. Values include:

• COPYING -- Amazon GameLift is in the process of making copies of all container images that are defined in the group. While in this state, the resource can't be used to create a container fleet.

• READY -- Amazon GameLift has copied the registry images for all containers that are defined in the group. You can use a container group definition in this status to create a container fleet.

• FAILED -- Amazon GameLift failed to create a valid container group definition resource. For more details on the cause of the failure, see StatusReason. A container group definition resource in failed status will be deleted within a few minutes.

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

Additional information about a container group definition that's in FAILED status. Possible reasons include:

• An internal issue prevented Amazon GameLift from creating the container group definition resource. Delete the failed resource and call CreateContainerGroupDefinitionagain.

• An access-denied message means that you don't have permissions to access the container image on ECR. See IAM permission examples for help setting up required IAM permissions for Amazon GameLift.

• The ImageUri value for at least one of the containers in the container group definition was invalid or not found in the current Amazon Web Services account.

• At least one of the container images referenced in the container group definition exceeds the allowed size. For size limits, see Amazon GameLift endpoints and quotas.

• At least one of the container images referenced in the container group definition uses a different operating system than the one defined for the container group.

impl ContainerGroupDefinition

pub fn builder() -> ContainerGroupDefinitionBuilder

Creates a new builder-style object to manufacture ContainerGroupDefinition.

Trait Implementations

impl Clone for ContainerGroupDefinition

fn clone(&self) -> ContainerGroupDefinition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ContainerGroupDefinition

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

Formats the value using the given formatter.

impl PartialEq for ContainerGroupDefinition

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