Struct aws_sdk_gamelift::model::GameServerGroup

#[non_exhaustive]
pub struct GameServerGroup {
    pub game_server_group_name: Option<String>,
    pub game_server_group_arn: Option<String>,
    pub role_arn: Option<String>,
    pub instance_definitions: Option<Vec<InstanceDefinition>>,
    pub balancing_strategy: Option<BalancingStrategy>,
    pub game_server_protection_policy: Option<GameServerProtectionPolicy>,
    pub auto_scaling_group_arn: Option<String>,
    pub status: Option<GameServerGroupStatus>,
    pub status_reason: Option<String>,
    pub suspended_actions: Option<Vec<GameServerGroupAction>>,
    pub creation_time: Option<DateTime>,
    pub last_updated_time: Option<DateTime>,
}

This data type is used with the GameLift FleetIQ and game server groups.

Properties that describe a game server group resource. A game server group manages certain properties related to a corresponding EC2 Auto Scaling group.

A game server group is created by a successful call to CreateGameServerGroup and deleted by calling DeleteGameServerGroup. Game server group activity can be temporarily suspended and resumed by calling SuspendGameServerGroup and ResumeGameServerGroup, respectively.

Related actions

CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task

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.

game_server_group_name: Option<String>

A developer-defined identifier for the game server group. The name is unique for each Region in each AWS account.

game_server_group_arn: Option<String>

A generated unique ID for the game server group.

role_arn: Option<String>

The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

instance_definitions: Option<Vec<InstanceDefinition>>

The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

balancing_strategy: Option<BalancingStrategy>

Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

• SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.

• SPOT_PREFERRED - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.

• ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.

game_server_protection_policy: Option<GameServerProtectionPolicy>

A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status.

auto_scaling_group_arn: Option<String>

A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.

status: Option<GameServerGroupStatus>

The current status of the game server group. Possible statuses include:

• NEW - GameLift FleetIQ has validated the CreateGameServerGroup() request.

• ACTIVATING - GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your AWS account.

• ACTIVE - The game server group has been successfully created.

• DELETE_SCHEDULED - A request to delete the game server group has been received.

• DELETING - GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. GameLift FleetIQ must first complete and release hosts before it deletes the Auto Scaling group and the game server group.

• DELETED - The game server group has been successfully deleted.

• ERROR - The asynchronous processes of activating or deleting a game server group has failed, resulting in an error state.

status_reason: Option<String>

Additional information about the current game server group status. This information might provide additional insight on groups that are in ERROR status.

suspended_actions: Option<Vec<GameServerGroupAction>>

A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.

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").

last_updated_time: Option<DateTime>

A timestamp that indicates when this game server group was last updated.

Implementations

impl GameServerGroup

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

A developer-defined identifier for the game server group. The name is unique for each Region in each AWS account.

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

A generated unique ID for the game server group.

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

The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

pub fn instance_definitions(&self) -> Option<&[InstanceDefinition]>

The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

pub fn balancing_strategy(&self) -> Option<&BalancingStrategy>

Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

• SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.

• SPOT_PREFERRED - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.

• ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.

pub fn game_server_protection_policy(
    &self
) -> Option<&GameServerProtectionPolicy>

A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status.

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

A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.

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

The current status of the game server group. Possible statuses include:

• NEW - GameLift FleetIQ has validated the CreateGameServerGroup() request.

• ACTIVATING - GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your AWS account.

• ACTIVE - The game server group has been successfully created.

• DELETE_SCHEDULED - A request to delete the game server group has been received.

• DELETING - GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. GameLift FleetIQ must first complete and release hosts before it deletes the Auto Scaling group and the game server group.

• DELETED - The game server group has been successfully deleted.

• ERROR - The asynchronous processes of activating or deleting a game server group has failed, resulting in an error state.

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

Additional information about the current game server group status. This information might provide additional insight on groups that are in ERROR status.

pub fn suspended_actions(&self) -> Option<&[GameServerGroupAction]>

A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.

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 last_updated_time(&self) -> Option<&DateTime>

A timestamp that indicates when this game server group was last updated.

impl GameServerGroup

pub fn builder() -> Builder

Creates a new builder-style object to manufacture GameServerGroup

Trait Implementations

impl Clone for GameServerGroup

fn clone(&self) -> GameServerGroup

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GameServerGroup

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

Formats the value using the given formatter.

impl PartialEq<GameServerGroup> for GameServerGroup

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

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

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

This method tests for !=.

impl StructuralPartialEq for GameServerGroup