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

Package-level declarations

Types

data class AliasRoutingStrategy(val fleetId: String? = null, val message: String? = null, val type: AliasRoutingStrategyType)

BuildStorageLocation

data class BuildStorageLocation(val bucket: String, val key: String, val objectVersion: String? = null, val roleArn: String)

ContainerGroupDefinitionContainerDefinition

data class ContainerGroupDefinitionContainerDefinition(val command: List<String>? = null, val containerName: String, val cpu: Int? = null, val dependsOn: List<ContainerGroupDefinitionContainerDependency>? = null, val entryPoint: List<String>? = null, val environment: List<ContainerGroupDefinitionContainerEnvironment>? = null, val essential: Boolean? = null, val healthCheck: ContainerGroupDefinitionContainerHealthCheck? = null, val imageUri: String, val memoryLimits: ContainerGroupDefinitionMemoryLimits? = null, val portConfiguration: ContainerGroupDefinitionPortConfiguration? = null, val resolvedImageDigest: String? = null, val workingDirectory: String? = null)

Details about a container that is used in a container fleet

ContainerGroupDefinitionContainerDependency

data class ContainerGroupDefinitionContainerDependency(val condition: ContainerGroupDefinitionContainerDependencyCondition, val containerName: String)

A dependency that impacts a container's startup and shutdown.

ContainerGroupDefinitionContainerEnvironment

data class ContainerGroupDefinitionContainerEnvironment(val name: String, val value: String)

An environment variable to set inside a container, in the form of a key-value pair.

ContainerGroupDefinitionContainerHealthCheck

data class ContainerGroupDefinitionContainerHealthCheck(val command: List<String>, val interval: Int? = null, val retries: Int? = null, val startPeriod: Int? = null, val timeout: Int? = null)

Specifies how the process manager checks the health of containers.

ContainerGroupDefinitionContainerPortRange

data class ContainerGroupDefinitionContainerPortRange(val fromPort: Int, val protocol: ContainerGroupDefinitionContainerPortRangeProtocol, val toPort: Int)

A set of one or more port numbers that can be opened on the container.

ContainerGroupDefinitionMemoryLimits

data class ContainerGroupDefinitionMemoryLimits(val hardLimit: Int? = null, val softLimit: Int? = null)

Specifies how much memory is available to the container.

ContainerGroupDefinitionPortConfiguration

data class ContainerGroupDefinitionPortConfiguration(val containerPortRanges: List<ContainerGroupDefinitionContainerPortRange>)

Defines the ports on a container.

FleetAnywhereConfiguration

data class FleetAnywhereConfiguration(val cost: String)

Configuration for Anywhere fleet.

FleetCertificateConfiguration

data class FleetCertificateConfiguration(val certificateType: FleetCertificateConfigurationCertificateType)

Information about the use of a TLS/SSL certificate for a fleet. TLS certificate generation is enabled at the fleet level, with one certificate generated for the fleet. When this feature is enabled, the certificate can be retrieved using the GameLift Server SDK call GetInstanceCertificate. All instances in a fleet share the same certificate.

FleetConnectionPortRange

data class FleetConnectionPortRange(val fromPort: Int, val toPort: Int)

Defines the range of ports on the instance that allow inbound traffic to connect with containers in a fleet.

FleetContainerGroupsConfiguration

data class FleetContainerGroupsConfiguration(val connectionPortRange: FleetConnectionPortRange, val containerGroupDefinitionNames: List<String>, val containerGroupsPerInstance: FleetContainerGroupsPerInstance? = null)

Specifies container groups that this instance will hold. You must specify exactly one replica group. Optionally, you may specify exactly one daemon group. You can't change this property after you create the fleet.

FleetContainerGroupsPerInstance

data class FleetContainerGroupsPerInstance(val desiredReplicaContainerGroupsPerInstance: Int? = null, val maxReplicaContainerGroupsPerInstance: Int? = null)

The number of container groups per instance.

FleetIpPermission

data class FleetIpPermission(val fromPort: Int, val ipRange: String, val protocol: FleetIpPermissionProtocol, val toPort: Int)

A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift hosting resource. New game sessions that are started on the fleet are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges. For fleets created with a custom game server, the ranges reflect the server's game session assignments. For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP messaging and one for UDP, for use by the Realtime servers.

FleetLocationCapacity

data class FleetLocationCapacity(val desiredEc2Instances: Int, val maxSize: Int, val minSize: Int)

Current resource capacity settings in a specified fleet or location. The location value might refer to a fleet's remote location or its home Region.

FleetLocationConfiguration

data class FleetLocationConfiguration(val location: String, val locationCapacity: FleetLocationCapacity? = null)

A remote location where a multi-location fleet can deploy EC2 instances for game hosting.

FleetResourceCreationLimitPolicy

data class FleetResourceCreationLimitPolicy(val newGameSessionsPerCreator: Int? = null, val policyPeriodInMinutes: Int? = null)

A policy that limits the number of game sessions a player can create on the same fleet. This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: "An individual player can create a maximum number of new game sessions within a specified time period". The policy is evaluated when a player tries to create a new game session. For example, assume you have a policy of 10 new game sessions and a time period of 60 minutes. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than 10 game sessions in the past 60 minutes.

FleetRuntimeConfiguration

data class FleetRuntimeConfiguration(val gameSessionActivationTimeoutSeconds: Int? = null, val maxConcurrentGameSessionActivations: Int? = null, val serverProcesses: List<FleetServerProcess>? = null)

A collection of server process configurations that describe the processes to run on each instance in a fleet. All fleets must have a runtime configuration. Each instance in the fleet maintains server processes as specified in the runtime configuration, launching new ones as existing processes end. Each instance regularly checks for an updated runtime configuration makes adjustments as called for. The runtime configuration enables the instances in a fleet to run multiple processes simultaneously. Potential scenarios are as follows: (1) Run multiple processes of a single game server executable to maximize usage of your hosting resources. (2) Run one or more processes of different executables, such as your game server and a metrics tracking program. (3) Run multiple processes of a single game server but with different launch parameters, for example to run one process on each instance in debug mode. An Amazon GameLift instance is limited to 50 processes running simultaneously. A runtime configuration must specify fewer than this limit. To calculate the total number of processes specified in a runtime configuration, add the values of the ConcurrentExecutions parameter for each ServerProcess object in the runtime configuration.

FleetScalingPolicy

data class FleetScalingPolicy(val comparisonOperator: FleetScalingPolicyComparisonOperator? = null, val evaluationPeriods: Int? = null, val location: String? = null, val metricName: FleetScalingPolicyMetricName, val name: String, val policyType: FleetScalingPolicyPolicyType? = null, val scalingAdjustment: Int? = null, val scalingAdjustmentType: FleetScalingPolicyScalingAdjustmentType? = null, val status: FleetScalingPolicyStatus? = null, val targetConfiguration: FleetTargetConfiguration? = null, val threshold: Double? = null, val updateStatus: FleetScalingPolicyUpdateStatus? = null)

Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.

FleetServerProcess

data class FleetServerProcess(val concurrentExecutions: Int, val launchPath: String, val parameters: String? = null)

A set of instructions for launching server processes on each instance in a fleet. Each instruction set identifies the location of the server executable, optional launch parameters, and the number of server processes with this configuration to maintain concurrently on the instance. Server process configurations make up a fleet's RuntimeConfiguration.

FleetTargetConfiguration

data class FleetTargetConfiguration(val targetValue: Double)

Settings for a target-based scaling policy. A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon GameLift to adjust capacity so that the metric returns to the target value. The target configuration specifies settings as needed for the target based policy, including the target value.

GameServerGroupAutoScalingPolicy

data class GameServerGroupAutoScalingPolicy(val estimatedInstanceWarmup: Double? = null, val targetTrackingConfiguration: GameServerGroupTargetTrackingConfiguration)

Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.

GameServerGroupInstanceDefinition

data class GameServerGroupInstanceDefinition(val instanceType: String, val weightedCapacity: String? = null)

An allowed instance type for your game server group.

GameServerGroupLaunchTemplate

data class GameServerGroupLaunchTemplate(val launchTemplateId: String? = null, val launchTemplateName: String? = null, val version: String? = null)

The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.

GameServerGroupTargetTrackingConfiguration

data class GameServerGroupTargetTrackingConfiguration(val targetValue: Double)

Settings for a target-based scaling policy applied to Auto Scaling group.

GameSessionQueueDestination

data class GameSessionQueueDestination(val destinationArn: String? = null)

A fleet or alias designated in a game session queue.

GameSessionQueueFilterConfiguration

data class GameSessionQueueFilterConfiguration(val allowedLocations: List<String>? = null)

GameSessionQueuePlayerLatencyPolicy

data class GameSessionQueuePlayerLatencyPolicy(val maximumIndividualPlayerLatencyMilliseconds: Int? = null, val policyDurationSeconds: Int? = null)

Sets a latency cap for individual players when placing a game session.

GameSessionQueuePriorityConfiguration

data class GameSessionQueuePriorityConfiguration(val locationOrder: List<String>? = null, val priorityOrder: List<GameSessionQueuePriorityOrderItem>? = null)

GetAliasResult

data class GetAliasResult(val aliasId: String? = null, val description: String? = null, val name: String? = null, val routingStrategy: AliasRoutingStrategy? = null)

GetBuildResult

data class GetBuildResult(val buildId: String? = null, val name: String? = null, val version: String? = null)

GetContainerGroupDefinitionResult

data class GetContainerGroupDefinitionResult(val containerGroupDefinitionArn: String? = null, val creationTime: String? = null, val tags: List<Tag>? = null)

GetFleetResult

data class GetFleetResult(val anywhereConfiguration: FleetAnywhereConfiguration? = null, val description: String? = null, val desiredEc2Instances: Int? = null, val ec2InboundPermissions: List<FleetIpPermission>? = 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)

GetGameServerGroupResult

data class GetGameServerGroupResult(val autoScalingGroupArn: String? = null, val balancingStrategy: GameServerGroupBalancingStrategy? = null, val gameServerGroupArn: String? = null, val gameServerGroupName: String? = null, val gameServerProtectionPolicy: GameServerGroupGameServerProtectionPolicy? = null, val instanceDefinitions: List<GameServerGroupInstanceDefinition>? = null, val roleArn: String? = null)

GetGameSessionQueueResult

data class GetGameSessionQueueResult(val arn: String? = null, val customEventData: String? = null, val destinations: List<GameSessionQueueDestination>? = null, val filterConfiguration: GameSessionQueueFilterConfiguration? = null, val notificationTarget: String? = null, val playerLatencyPolicies: List<GameSessionQueuePlayerLatencyPolicy>? = null, val priorityConfiguration: GameSessionQueuePriorityConfiguration? = null, val tags: List<Tag>? = null, val timeoutInSeconds: Int? = null)

GetLocationResult

data class GetLocationResult(val locationArn: String? = null, val tags: List<Tag>? = null)

GetMatchmakingConfigurationResult

data class GetMatchmakingConfigurationResult(val acceptanceRequired: Boolean? = null, val acceptanceTimeoutSeconds: Int? = null, val additionalPlayerCount: Int? = null, val arn: String? = null, val backfillMode: MatchmakingConfigurationBackfillMode? = null, val creationTime: String? = null, val customEventData: String? = null, val description: String? = null, val flexMatchMode: MatchmakingConfigurationFlexMatchMode? = null, val gameProperties: List<MatchmakingConfigurationGameProperty>? = null, val gameSessionData: String? = null, val gameSessionQueueArns: List<String>? = null, val notificationTarget: String? = null, val requestTimeoutSeconds: Int? = null, val ruleSetArn: String? = null, val ruleSetName: String? = null, val tags: List<Tag>? = null)

GetMatchmakingRuleSetResult

data class GetMatchmakingRuleSetResult(val arn: String? = null, val creationTime: String? = null, val tags: List<Tag>? = null)

GetScriptResult

data class GetScriptResult(val arn: String? = null, val creationTime: String? = null, val id: String? = null, val name: String? = null, val sizeOnDisk: Int? = null, val storageLocation: ScriptS3Location? = null, val tags: List<Tag>? = null, val version: String? = null)

MatchmakingConfigurationGameProperty

data class MatchmakingConfigurationGameProperty(val key: String, val value: String)

A key-value pair that contains information about a game session.

ScriptS3Location

data class ScriptS3Location(val bucket: String, val key: String, val objectVersion: String? = null, val roleArn: String)