Struct aws_sdk_gamelift::input::CreateGameSessionInput [−][src]
#[non_exhaustive]pub struct CreateGameSessionInput {
pub fleet_id: Option<String>,
pub alias_id: Option<String>,
pub maximum_player_session_count: Option<i32>,
pub name: Option<String>,
pub game_properties: Option<Vec<GameProperty>>,
pub creator_id: Option<String>,
pub game_session_id: Option<String>,
pub idempotency_token: Option<String>,
pub game_session_data: Option<String>,
pub location: Option<String>,
}
Expand description
Represents the input for a request operation.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.fleet_id: Option<String>
A unique identifier for the fleet to create a game session in. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.
alias_id: Option<String>
A unique identifier for the alias associated with the fleet to create a game session in. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.
maximum_player_session_count: Option<i32>
The maximum number of players that can be connected simultaneously to the game session.
name: Option<String>
A descriptive label that is associated with a game session. Session names do not need to be unique.
game_properties: Option<Vec<GameProperty>>
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.
creator_id: Option<String>
A unique identifier for a player or entity creating the game session. This parameter is required when requesting a new game session on a fleet with a resource creation limit policy. This type of policy limits the number of concurrent active game sessions that one player can create within a certain time span. GameLift uses the CreatorId to evaluate the new request against the policy.
game_session_id: Option<String>
This parameter is no longer preferred. Please use
IdempotencyToken
instead. Custom string that uniquely
identifies a request for a new game session. Maximum token length is 48 characters. If
provided, this string is included in the new game session's ID.
idempotency_token: Option<String>
Custom string that uniquely identifies the new game session request. This is useful
for ensuring that game session requests with the same idempotency token are processed
only once. Subsequent requests with the same string return the original
GameSession
object, with an updated status. Maximum token length is 48
characters. If provided, this string is included in the new game session's ID.
A game session ARN has the following format:
arn:aws:gamelift:
. Idempotency tokens remain in use for 30 days after a game session has ended;
game session objects are retained for this time period and then deleted.
game_session_data: Option<String>
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.
location: Option<String>
A fleet's remote location to place the new game session in. If this parameter is not
set, the new game session is placed in the fleet's home Region. Specify a remote
location with an AWS Region code such as us-west-2
.
Implementations
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CreateGameSession, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CreateGameSession, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<CreateGameSession
>
Creates a new builder-style object to manufacture CreateGameSessionInput
A unique identifier for the fleet to create a game session in. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.
A unique identifier for the alias associated with the fleet to create a game session in. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.
The maximum number of players that can be connected simultaneously to the game session.
A descriptive label that is associated with a game session. Session names do not need to be unique.
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.
A unique identifier for a player or entity creating the game session. This parameter is required when requesting a new game session on a fleet with a resource creation limit policy. This type of policy limits the number of concurrent active game sessions that one player can create within a certain time span. GameLift uses the CreatorId to evaluate the new request against the policy.
This parameter is no longer preferred. Please use
IdempotencyToken
instead. Custom string that uniquely
identifies a request for a new game session. Maximum token length is 48 characters. If
provided, this string is included in the new game session's ID.
Custom string that uniquely identifies the new game session request. This is useful
for ensuring that game session requests with the same idempotency token are processed
only once. Subsequent requests with the same string return the original
GameSession
object, with an updated status. Maximum token length is 48
characters. If provided, this string is included in the new game session's ID.
A game session ARN has the following format:
arn:aws:gamelift:
. Idempotency tokens remain in use for 30 days after a game session has ended;
game session objects are retained for this time period and then deleted.
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.
Trait Implementations
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for CreateGameSessionInput
impl Send for CreateGameSessionInput
impl Sync for CreateGameSessionInput
impl Unpin for CreateGameSessionInput
impl UnwindSafe for CreateGameSessionInput
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