[ aws . gamelift ]

register-compute

Description

Registers your compute resources in a fleet you previously created. After you register a compute to your fleet, you can monitor and manage your compute using GameLift. The operation returns the compute resource containing SDK endpoint you can use to connect your game server to GameLift.

Learn more

• Create an Anywhere fleet

• Test your integration

See also: AWS API Documentation

Synopsis

  register-compute
--fleet-id <value>
--compute-name <value>
[--certificate-path <value>]
[--dns-name <value>]
[--ip-address <value>]
[--location <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--fleet-id (string)

A unique identifier for the fleet to register the compute to. You can use either the fleet ID or ARN value.

--compute-name (string)

A descriptive label that is associated with the compute resource registered to your fleet.

--certificate-path (string)

The path to the TLS certificate on your compute resource. The path and certificate are not validated by GameLift.

--dns-name (string)

The DNS name of the compute resource. GameLift requires the DNS name or IP address to manage your compute resource.

--ip-address (string)

The IP address of the compute resource. GameLift requires the DNS name or IP address to manage your compute resource.

--location (string)

The name of the custom location you added to the fleet you are registering this compute resource to.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json

• text

• table

• yaml

• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on

• off

• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64

• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

Compute -> (structure)

The details of the compute resource you registered to the specified fleet.

FleetId -> (string)

A unique identifier for the fleet that the compute is registered to.

FleetArn -> (string)

The Amazon Resource Name (ARN) of the fleet that the compute is registered to.

ComputeName -> (string)

A descriptive label that is associated with the compute resource registered to your fleet.

ComputeArn -> (string)

The ARN that is assigned to the compute resource and uniquely identifies it. ARNs are unique across locations.

IpAddress -> (string)

The IP address of the compute resource. GameLift requires the DNS name or IP address to manage your compute resource.

DnsName -> (string)

The DNS name of the compute resource. GameLift requires the DNS name or IP address to manage your compute resource.

ComputeStatus -> (string)

Current status of the compute. A compute must have an ACTIVE status to host game sessions.

Location -> (string)

The name of the custom location you added to the fleet that this compute resource resides in.

CreationTime -> (timestamp)

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057" ).

OperatingSystem -> (string)

The type of operating system on your compute resource.

Type -> (string)

Which compute type that the fleet uses. A fleet can use Anywhere compute resources owned by you or managed Amazon EC2 instances.

GameLiftServiceSdkEndpoint -> (string)

The endpoint connection details of the GameLift SDK endpoint that your game server connects to.