/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the gamelift-2015-10-01.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.GameLift.Model
{
///
/// Container for the parameters to the RegisterGameServer operation.
/// This operation is used with the Amazon GameLift FleetIQ solution and game server
/// groups.
///
///
///
/// Creates a new game server resource and notifies Amazon GameLift FleetIQ that the game
/// server is ready to host gameplay and players. This operation is called by a game server
/// process that is running on an instance in a game server group. Registering game servers
/// enables Amazon GameLift FleetIQ to track available game servers and enables game clients
/// and services to claim a game server for a new game session.
///
///
///
/// To register a game server, identify the game server group and instance where the game
/// server is running, and provide a unique identifier for the game server. You can also
/// include connection and game server data.
///
///
///
/// Once a game server is successfully registered, it is put in status AVAILABLE.
/// A request to register a game server may fail if the instance it is running on is in
/// the process of shutting down as part of instance balancing or scale-down activity.
///
///
///
///
/// Learn more
///
///
///
/// Amazon
/// GameLift FleetIQ Guide
///
///
public partial class RegisterGameServerRequest : AmazonGameLiftRequest
{
private string _connectionInfo;
private string _gameServerData;
private string _gameServerGroupName;
private string _gameServerId;
private string _instanceId;
///
/// Gets and sets the property ConnectionInfo.
///
/// Information that is needed to make inbound client connections to the game server.
/// This might include the IP address and port, DNS name, and other information.
///
///
[AWSProperty(Min=1, Max=512)]
public string ConnectionInfo
{
get { return this._connectionInfo; }
set { this._connectionInfo = value; }
}
// Check to see if ConnectionInfo property is set
internal bool IsSetConnectionInfo()
{
return this._connectionInfo != null;
}
///
/// Gets and sets the property GameServerData.
///
/// A set of custom game server properties, formatted as a single string value. This data
/// is passed to a game client or service when it requests information on game servers.
///
///
///
[AWSProperty(Min=1, Max=1024)]
public string GameServerData
{
get { return this._gameServerData; }
set { this._gameServerData = value; }
}
// Check to see if GameServerData property is set
internal bool IsSetGameServerData()
{
return this._gameServerData != null;
}
///
/// Gets and sets the property GameServerGroupName.
///
/// A unique identifier for the game server group where the game server is running.
///
///
[AWSProperty(Required=true, Min=1, Max=256)]
public string GameServerGroupName
{
get { return this._gameServerGroupName; }
set { this._gameServerGroupName = value; }
}
// Check to see if GameServerGroupName property is set
internal bool IsSetGameServerGroupName()
{
return this._gameServerGroupName != null;
}
///
/// Gets and sets the property GameServerId.
///
/// A custom string that uniquely identifies the game server to register. Game server
/// IDs are developer-defined and must be unique across all game server groups in your
/// Amazon Web Services account.
///
///
[AWSProperty(Required=true, Min=3, Max=128)]
public string GameServerId
{
get { return this._gameServerId; }
set { this._gameServerId = value; }
}
// Check to see if GameServerId property is set
internal bool IsSetGameServerId()
{
return this._gameServerId != null;
}
///
/// Gets and sets the property InstanceId.
///
/// The unique identifier for the instance where the game server is running. This ID is
/// available in the instance metadata. EC2 instance IDs use a 17-character format, for
/// example: i-1234567890abcdef0.
///
///
[AWSProperty(Required=true, Min=19, Max=19)]
public string InstanceId
{
get { return this._instanceId; }
set { this._instanceId = value; }
}
// Check to see if InstanceId property is set
internal bool IsSetInstanceId()
{
return this._instanceId != null;
}
}
}