Struct aws_sdk_gamelift::types::builders::GameServerGroupBuilder

#[non_exhaustive]
pub struct GameServerGroupBuilder { /* private fields */ }

A builder for GameServerGroup.

Implementations

impl GameServerGroupBuilder

pub fn game_server_group_name(self, input: impl Into<String>) -> Self

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

pub fn set_game_server_group_name(self, input: Option<String>) -> Self

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

pub fn get_game_server_group_name(&self) -> &Option<String>

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

pub fn game_server_group_arn(self, input: impl Into<String>) -> Self

A generated unique ID for the game server group.

pub fn set_game_server_group_arn(self, input: Option<String>) -> Self

A generated unique ID for the game server group.

pub fn get_game_server_group_arn(&self) -> &Option<String>

A generated unique ID for the game server group.

pub fn role_arn(self, input: impl Into<String>) -> Self

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

pub fn set_role_arn(self, input: Option<String>) -> Self

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

pub fn get_role_arn(&self) -> &Option<String>

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

pub fn instance_definitions(self, input: InstanceDefinition) -> Self

Appends an item to instance_definitions.

To override the contents of this collection use set_instance_definitions.

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

pub fn set_instance_definitions( self, input: Option<Vec<InstanceDefinition>> ) -> Self

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

pub fn get_instance_definitions(&self) -> &Option<Vec<InstanceDefinition>>

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

pub fn balancing_strategy(self, input: BalancingStrategy) -> Self

Indicates how Amazon 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 set_balancing_strategy(self, input: Option<BalancingStrategy>) -> Self

Indicates how Amazon 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 get_balancing_strategy(&self) -> &Option<BalancingStrategy>

Indicates how Amazon 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, input: GameServerProtectionPolicy ) -> Self

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 Amazon Web Services regardless of protection status.

pub fn set_game_server_protection_policy( self, input: Option<GameServerProtectionPolicy> ) -> Self

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 Amazon Web Services regardless of protection status.

pub fn get_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 Amazon Web Services regardless of protection status.

pub fn auto_scaling_group_arn(self, input: impl Into<String>) -> Self

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

pub fn set_auto_scaling_group_arn(self, input: Option<String>) -> Self

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

pub fn get_auto_scaling_group_arn(&self) -> &Option<String>

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

pub fn status(self, input: GameServerGroupStatus) -> Self

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

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

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

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

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

• DELETING - Amazon GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. Amazon 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 set_status(self, input: Option<GameServerGroupStatus>) -> Self

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

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

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

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

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

• DELETING - Amazon GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. Amazon 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 get_status(&self) -> &Option<GameServerGroupStatus>

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

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

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

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

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

• DELETING - Amazon GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. Amazon 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, input: impl Into<String>) -> Self

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

pub fn set_status_reason(self, input: Option<String>) -> Self

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

pub fn get_status_reason(&self) -> &Option<String>

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, input: GameServerGroupAction) -> Self

Appends an item to suspended_actions.

To override the contents of this collection use set_suspended_actions.

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

pub fn set_suspended_actions( self, input: Option<Vec<GameServerGroupAction>> ) -> Self

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

pub fn get_suspended_actions(&self) -> &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.

pub fn creation_time(self, input: DateTime) -> Self

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 set_creation_time(self, input: Option<DateTime>) -> Self

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 get_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, input: DateTime) -> Self

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

pub fn set_last_updated_time(self, input: Option<DateTime>) -> Self

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

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

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

pub fn build(self) -> GameServerGroup

Consumes the builder and constructs a GameServerGroup.

Trait Implementations

impl Clone for GameServerGroupBuilder

fn clone(&self) -> GameServerGroupBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GameServerGroupBuilder

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

Formats the value using the given formatter.

impl Default for GameServerGroupBuilder

fn default() -> GameServerGroupBuilder

Returns the “default value” for a type.

impl PartialEq<GameServerGroupBuilder> for GameServerGroupBuilder

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