Struct aws_sdk_gamelift::model::game_session::Builder [−][src]
#[non_exhaustive]pub struct Builder { /* fields omitted */ }
Expand description
A builder for GameSession
Implementations
A unique identifier for the game session. A game session ARN has the following format:
arn:aws:gamelift:
.
A unique identifier for the game session. A game session ARN has the following format:
arn:aws:gamelift:
.
A descriptive label that is associated with a game session. Session names do not need to be unique.
A descriptive label that is associated with a game session. Session names do not need to be unique.
A unique identifier for the fleet that the game session is running on.
A unique identifier for the fleet that the game session is running on.
The Amazon Resource Name (ARN) associated with the GameLift fleet that this game session is running on.
The Amazon Resource Name (ARN) associated with the GameLift fleet that this game session is running on.
A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"
).
A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"
).
A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"
).
A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"
).
Number of players currently in the game session.
Number of players currently in the game session.
The maximum number of players that can be connected simultaneously to the game session.
The maximum number of players that can be connected simultaneously to the game session.
Current status of the game session. A game session must have an ACTIVE
status to have player sessions.
Current status of the game session. A game session must have an ACTIVE
status to have player sessions.
Provides additional information about game session status. INTERRUPTED
indicates that the game session was hosted on a spot instance that was reclaimed,
causing the active game session to be terminated.
Provides additional information about game session status. INTERRUPTED
indicates that the game session was hosted on a spot instance that was reclaimed,
causing the active game session to be terminated.
Appends an item to game_properties
.
To override the contents of this collection use set_game_properties
.
A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session. You can search for active game sessions based on this custom data with SearchGameSessions.
A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session. You can search for active game sessions based on this custom data with SearchGameSessions.
The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.
The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.
The DNS identifier assigned to the instance that is running the game session. Values have the following format:
-
TLS-enabled fleets:
.. .amazongamelift.com -
Non-TLS-enabled fleets:
ec2-
. (See Amazon EC2 Instance IP Addressing.).compute.amazonaws.com
When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.
The DNS identifier assigned to the instance that is running the game session. Values have the following format:
-
TLS-enabled fleets:
.. .amazongamelift.com -
Non-TLS-enabled fleets:
ec2-
. (See Amazon EC2 Instance IP Addressing.).compute.amazonaws.com
When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.
The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number.
The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number.
Indicates whether or not the game session is accepting new players.
pub fn set_player_session_creation_policy(
self,
input: Option<PlayerSessionCreationPolicy>
) -> Self
pub fn set_player_session_creation_policy(
self,
input: Option<PlayerSessionCreationPolicy>
) -> Self
Indicates whether or not the game session is accepting new players.
A unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.
A unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.
A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session.
A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session.
Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data. Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill).
Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data. Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill).
The fleet location where the game session is running. This value might specify the
fleet's home Region or a remote location. Location is expressed as an AWS Region code
such as us-west-2
.
The fleet location where the game session is running. This value might specify the
fleet's home Region or a remote location. Location is expressed as an AWS Region code
such as us-west-2
.
Consumes the builder and constructs a GameSession
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for Builder
impl UnwindSafe for Builder
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more