pulumi-aws-native-kotlin/com.pulumi.awsnative.gamelift.kotlin.outputs/GetFleetResult

GetFleetResult

data class GetFleetResult(val anywhereConfiguration: FleetAnywhereConfiguration? = null, val description: String? = null, val desiredEc2Instances: Int? = null, val ec2InboundPermissions: List<FleetIpPermission>? = null, val fleetArn: String? = null, val fleetId: String? = null, val locations: List<FleetLocationConfiguration>? = null, val maxSize: Int? = null, val metricGroups: List<String>? = null, val minSize: Int? = null, val name: String? = null, val newGameSessionProtectionPolicy: FleetNewGameSessionProtectionPolicy? = null, val resourceCreationLimitPolicy: FleetResourceCreationLimitPolicy? = null, val runtimeConfiguration: FleetRuntimeConfiguration? = null, val scalingPolicies: List<FleetScalingPolicy>? = null, val tags: List<Tag>? = null)

Constructors

GetFleetResult

constructor(anywhereConfiguration: FleetAnywhereConfiguration? = null, description: String? = null, desiredEc2Instances: Int? = null, ec2InboundPermissions: List<FleetIpPermission>? = null, fleetArn: String? = null, fleetId: String? = null, locations: List<FleetLocationConfiguration>? = null, maxSize: Int? = null, metricGroups: List<String>? = null, minSize: Int? = null, name: String? = null, newGameSessionProtectionPolicy: FleetNewGameSessionProtectionPolicy? = null, resourceCreationLimitPolicy: FleetResourceCreationLimitPolicy? = null, runtimeConfiguration: FleetRuntimeConfiguration? = null, scalingPolicies: List<FleetScalingPolicy>? = null, tags: List<Tag>? = null)

Types

Companion

object Companion

Properties

anywhereConfiguration

val anywhereConfiguration: FleetAnywhereConfiguration? = null

Configuration for Anywhere fleet.

description

val description: String? = null

A human-readable description of a fleet.

desiredEc2Instances

val desiredEc2Instances: Int? = null

DEPRECATED The number of EC2 instances that you want this fleet to host. When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.

ec2InboundPermissions

val ec2InboundPermissions: List<FleetIpPermission>? = null

A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.

fleetArn

val fleetArn: String? = null

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Servers Fleet resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift Fleet ARN, the resource ID matches the FleetId value.

fleetId

val fleetId: String? = null

Unique fleet ID

locations

val locations: List<FleetLocationConfiguration>? = null

A set of remote locations to deploy additional instances to and manage as a multi-location fleet. Use this parameter when creating a fleet in AWS Regions that support multiple locations. You can add any AWS Region or Local Zone that's supported by Amazon GameLift Servers. Provide a list of one or more AWS Region codes, such as us-west-2 , or Local Zone names. When using this parameter, Amazon GameLift Servers requires you to include your home location in the request. For a list of supported Regions and Local Zones, see Amazon GameLift Servers service locations for managed hosting.

maxSize

val maxSize: Int? = null

DEPRECATED The maximum value that is allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.

metricGroups

val metricGroups: List<String>? = null

The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string.

minSize

val minSize: Int? = null

DEPRECATED The minimum value allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.

name

val name: String? = null

A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

newGameSessionProtectionPolicy

val newGameSessionProtectionPolicy: FleetNewGameSessionProtectionPolicy? = null

A game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions.

resourceCreationLimitPolicy

val resourceCreationLimitPolicy: FleetResourceCreationLimitPolicy? = null

A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.

runtimeConfiguration

val runtimeConfiguration: FleetRuntimeConfiguration? = null

Instructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime script. The runtime configuration defines the server executables or launch script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails with an invalid request exception. This parameter is required unless the parameters ServerLaunchPath and ServerLaunchParameters are defined. Runtime configuration has replaced these parameters, but fleets that use them will continue to work.

scalingPolicies

val scalingPolicies: List<FleetScalingPolicy>? = null

A list of rules that control how a fleet is scaled.