We recommend new projects start with resources from the AWS provider.
aws-native.gamelift.Fleet
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
The AWS::GameLift::Fleet resource creates an Amazon GameLift (GameLift) fleet to host game servers. A fleet is a set of EC2 or Anywhere instances, each of which can host multiple game sessions.
Create Fleet Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Fleet(name: string, args?: FleetArgs, opts?: CustomResourceOptions);
@overload
def Fleet(resource_name: str,
args: Optional[FleetArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Fleet(resource_name: str,
opts: Optional[ResourceOptions] = None,
anywhere_configuration: Optional[FleetAnywhereConfigurationArgs] = None,
apply_capacity: Optional[FleetApplyCapacity] = None,
build_id: Optional[str] = None,
certificate_configuration: Optional[FleetCertificateConfigurationArgs] = None,
compute_type: Optional[FleetComputeType] = None,
container_groups_configuration: Optional[FleetContainerGroupsConfigurationArgs] = None,
description: Optional[str] = None,
desired_ec2_instances: Optional[int] = None,
ec2_inbound_permissions: Optional[Sequence[FleetIpPermissionArgs]] = None,
ec2_instance_type: Optional[str] = None,
fleet_type: Optional[FleetType] = None,
instance_role_arn: Optional[str] = None,
instance_role_credentials_provider: Optional[FleetInstanceRoleCredentialsProvider] = None,
locations: Optional[Sequence[FleetLocationConfigurationArgs]] = None,
log_paths: Optional[Sequence[str]] = None,
max_size: Optional[int] = None,
metric_groups: Optional[Sequence[str]] = None,
min_size: Optional[int] = None,
name: Optional[str] = None,
new_game_session_protection_policy: Optional[FleetNewGameSessionProtectionPolicy] = None,
peer_vpc_aws_account_id: Optional[str] = None,
peer_vpc_id: Optional[str] = None,
resource_creation_limit_policy: Optional[FleetResourceCreationLimitPolicyArgs] = None,
runtime_configuration: Optional[FleetRuntimeConfigurationArgs] = None,
scaling_policies: Optional[Sequence[FleetScalingPolicyArgs]] = None,
script_id: Optional[str] = None,
server_launch_parameters: Optional[str] = None,
server_launch_path: Optional[str] = None)
func NewFleet(ctx *Context, name string, args *FleetArgs, opts ...ResourceOption) (*Fleet, error)
public Fleet(string name, FleetArgs? args = null, CustomResourceOptions? opts = null)
type: aws-native:gamelift:Fleet
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args FleetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args FleetArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args FleetArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FleetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FleetArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Fleet Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Fleet resource accepts the following input properties:
- Anywhere
Configuration Pulumi.Aws Native. Game Lift. Inputs. Fleet Anywhere Configuration - Configuration for Anywhere fleet.
- Apply
Capacity Pulumi.Aws Native. Game Lift. Fleet Apply Capacity - Determines whether to apply fleet or location capacities on fleet creation.
- Build
Id string - A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.
- Certificate
Configuration Pulumi.Aws Native. Game Lift. Inputs. Fleet Certificate Configuration - Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not set, certificate generation is disabled. This fleet setting cannot be changed once the fleet is created.
- Compute
Type Pulumi.Aws Native. Game Lift. Fleet Compute Type - ComputeType to differentiate EC2 hardware managed by GameLift and Anywhere hardware managed by the customer.
- Container
Groups Pulumi.Configuration Aws Native. Game Lift. Inputs. Fleet Container Groups Configuration This data type is used with the Amazon GameLift containers feature, which is currently in public preview.
Configuration details for a set of container groups, for use when creating a fleet with compute type
CONTAINER
.Used with:
CreateFleet
- Description string
- A human-readable description of a fleet.
- Desired
Ec2Instances int - [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.
- Ec2Inbound
Permissions List<Pulumi.Aws Native. Game Lift. Inputs. Fleet Ip Permission> - A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
- Ec2Instance
Type string - The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
- Fleet
Type Pulumi.Aws Native. Game Lift. Fleet Type - Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet.
- Instance
Role stringArn - A unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console.
- Instance
Role Pulumi.Credentials Provider Aws Native. Game Lift. Fleet Instance Role Credentials Provider - Credentials provider implementation that loads credentials from the Amazon EC2 Instance Metadata Service.
- Locations
List<Pulumi.
Aws Native. Game Lift. Inputs. Fleet Location Configuration> - 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. 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 requires you to include your home location in the request. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting. - Log
Paths List<string> - This parameter is no longer used. When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady()
- Max
Size int - [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.
- Metric
Groups List<string> - 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.
- Min
Size int - [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 string
- A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
- New
Game Pulumi.Session Protection Policy Aws Native. Game Lift. Fleet New Game Session Protection Policy - 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.
- Peer
Vpc stringAws Account Id - A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your account ID in the AWS Management Console under account settings.
- Peer
Vpc stringId - A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console.
- Resource
Creation Pulumi.Limit Policy Aws Native. Game Lift. Inputs. Fleet Resource Creation Limit Policy - A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
- Runtime
Configuration Pulumi.Aws Native. Game Lift. Inputs. Fleet Runtime Configuration 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.
- Scaling
Policies List<Pulumi.Aws Native. Game Lift. Inputs. Fleet Scaling Policy> - A list of rules that control how a fleet is scaled.
- Script
Id string A unique identifier for a Realtime script to be deployed on a new Realtime Servers fleet. The script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created.
Note: It is not currently possible to use the !Ref command to reference a script created with a CloudFormation template for the fleet property ScriptId. Instead, use Fn::GetAtt Script.Arn or Fn::GetAtt Script.Id to retrieve either of these properties as input for ScriptId. Alternatively, enter a ScriptId string manually.
- Server
Launch stringParameters - This parameter is no longer used but is retained for backward compatibility. Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath.
- Server
Launch stringPath - This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.
- Anywhere
Configuration FleetAnywhere Configuration Args - Configuration for Anywhere fleet.
- Apply
Capacity FleetApply Capacity - Determines whether to apply fleet or location capacities on fleet creation.
- Build
Id string - A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.
- Certificate
Configuration FleetCertificate Configuration Args - Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not set, certificate generation is disabled. This fleet setting cannot be changed once the fleet is created.
- Compute
Type FleetCompute Type - ComputeType to differentiate EC2 hardware managed by GameLift and Anywhere hardware managed by the customer.
- Container
Groups FleetConfiguration Container Groups Configuration Args This data type is used with the Amazon GameLift containers feature, which is currently in public preview.
Configuration details for a set of container groups, for use when creating a fleet with compute type
CONTAINER
.Used with:
CreateFleet
- Description string
- A human-readable description of a fleet.
- Desired
Ec2Instances int - [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.
- Ec2Inbound
Permissions []FleetIp Permission Args - A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
- Ec2Instance
Type string - The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
- Fleet
Type FleetType - Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet.
- Instance
Role stringArn - A unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console.
- Instance
Role FleetCredentials Provider Instance Role Credentials Provider - Credentials provider implementation that loads credentials from the Amazon EC2 Instance Metadata Service.
- Locations
[]Fleet
Location Configuration Args - 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. 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 requires you to include your home location in the request. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting. - Log
Paths []string - This parameter is no longer used. When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady()
- Max
Size int - [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.
- Metric
Groups []string - 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.
- Min
Size int - [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 string
- A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
- New
Game FleetSession Protection Policy New Game Session Protection Policy - 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.
- Peer
Vpc stringAws Account Id - A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your account ID in the AWS Management Console under account settings.
- Peer
Vpc stringId - A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console.
- Resource
Creation FleetLimit Policy Resource Creation Limit Policy Args - A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
- Runtime
Configuration FleetRuntime Configuration Args 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.
- Scaling
Policies []FleetScaling Policy Args - A list of rules that control how a fleet is scaled.
- Script
Id string A unique identifier for a Realtime script to be deployed on a new Realtime Servers fleet. The script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created.
Note: It is not currently possible to use the !Ref command to reference a script created with a CloudFormation template for the fleet property ScriptId. Instead, use Fn::GetAtt Script.Arn or Fn::GetAtt Script.Id to retrieve either of these properties as input for ScriptId. Alternatively, enter a ScriptId string manually.
- Server
Launch stringParameters - This parameter is no longer used but is retained for backward compatibility. Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath.
- Server
Launch stringPath - This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.
- anywhere
Configuration FleetAnywhere Configuration - Configuration for Anywhere fleet.
- apply
Capacity FleetApply Capacity - Determines whether to apply fleet or location capacities on fleet creation.
- build
Id String - A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.
- certificate
Configuration FleetCertificate Configuration - Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not set, certificate generation is disabled. This fleet setting cannot be changed once the fleet is created.
- compute
Type FleetCompute Type - ComputeType to differentiate EC2 hardware managed by GameLift and Anywhere hardware managed by the customer.
- container
Groups FleetConfiguration Container Groups Configuration This data type is used with the Amazon GameLift containers feature, which is currently in public preview.
Configuration details for a set of container groups, for use when creating a fleet with compute type
CONTAINER
.Used with:
CreateFleet
- description String
- A human-readable description of a fleet.
- desired
Ec2Instances Integer - [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.
- ec2Inbound
Permissions List<FleetIp Permission> - A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
- ec2Instance
Type String - The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
- fleet
Type FleetType - Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet.
- instance
Role StringArn - A unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console.
- instance
Role FleetCredentials Provider Instance Role Credentials Provider - Credentials provider implementation that loads credentials from the Amazon EC2 Instance Metadata Service.
- locations
List<Fleet
Location Configuration> - 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. 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 requires you to include your home location in the request. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting. - log
Paths List<String> - This parameter is no longer used. When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady()
- max
Size Integer - [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.
- metric
Groups List<String> - 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.
- min
Size Integer - [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 String
- A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
- new
Game FleetSession Protection Policy New Game Session Protection Policy - 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.
- peer
Vpc StringAws Account Id - A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your account ID in the AWS Management Console under account settings.
- peer
Vpc StringId - A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console.
- resource
Creation FleetLimit Policy Resource Creation Limit Policy - A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
- runtime
Configuration FleetRuntime Configuration 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.
- scaling
Policies List<FleetScaling Policy> - A list of rules that control how a fleet is scaled.
- script
Id String A unique identifier for a Realtime script to be deployed on a new Realtime Servers fleet. The script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created.
Note: It is not currently possible to use the !Ref command to reference a script created with a CloudFormation template for the fleet property ScriptId. Instead, use Fn::GetAtt Script.Arn or Fn::GetAtt Script.Id to retrieve either of these properties as input for ScriptId. Alternatively, enter a ScriptId string manually.
- server
Launch StringParameters - This parameter is no longer used but is retained for backward compatibility. Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath.
- server
Launch StringPath - This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.
- anywhere
Configuration FleetAnywhere Configuration - Configuration for Anywhere fleet.
- apply
Capacity FleetApply Capacity - Determines whether to apply fleet or location capacities on fleet creation.
- build
Id string - A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.
- certificate
Configuration FleetCertificate Configuration - Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not set, certificate generation is disabled. This fleet setting cannot be changed once the fleet is created.
- compute
Type FleetCompute Type - ComputeType to differentiate EC2 hardware managed by GameLift and Anywhere hardware managed by the customer.
- container
Groups FleetConfiguration Container Groups Configuration This data type is used with the Amazon GameLift containers feature, which is currently in public preview.
Configuration details for a set of container groups, for use when creating a fleet with compute type
CONTAINER
.Used with:
CreateFleet
- description string
- A human-readable description of a fleet.
- desired
Ec2Instances number - [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.
- ec2Inbound
Permissions FleetIp Permission[] - A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
- ec2Instance
Type string - The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
- fleet
Type FleetType - Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet.
- instance
Role stringArn - A unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console.
- instance
Role FleetCredentials Provider Instance Role Credentials Provider - Credentials provider implementation that loads credentials from the Amazon EC2 Instance Metadata Service.
- locations
Fleet
Location Configuration[] - 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. 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 requires you to include your home location in the request. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting. - log
Paths string[] - This parameter is no longer used. When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady()
- max
Size number - [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.
- metric
Groups string[] - 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.
- min
Size number - [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 string
- A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
- new
Game FleetSession Protection Policy New Game Session Protection Policy - 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.
- peer
Vpc stringAws Account Id - A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your account ID in the AWS Management Console under account settings.
- peer
Vpc stringId - A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console.
- resource
Creation FleetLimit Policy Resource Creation Limit Policy - A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
- runtime
Configuration FleetRuntime Configuration 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.
- scaling
Policies FleetScaling Policy[] - A list of rules that control how a fleet is scaled.
- script
Id string A unique identifier for a Realtime script to be deployed on a new Realtime Servers fleet. The script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created.
Note: It is not currently possible to use the !Ref command to reference a script created with a CloudFormation template for the fleet property ScriptId. Instead, use Fn::GetAtt Script.Arn or Fn::GetAtt Script.Id to retrieve either of these properties as input for ScriptId. Alternatively, enter a ScriptId string manually.
- server
Launch stringParameters - This parameter is no longer used but is retained for backward compatibility. Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath.
- server
Launch stringPath - This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.
- anywhere_
configuration FleetAnywhere Configuration Args - Configuration for Anywhere fleet.
- apply_
capacity FleetApply Capacity - Determines whether to apply fleet or location capacities on fleet creation.
- build_
id str - A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.
- certificate_
configuration FleetCertificate Configuration Args - Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not set, certificate generation is disabled. This fleet setting cannot be changed once the fleet is created.
- compute_
type FleetCompute Type - ComputeType to differentiate EC2 hardware managed by GameLift and Anywhere hardware managed by the customer.
- container_
groups_ Fleetconfiguration Container Groups Configuration Args This data type is used with the Amazon GameLift containers feature, which is currently in public preview.
Configuration details for a set of container groups, for use when creating a fleet with compute type
CONTAINER
.Used with:
CreateFleet
- description str
- A human-readable description of a fleet.
- desired_
ec2_ intinstances - [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.
- ec2_
inbound_ Sequence[Fleetpermissions Ip Permission Args] - A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
- ec2_
instance_ strtype - The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
- fleet_
type FleetType - Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet.
- instance_
role_ strarn - A unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console.
- instance_
role_ Fleetcredentials_ provider Instance Role Credentials Provider - Credentials provider implementation that loads credentials from the Amazon EC2 Instance Metadata Service.
- locations
Sequence[Fleet
Location Configuration Args] - 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. 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 requires you to include your home location in the request. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting. - log_
paths Sequence[str] - This parameter is no longer used. When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady()
- max_
size int - [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.
- metric_
groups Sequence[str] - 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.
- min_
size int - [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 str
- A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
- new_
game_ Fleetsession_ protection_ policy New Game Session Protection Policy - 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.
- peer_
vpc_ straws_ account_ id - A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your account ID in the AWS Management Console under account settings.
- peer_
vpc_ strid - A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console.
- resource_
creation_ Fleetlimit_ policy Resource Creation Limit Policy Args - A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
- runtime_
configuration FleetRuntime Configuration Args 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.
- scaling_
policies Sequence[FleetScaling Policy Args] - A list of rules that control how a fleet is scaled.
- script_
id str A unique identifier for a Realtime script to be deployed on a new Realtime Servers fleet. The script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created.
Note: It is not currently possible to use the !Ref command to reference a script created with a CloudFormation template for the fleet property ScriptId. Instead, use Fn::GetAtt Script.Arn or Fn::GetAtt Script.Id to retrieve either of these properties as input for ScriptId. Alternatively, enter a ScriptId string manually.
- server_
launch_ strparameters - This parameter is no longer used but is retained for backward compatibility. Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath.
- server_
launch_ strpath - This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.
- anywhere
Configuration Property Map - Configuration for Anywhere fleet.
- apply
Capacity "ON_UPDATE" | "ON_CREATE_AND_UPDATE" - Determines whether to apply fleet or location capacities on fleet creation.
- build
Id String - A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.
- certificate
Configuration Property Map - Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not set, certificate generation is disabled. This fleet setting cannot be changed once the fleet is created.
- compute
Type "EC2" | "ANYWHERE" | "CONTAINER" - ComputeType to differentiate EC2 hardware managed by GameLift and Anywhere hardware managed by the customer.
- container
Groups Property MapConfiguration This data type is used with the Amazon GameLift containers feature, which is currently in public preview.
Configuration details for a set of container groups, for use when creating a fleet with compute type
CONTAINER
.Used with:
CreateFleet
- description String
- A human-readable description of a fleet.
- desired
Ec2Instances Number - [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.
- ec2Inbound
Permissions List<Property Map> - A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
- ec2Instance
Type String - The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
- fleet
Type "ON_DEMAND" | "SPOT" - Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet.
- instance
Role StringArn - A unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console.
- instance
Role "SHARED_CREDENTIAL_FILE"Credentials Provider - Credentials provider implementation that loads credentials from the Amazon EC2 Instance Metadata Service.
- locations List<Property Map>
- 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. 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 requires you to include your home location in the request. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting. - log
Paths List<String> - This parameter is no longer used. When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady()
- max
Size Number - [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.
- metric
Groups List<String> - 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.
- min
Size Number - [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 String
- A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
- new
Game "FullSession Protection Policy Protection" | "No Protection" - 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.
- peer
Vpc StringAws Account Id - A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your account ID in the AWS Management Console under account settings.
- peer
Vpc StringId - A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console.
- resource
Creation Property MapLimit Policy - A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
- runtime
Configuration Property Map 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.
- scaling
Policies List<Property Map> - A list of rules that control how a fleet is scaled.
- script
Id String A unique identifier for a Realtime script to be deployed on a new Realtime Servers fleet. The script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created.
Note: It is not currently possible to use the !Ref command to reference a script created with a CloudFormation template for the fleet property ScriptId. Instead, use Fn::GetAtt Script.Arn or Fn::GetAtt Script.Id to retrieve either of these properties as input for ScriptId. Alternatively, enter a ScriptId string manually.
- server
Launch StringParameters - This parameter is no longer used but is retained for backward compatibility. Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath.
- server
Launch StringPath - This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.
Outputs
All input properties are implicitly available as output properties. Additionally, the Fleet resource produces the following output properties:
Supporting Types
FleetAnywhereConfiguration, FleetAnywhereConfigurationArgs
- Cost string
- Cost of compute can be specified on Anywhere Fleets to prioritize placement across Queue destinations based on Cost.
- Cost string
- Cost of compute can be specified on Anywhere Fleets to prioritize placement across Queue destinations based on Cost.
- cost String
- Cost of compute can be specified on Anywhere Fleets to prioritize placement across Queue destinations based on Cost.
- cost string
- Cost of compute can be specified on Anywhere Fleets to prioritize placement across Queue destinations based on Cost.
- cost str
- Cost of compute can be specified on Anywhere Fleets to prioritize placement across Queue destinations based on Cost.
- cost String
- Cost of compute can be specified on Anywhere Fleets to prioritize placement across Queue destinations based on Cost.
FleetApplyCapacity, FleetApplyCapacityArgs
- On
Update - ON_UPDATE
- On
Create And Update - ON_CREATE_AND_UPDATE
- Fleet
Apply Capacity On Update - ON_UPDATE
- Fleet
Apply Capacity On Create And Update - ON_CREATE_AND_UPDATE
- On
Update - ON_UPDATE
- On
Create And Update - ON_CREATE_AND_UPDATE
- On
Update - ON_UPDATE
- On
Create And Update - ON_CREATE_AND_UPDATE
- ON_UPDATE
- ON_UPDATE
- ON_CREATE_AND_UPDATE
- ON_CREATE_AND_UPDATE
- "ON_UPDATE"
- ON_UPDATE
- "ON_CREATE_AND_UPDATE"
- ON_CREATE_AND_UPDATE
FleetCertificateConfiguration, FleetCertificateConfigurationArgs
- Certificate
Type Pulumi.Aws Native. Game Lift. Fleet Certificate Configuration Certificate Type Indicates whether a TLS/SSL certificate is generated for a fleet.
Valid values include:
- GENERATED - Generate a TLS/SSL certificate for this fleet.
- DISABLED - (default) Do not generate a TLS/SSL certificate for this fleet.
- Certificate
Type FleetCertificate Configuration Certificate Type Indicates whether a TLS/SSL certificate is generated for a fleet.
Valid values include:
- GENERATED - Generate a TLS/SSL certificate for this fleet.
- DISABLED - (default) Do not generate a TLS/SSL certificate for this fleet.
- certificate
Type FleetCertificate Configuration Certificate Type Indicates whether a TLS/SSL certificate is generated for a fleet.
Valid values include:
- GENERATED - Generate a TLS/SSL certificate for this fleet.
- DISABLED - (default) Do not generate a TLS/SSL certificate for this fleet.
- certificate
Type FleetCertificate Configuration Certificate Type Indicates whether a TLS/SSL certificate is generated for a fleet.
Valid values include:
- GENERATED - Generate a TLS/SSL certificate for this fleet.
- DISABLED - (default) Do not generate a TLS/SSL certificate for this fleet.
- certificate_
type FleetCertificate Configuration Certificate Type Indicates whether a TLS/SSL certificate is generated for a fleet.
Valid values include:
- GENERATED - Generate a TLS/SSL certificate for this fleet.
- DISABLED - (default) Do not generate a TLS/SSL certificate for this fleet.
- certificate
Type "DISABLED" | "GENERATED" Indicates whether a TLS/SSL certificate is generated for a fleet.
Valid values include:
- GENERATED - Generate a TLS/SSL certificate for this fleet.
- DISABLED - (default) Do not generate a TLS/SSL certificate for this fleet.
FleetCertificateConfigurationCertificateType, FleetCertificateConfigurationCertificateTypeArgs
- Disabled
- DISABLED
- Generated
- GENERATED
- Fleet
Certificate Configuration Certificate Type Disabled - DISABLED
- Fleet
Certificate Configuration Certificate Type Generated - GENERATED
- Disabled
- DISABLED
- Generated
- GENERATED
- Disabled
- DISABLED
- Generated
- GENERATED
- DISABLED
- DISABLED
- GENERATED
- GENERATED
- "DISABLED"
- DISABLED
- "GENERATED"
- GENERATED
FleetComputeType, FleetComputeTypeArgs
- Ec2
- EC2
- Anywhere
- ANYWHERE
- Container
- CONTAINER
- Fleet
Compute Type Ec2 - EC2
- Fleet
Compute Type Anywhere - ANYWHERE
- Fleet
Compute Type Container - CONTAINER
- Ec2
- EC2
- Anywhere
- ANYWHERE
- Container
- CONTAINER
- Ec2
- EC2
- Anywhere
- ANYWHERE
- Container
- CONTAINER
- EC2
- EC2
- ANYWHERE
- ANYWHERE
- CONTAINER
- CONTAINER
- "EC2"
- EC2
- "ANYWHERE"
- ANYWHERE
- "CONTAINER"
- CONTAINER
FleetConnectionPortRange, FleetConnectionPortRangeArgs
FleetContainerGroupsConfiguration, FleetContainerGroupsConfigurationArgs
- Connection
Port Pulumi.Range Aws Native. Game Lift. Inputs. Fleet Connection Port Range A set of ports to allow inbound traffic, including game clients, to connect to processes running in the container fleet.
Connection ports are dynamically mapped to container ports, which are assigned to individual processes running in a container. The connection port range must have enough ports to map to all container ports across a fleet instance. To calculate the minimum connection ports needed, use the following formula:
[Total number of container ports as defined for containers in the replica container group] * [Desired or calculated number of replica container groups per instance] + [Total number of container ports as defined for containers in the daemon container group]
As a best practice, double the minimum number of connection ports.
Use the fleet's
EC2InboundPermissions
property to control external access to connection ports. Set this property to the connection port numbers that you want to open access to. SeeIpPermission
for more details.- Container
Group List<string>Definition Names - The names of the container group definitions that will be created in an instance. You must specify exactly one REPLICA container group. You have the option to also specify one DAEMON container group.
- Container
Groups Pulumi.Per Instance Aws Native. Game Lift. Inputs. Fleet Container Groups Per Instance
- Connection
Port FleetRange Connection Port Range A set of ports to allow inbound traffic, including game clients, to connect to processes running in the container fleet.
Connection ports are dynamically mapped to container ports, which are assigned to individual processes running in a container. The connection port range must have enough ports to map to all container ports across a fleet instance. To calculate the minimum connection ports needed, use the following formula:
[Total number of container ports as defined for containers in the replica container group] * [Desired or calculated number of replica container groups per instance] + [Total number of container ports as defined for containers in the daemon container group]
As a best practice, double the minimum number of connection ports.
Use the fleet's
EC2InboundPermissions
property to control external access to connection ports. Set this property to the connection port numbers that you want to open access to. SeeIpPermission
for more details.- Container
Group []stringDefinition Names - The names of the container group definitions that will be created in an instance. You must specify exactly one REPLICA container group. You have the option to also specify one DAEMON container group.
- Container
Groups FleetPer Instance Container Groups Per Instance
- connection
Port FleetRange Connection Port Range A set of ports to allow inbound traffic, including game clients, to connect to processes running in the container fleet.
Connection ports are dynamically mapped to container ports, which are assigned to individual processes running in a container. The connection port range must have enough ports to map to all container ports across a fleet instance. To calculate the minimum connection ports needed, use the following formula:
[Total number of container ports as defined for containers in the replica container group] * [Desired or calculated number of replica container groups per instance] + [Total number of container ports as defined for containers in the daemon container group]
As a best practice, double the minimum number of connection ports.
Use the fleet's
EC2InboundPermissions
property to control external access to connection ports. Set this property to the connection port numbers that you want to open access to. SeeIpPermission
for more details.- container
Group List<String>Definition Names - The names of the container group definitions that will be created in an instance. You must specify exactly one REPLICA container group. You have the option to also specify one DAEMON container group.
- container
Groups FleetPer Instance Container Groups Per Instance
- connection
Port FleetRange Connection Port Range A set of ports to allow inbound traffic, including game clients, to connect to processes running in the container fleet.
Connection ports are dynamically mapped to container ports, which are assigned to individual processes running in a container. The connection port range must have enough ports to map to all container ports across a fleet instance. To calculate the minimum connection ports needed, use the following formula:
[Total number of container ports as defined for containers in the replica container group] * [Desired or calculated number of replica container groups per instance] + [Total number of container ports as defined for containers in the daemon container group]
As a best practice, double the minimum number of connection ports.
Use the fleet's
EC2InboundPermissions
property to control external access to connection ports. Set this property to the connection port numbers that you want to open access to. SeeIpPermission
for more details.- container
Group string[]Definition Names - The names of the container group definitions that will be created in an instance. You must specify exactly one REPLICA container group. You have the option to also specify one DAEMON container group.
- container
Groups FleetPer Instance Container Groups Per Instance
- connection_
port_ Fleetrange Connection Port Range A set of ports to allow inbound traffic, including game clients, to connect to processes running in the container fleet.
Connection ports are dynamically mapped to container ports, which are assigned to individual processes running in a container. The connection port range must have enough ports to map to all container ports across a fleet instance. To calculate the minimum connection ports needed, use the following formula:
[Total number of container ports as defined for containers in the replica container group] * [Desired or calculated number of replica container groups per instance] + [Total number of container ports as defined for containers in the daemon container group]
As a best practice, double the minimum number of connection ports.
Use the fleet's
EC2InboundPermissions
property to control external access to connection ports. Set this property to the connection port numbers that you want to open access to. SeeIpPermission
for more details.- container_
group_ Sequence[str]definition_ names - The names of the container group definitions that will be created in an instance. You must specify exactly one REPLICA container group. You have the option to also specify one DAEMON container group.
- container_
groups_ Fleetper_ instance Container Groups Per Instance
- connection
Port Property MapRange A set of ports to allow inbound traffic, including game clients, to connect to processes running in the container fleet.
Connection ports are dynamically mapped to container ports, which are assigned to individual processes running in a container. The connection port range must have enough ports to map to all container ports across a fleet instance. To calculate the minimum connection ports needed, use the following formula:
[Total number of container ports as defined for containers in the replica container group] * [Desired or calculated number of replica container groups per instance] + [Total number of container ports as defined for containers in the daemon container group]
As a best practice, double the minimum number of connection ports.
Use the fleet's
EC2InboundPermissions
property to control external access to connection ports. Set this property to the connection port numbers that you want to open access to. SeeIpPermission
for more details.- container
Group List<String>Definition Names - The names of the container group definitions that will be created in an instance. You must specify exactly one REPLICA container group. You have the option to also specify one DAEMON container group.
- container
Groups Property MapPer Instance
FleetContainerGroupsPerInstance, FleetContainerGroupsPerInstanceArgs
- Desired
Replica intContainer Groups Per Instance - Use this parameter to override the number of replica container groups GameLift will launch per instance with a number that is lower than that calculated maximum.
- Max
Replica intContainer Groups Per Instance - GameLift calculates the maximum number of replica container groups it can launch per instance based on instance properties such as CPU, memory, and connection ports.
- Desired
Replica intContainer Groups Per Instance - Use this parameter to override the number of replica container groups GameLift will launch per instance with a number that is lower than that calculated maximum.
- Max
Replica intContainer Groups Per Instance - GameLift calculates the maximum number of replica container groups it can launch per instance based on instance properties such as CPU, memory, and connection ports.
- desired
Replica IntegerContainer Groups Per Instance - Use this parameter to override the number of replica container groups GameLift will launch per instance with a number that is lower than that calculated maximum.
- max
Replica IntegerContainer Groups Per Instance - GameLift calculates the maximum number of replica container groups it can launch per instance based on instance properties such as CPU, memory, and connection ports.
- desired
Replica numberContainer Groups Per Instance - Use this parameter to override the number of replica container groups GameLift will launch per instance with a number that is lower than that calculated maximum.
- max
Replica numberContainer Groups Per Instance - GameLift calculates the maximum number of replica container groups it can launch per instance based on instance properties such as CPU, memory, and connection ports.
- desired_
replica_ intcontainer_ groups_ per_ instance - Use this parameter to override the number of replica container groups GameLift will launch per instance with a number that is lower than that calculated maximum.
- max_
replica_ intcontainer_ groups_ per_ instance - GameLift calculates the maximum number of replica container groups it can launch per instance based on instance properties such as CPU, memory, and connection ports.
- desired
Replica NumberContainer Groups Per Instance - Use this parameter to override the number of replica container groups GameLift will launch per instance with a number that is lower than that calculated maximum.
- max
Replica NumberContainer Groups Per Instance - GameLift calculates the maximum number of replica container groups it can launch per instance based on instance properties such as CPU, memory, and connection ports.
FleetInstanceRoleCredentialsProvider, FleetInstanceRoleCredentialsProviderArgs
- Shared
Credential File - SHARED_CREDENTIAL_FILE
- Fleet
Instance Role Credentials Provider Shared Credential File - SHARED_CREDENTIAL_FILE
- Shared
Credential File - SHARED_CREDENTIAL_FILE
- Shared
Credential File - SHARED_CREDENTIAL_FILE
- SHARED_CREDENTIAL_FILE
- SHARED_CREDENTIAL_FILE
- "SHARED_CREDENTIAL_FILE"
- SHARED_CREDENTIAL_FILE
FleetIpPermission, FleetIpPermissionArgs
- From
Port int - A starting value for a range of allowed port numbers.
- Ip
Range string - A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]".
- Protocol
Pulumi.
Aws Native. Game Lift. Fleet Ip Permission Protocol - The network communication protocol used by the fleet.
- To
Port int - An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
- From
Port int - A starting value for a range of allowed port numbers.
- Ip
Range string - A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]".
- Protocol
Fleet
Ip Permission Protocol - The network communication protocol used by the fleet.
- To
Port int - An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
- from
Port Integer - A starting value for a range of allowed port numbers.
- ip
Range String - A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]".
- protocol
Fleet
Ip Permission Protocol - The network communication protocol used by the fleet.
- to
Port Integer - An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
- from
Port number - A starting value for a range of allowed port numbers.
- ip
Range string - A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]".
- protocol
Fleet
Ip Permission Protocol - The network communication protocol used by the fleet.
- to
Port number - An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
- from_
port int - A starting value for a range of allowed port numbers.
- ip_
range str - A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]".
- protocol
Fleet
Ip Permission Protocol - The network communication protocol used by the fleet.
- to_
port int - An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
- from
Port Number - A starting value for a range of allowed port numbers.
- ip
Range String - A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]".
- protocol "TCP" | "UDP"
- The network communication protocol used by the fleet.
- to
Port Number - An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
FleetIpPermissionProtocol, FleetIpPermissionProtocolArgs
- Tcp
- TCP
- Udp
- UDP
- Fleet
Ip Permission Protocol Tcp - TCP
- Fleet
Ip Permission Protocol Udp - UDP
- Tcp
- TCP
- Udp
- UDP
- Tcp
- TCP
- Udp
- UDP
- TCP
- TCP
- UDP
- UDP
- "TCP"
- TCP
- "UDP"
- UDP
FleetLocationCapacity, FleetLocationCapacityArgs
- Desired
Ec2Instances int - The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.
- Max
Size int - The maximum value that is allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.
- Min
Size int - The minimum value allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.
- Desired
Ec2Instances int - The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.
- Max
Size int - The maximum value that is allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.
- Min
Size int - The minimum value allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.
- desired
Ec2Instances Integer - The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.
- max
Size Integer - The maximum value that is allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.
- min
Size Integer - The minimum value allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.
- desired
Ec2Instances number - The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.
- max
Size number - The maximum value that is allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.
- min
Size number - The minimum value allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.
- desired_
ec2_ intinstances - The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.
- max_
size int - The maximum value that is allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.
- min_
size int - The minimum value allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.
- desired
Ec2Instances Number - The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.
- max
Size Number - The maximum value that is allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.
- min
Size Number - The minimum value allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.
FleetLocationConfiguration, FleetLocationConfigurationArgs
- Location string
- An AWS Region code, such as
us-west-2
. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting. - Location
Capacity Pulumi.Aws Native. Game Lift. Inputs. Fleet Location Capacity Current resource capacity settings for managed EC2 fleets and container fleets. For multi-location fleets, location values might refer to a fleet's remote location or its home Region.
Returned by: DescribeFleetCapacity , DescribeFleetLocationCapacity , UpdateFleetCapacity
- Location string
- An AWS Region code, such as
us-west-2
. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting. - Location
Capacity FleetLocation Capacity Current resource capacity settings for managed EC2 fleets and container fleets. For multi-location fleets, location values might refer to a fleet's remote location or its home Region.
Returned by: DescribeFleetCapacity , DescribeFleetLocationCapacity , UpdateFleetCapacity
- location String
- An AWS Region code, such as
us-west-2
. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting. - location
Capacity FleetLocation Capacity Current resource capacity settings for managed EC2 fleets and container fleets. For multi-location fleets, location values might refer to a fleet's remote location or its home Region.
Returned by: DescribeFleetCapacity , DescribeFleetLocationCapacity , UpdateFleetCapacity
- location string
- An AWS Region code, such as
us-west-2
. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting. - location
Capacity FleetLocation Capacity Current resource capacity settings for managed EC2 fleets and container fleets. For multi-location fleets, location values might refer to a fleet's remote location or its home Region.
Returned by: DescribeFleetCapacity , DescribeFleetLocationCapacity , UpdateFleetCapacity
- location str
- An AWS Region code, such as
us-west-2
. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting. - location_
capacity FleetLocation Capacity Current resource capacity settings for managed EC2 fleets and container fleets. For multi-location fleets, location values might refer to a fleet's remote location or its home Region.
Returned by: DescribeFleetCapacity , DescribeFleetLocationCapacity , UpdateFleetCapacity
- location String
- An AWS Region code, such as
us-west-2
. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting. - location
Capacity Property Map Current resource capacity settings for managed EC2 fleets and container fleets. For multi-location fleets, location values might refer to a fleet's remote location or its home Region.
Returned by: DescribeFleetCapacity , DescribeFleetLocationCapacity , UpdateFleetCapacity
FleetNewGameSessionProtectionPolicy, FleetNewGameSessionProtectionPolicyArgs
- Full
Protection - FullProtection
- No
Protection - NoProtection
- Fleet
New Game Session Protection Policy Full Protection - FullProtection
- Fleet
New Game Session Protection Policy No Protection - NoProtection
- Full
Protection - FullProtection
- No
Protection - NoProtection
- Full
Protection - FullProtection
- No
Protection - NoProtection
- FULL_PROTECTION
- FullProtection
- NO_PROTECTION
- NoProtection
- "Full
Protection" - FullProtection
- "No
Protection" - NoProtection
FleetResourceCreationLimitPolicy, FleetResourceCreationLimitPolicyArgs
- New
Game intSessions Per Creator - The maximum number of game sessions that an individual can create during the policy period.
- Policy
Period intIn Minutes - The time span used in evaluating the resource creation limit policy.
- New
Game intSessions Per Creator - The maximum number of game sessions that an individual can create during the policy period.
- Policy
Period intIn Minutes - The time span used in evaluating the resource creation limit policy.
- new
Game IntegerSessions Per Creator - The maximum number of game sessions that an individual can create during the policy period.
- policy
Period IntegerIn Minutes - The time span used in evaluating the resource creation limit policy.
- new
Game numberSessions Per Creator - The maximum number of game sessions that an individual can create during the policy period.
- policy
Period numberIn Minutes - The time span used in evaluating the resource creation limit policy.
- new_
game_ intsessions_ per_ creator - The maximum number of game sessions that an individual can create during the policy period.
- policy_
period_ intin_ minutes - The time span used in evaluating the resource creation limit policy.
- new
Game NumberSessions Per Creator - The maximum number of game sessions that an individual can create during the policy period.
- policy
Period NumberIn Minutes - The time span used in evaluating the resource creation limit policy.
FleetRuntimeConfiguration, FleetRuntimeConfigurationArgs
- Game
Session intActivation Timeout Seconds - The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.
- Max
Concurrent intGame Session Activations - The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
- Server
Processes List<Pulumi.Aws Native. Game Lift. Inputs. Fleet Server Process> - A collection of server process configurations that describe which server processes to run on each instance in a fleet.
- Game
Session intActivation Timeout Seconds - The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.
- Max
Concurrent intGame Session Activations - The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
- Server
Processes []FleetServer Process - A collection of server process configurations that describe which server processes to run on each instance in a fleet.
- game
Session IntegerActivation Timeout Seconds - The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.
- max
Concurrent IntegerGame Session Activations - The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
- server
Processes List<FleetServer Process> - A collection of server process configurations that describe which server processes to run on each instance in a fleet.
- game
Session numberActivation Timeout Seconds - The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.
- max
Concurrent numberGame Session Activations - The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
- server
Processes FleetServer Process[] - A collection of server process configurations that describe which server processes to run on each instance in a fleet.
- game_
session_ intactivation_ timeout_ seconds - The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.
- max_
concurrent_ intgame_ session_ activations - The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
- server_
processes Sequence[FleetServer Process] - A collection of server process configurations that describe which server processes to run on each instance in a fleet.
- game
Session NumberActivation Timeout Seconds - The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.
- max
Concurrent NumberGame Session Activations - The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
- server
Processes List<Property Map> - A collection of server process configurations that describe which server processes to run on each instance in a fleet.
FleetScalingPolicy, FleetScalingPolicyArgs
- Metric
Name Pulumi.Aws Native. Game Lift. Fleet Scaling Policy Metric Name - Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
- Name string
- A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
- Comparison
Operator Pulumi.Aws Native. Game Lift. Fleet Scaling Policy Comparison Operator - Comparison operator to use when measuring a metric against the threshold value.
- Evaluation
Periods int - Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
- Location string
- The fleet location.
- Policy
Type Pulumi.Aws Native. Game Lift. Fleet Scaling Policy Policy Type - The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.
- Scaling
Adjustment int - Amount of adjustment to make, based on the scaling adjustment type.
- Scaling
Adjustment Pulumi.Type Aws Native. Game Lift. Fleet Scaling Policy Scaling Adjustment Type - The type of adjustment to make to a fleet's instance count.
- Status
Pulumi.
Aws Native. Game Lift. Fleet Scaling Policy Status - Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change.
- Target
Configuration Pulumi.Aws Native. Game Lift. Inputs. Fleet Target Configuration - An object that contains settings for a target-based scaling policy.
- Threshold double
- Metric value used to trigger a scaling event.
- Update
Status Pulumi.Aws Native. Game Lift. Fleet Scaling Policy Update Status - The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.
- Metric
Name FleetScaling Policy Metric Name - Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
- Name string
- A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
- Comparison
Operator FleetScaling Policy Comparison Operator - Comparison operator to use when measuring a metric against the threshold value.
- Evaluation
Periods int - Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
- Location string
- The fleet location.
- Policy
Type FleetScaling Policy Policy Type - The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.
- Scaling
Adjustment int - Amount of adjustment to make, based on the scaling adjustment type.
- Scaling
Adjustment FleetType Scaling Policy Scaling Adjustment Type - The type of adjustment to make to a fleet's instance count.
- Status
Fleet
Scaling Policy Status - Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change.
- Target
Configuration FleetTarget Configuration - An object that contains settings for a target-based scaling policy.
- Threshold float64
- Metric value used to trigger a scaling event.
- Update
Status FleetScaling Policy Update Status - The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.
- metric
Name FleetScaling Policy Metric Name - Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
- name String
- A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
- comparison
Operator FleetScaling Policy Comparison Operator - Comparison operator to use when measuring a metric against the threshold value.
- evaluation
Periods Integer - Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
- location String
- The fleet location.
- policy
Type FleetScaling Policy Policy Type - The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.
- scaling
Adjustment Integer - Amount of adjustment to make, based on the scaling adjustment type.
- scaling
Adjustment FleetType Scaling Policy Scaling Adjustment Type - The type of adjustment to make to a fleet's instance count.
- status
Fleet
Scaling Policy Status - Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change.
- target
Configuration FleetTarget Configuration - An object that contains settings for a target-based scaling policy.
- threshold Double
- Metric value used to trigger a scaling event.
- update
Status FleetScaling Policy Update Status - The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.
- metric
Name FleetScaling Policy Metric Name - Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
- name string
- A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
- comparison
Operator FleetScaling Policy Comparison Operator - Comparison operator to use when measuring a metric against the threshold value.
- evaluation
Periods number - Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
- location string
- The fleet location.
- policy
Type FleetScaling Policy Policy Type - The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.
- scaling
Adjustment number - Amount of adjustment to make, based on the scaling adjustment type.
- scaling
Adjustment FleetType Scaling Policy Scaling Adjustment Type - The type of adjustment to make to a fleet's instance count.
- status
Fleet
Scaling Policy Status - Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change.
- target
Configuration FleetTarget Configuration - An object that contains settings for a target-based scaling policy.
- threshold number
- Metric value used to trigger a scaling event.
- update
Status FleetScaling Policy Update Status - The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.
- metric_
name FleetScaling Policy Metric Name - Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
- name str
- A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
- comparison_
operator FleetScaling Policy Comparison Operator - Comparison operator to use when measuring a metric against the threshold value.
- evaluation_
periods int - Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
- location str
- The fleet location.
- policy_
type FleetScaling Policy Policy Type - The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.
- scaling_
adjustment int - Amount of adjustment to make, based on the scaling adjustment type.
- scaling_
adjustment_ Fleettype Scaling Policy Scaling Adjustment Type - The type of adjustment to make to a fleet's instance count.
- status
Fleet
Scaling Policy Status - Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change.
- target_
configuration FleetTarget Configuration - An object that contains settings for a target-based scaling policy.
- threshold float
- Metric value used to trigger a scaling event.
- update_
status FleetScaling Policy Update Status - The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.
- metric
Name "ActivatingGame Sessions" | "Active Game Sessions" | "Active Instances" | "Available Game Sessions" | "Available Player Sessions" | "Current Player Sessions" | "Idle Instances" | "Percent Available Game Sessions" | "Percent Idle Instances" | "Queue Depth" | "Wait Time" | "Concurrent Activatable Game Sessions" - Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
- name String
- A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
- comparison
Operator "GreaterThan Or Equal To Threshold" | "Greater Than Threshold" | "Less Than Threshold" | "Less Than Or Equal To Threshold" - Comparison operator to use when measuring a metric against the threshold value.
- evaluation
Periods Number - Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
- location String
- The fleet location.
- policy
Type "RuleBased" | "Target Based" - The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.
- scaling
Adjustment Number - Amount of adjustment to make, based on the scaling adjustment type.
- scaling
Adjustment "ChangeType In Capacity" | "Exact Capacity" | "Percent Change In Capacity" - The type of adjustment to make to a fleet's instance count.
- status "ACTIVE" | "UPDATE_REQUESTED" | "UPDATING" | "DELETE_REQUESTED" | "DELETING" | "DELETED" | "ERROR"
- Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change.
- target
Configuration Property Map - An object that contains settings for a target-based scaling policy.
- threshold Number
- Metric value used to trigger a scaling event.
- update
Status "PENDING_UPDATE" - The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.
FleetScalingPolicyComparisonOperator, FleetScalingPolicyComparisonOperatorArgs
- Greater
Than Or Equal To Threshold - GreaterThanOrEqualToThreshold
- Greater
Than Threshold - GreaterThanThreshold
- Less
Than Threshold - LessThanThreshold
- Less
Than Or Equal To Threshold - LessThanOrEqualToThreshold
- Fleet
Scaling Policy Comparison Operator Greater Than Or Equal To Threshold - GreaterThanOrEqualToThreshold
- Fleet
Scaling Policy Comparison Operator Greater Than Threshold - GreaterThanThreshold
- Fleet
Scaling Policy Comparison Operator Less Than Threshold - LessThanThreshold
- Fleet
Scaling Policy Comparison Operator Less Than Or Equal To Threshold - LessThanOrEqualToThreshold
- Greater
Than Or Equal To Threshold - GreaterThanOrEqualToThreshold
- Greater
Than Threshold - GreaterThanThreshold
- Less
Than Threshold - LessThanThreshold
- Less
Than Or Equal To Threshold - LessThanOrEqualToThreshold
- Greater
Than Or Equal To Threshold - GreaterThanOrEqualToThreshold
- Greater
Than Threshold - GreaterThanThreshold
- Less
Than Threshold - LessThanThreshold
- Less
Than Or Equal To Threshold - LessThanOrEqualToThreshold
- GREATER_THAN_OR_EQUAL_TO_THRESHOLD
- GreaterThanOrEqualToThreshold
- GREATER_THAN_THRESHOLD
- GreaterThanThreshold
- LESS_THAN_THRESHOLD
- LessThanThreshold
- LESS_THAN_OR_EQUAL_TO_THRESHOLD
- LessThanOrEqualToThreshold
- "Greater
Than Or Equal To Threshold" - GreaterThanOrEqualToThreshold
- "Greater
Than Threshold" - GreaterThanThreshold
- "Less
Than Threshold" - LessThanThreshold
- "Less
Than Or Equal To Threshold" - LessThanOrEqualToThreshold
FleetScalingPolicyMetricName, FleetScalingPolicyMetricNameArgs
- Activating
Game Sessions - ActivatingGameSessions
- Active
Game Sessions - ActiveGameSessions
- Active
Instances - ActiveInstances
- Available
Game Sessions - AvailableGameSessions
- Available
Player Sessions - AvailablePlayerSessions
- Current
Player Sessions - CurrentPlayerSessions
- Idle
Instances - IdleInstances
- Percent
Available Game Sessions - PercentAvailableGameSessions
- Percent
Idle Instances - PercentIdleInstances
- Queue
Depth - QueueDepth
- Wait
Time - WaitTime
- Concurrent
Activatable Game Sessions - ConcurrentActivatableGameSessions
- Fleet
Scaling Policy Metric Name Activating Game Sessions - ActivatingGameSessions
- Fleet
Scaling Policy Metric Name Active Game Sessions - ActiveGameSessions
- Fleet
Scaling Policy Metric Name Active Instances - ActiveInstances
- Fleet
Scaling Policy Metric Name Available Game Sessions - AvailableGameSessions
- Fleet
Scaling Policy Metric Name Available Player Sessions - AvailablePlayerSessions
- Fleet
Scaling Policy Metric Name Current Player Sessions - CurrentPlayerSessions
- Fleet
Scaling Policy Metric Name Idle Instances - IdleInstances
- Fleet
Scaling Policy Metric Name Percent Available Game Sessions - PercentAvailableGameSessions
- Fleet
Scaling Policy Metric Name Percent Idle Instances - PercentIdleInstances
- Fleet
Scaling Policy Metric Name Queue Depth - QueueDepth
- Fleet
Scaling Policy Metric Name Wait Time - WaitTime
- Fleet
Scaling Policy Metric Name Concurrent Activatable Game Sessions - ConcurrentActivatableGameSessions
- Activating
Game Sessions - ActivatingGameSessions
- Active
Game Sessions - ActiveGameSessions
- Active
Instances - ActiveInstances
- Available
Game Sessions - AvailableGameSessions
- Available
Player Sessions - AvailablePlayerSessions
- Current
Player Sessions - CurrentPlayerSessions
- Idle
Instances - IdleInstances
- Percent
Available Game Sessions - PercentAvailableGameSessions
- Percent
Idle Instances - PercentIdleInstances
- Queue
Depth - QueueDepth
- Wait
Time - WaitTime
- Concurrent
Activatable Game Sessions - ConcurrentActivatableGameSessions
- Activating
Game Sessions - ActivatingGameSessions
- Active
Game Sessions - ActiveGameSessions
- Active
Instances - ActiveInstances
- Available
Game Sessions - AvailableGameSessions
- Available
Player Sessions - AvailablePlayerSessions
- Current
Player Sessions - CurrentPlayerSessions
- Idle
Instances - IdleInstances
- Percent
Available Game Sessions - PercentAvailableGameSessions
- Percent
Idle Instances - PercentIdleInstances
- Queue
Depth - QueueDepth
- Wait
Time - WaitTime
- Concurrent
Activatable Game Sessions - ConcurrentActivatableGameSessions
- ACTIVATING_GAME_SESSIONS
- ActivatingGameSessions
- ACTIVE_GAME_SESSIONS
- ActiveGameSessions
- ACTIVE_INSTANCES
- ActiveInstances
- AVAILABLE_GAME_SESSIONS
- AvailableGameSessions
- AVAILABLE_PLAYER_SESSIONS
- AvailablePlayerSessions
- CURRENT_PLAYER_SESSIONS
- CurrentPlayerSessions
- IDLE_INSTANCES
- IdleInstances
- PERCENT_AVAILABLE_GAME_SESSIONS
- PercentAvailableGameSessions
- PERCENT_IDLE_INSTANCES
- PercentIdleInstances
- QUEUE_DEPTH
- QueueDepth
- WAIT_TIME
- WaitTime
- CONCURRENT_ACTIVATABLE_GAME_SESSIONS
- ConcurrentActivatableGameSessions
- "Activating
Game Sessions" - ActivatingGameSessions
- "Active
Game Sessions" - ActiveGameSessions
- "Active
Instances" - ActiveInstances
- "Available
Game Sessions" - AvailableGameSessions
- "Available
Player Sessions" - AvailablePlayerSessions
- "Current
Player Sessions" - CurrentPlayerSessions
- "Idle
Instances" - IdleInstances
- "Percent
Available Game Sessions" - PercentAvailableGameSessions
- "Percent
Idle Instances" - PercentIdleInstances
- "Queue
Depth" - QueueDepth
- "Wait
Time" - WaitTime
- "Concurrent
Activatable Game Sessions" - ConcurrentActivatableGameSessions
FleetScalingPolicyPolicyType, FleetScalingPolicyPolicyTypeArgs
- Rule
Based - RuleBased
- Target
Based - TargetBased
- Fleet
Scaling Policy Policy Type Rule Based - RuleBased
- Fleet
Scaling Policy Policy Type Target Based - TargetBased
- Rule
Based - RuleBased
- Target
Based - TargetBased
- Rule
Based - RuleBased
- Target
Based - TargetBased
- RULE_BASED
- RuleBased
- TARGET_BASED
- TargetBased
- "Rule
Based" - RuleBased
- "Target
Based" - TargetBased
FleetScalingPolicyScalingAdjustmentType, FleetScalingPolicyScalingAdjustmentTypeArgs
- Change
In Capacity - ChangeInCapacity
- Exact
Capacity - ExactCapacity
- Percent
Change In Capacity - PercentChangeInCapacity
- Fleet
Scaling Policy Scaling Adjustment Type Change In Capacity - ChangeInCapacity
- Fleet
Scaling Policy Scaling Adjustment Type Exact Capacity - ExactCapacity
- Fleet
Scaling Policy Scaling Adjustment Type Percent Change In Capacity - PercentChangeInCapacity
- Change
In Capacity - ChangeInCapacity
- Exact
Capacity - ExactCapacity
- Percent
Change In Capacity - PercentChangeInCapacity
- Change
In Capacity - ChangeInCapacity
- Exact
Capacity - ExactCapacity
- Percent
Change In Capacity - PercentChangeInCapacity
- CHANGE_IN_CAPACITY
- ChangeInCapacity
- EXACT_CAPACITY
- ExactCapacity
- PERCENT_CHANGE_IN_CAPACITY
- PercentChangeInCapacity
- "Change
In Capacity" - ChangeInCapacity
- "Exact
Capacity" - ExactCapacity
- "Percent
Change In Capacity" - PercentChangeInCapacity
FleetScalingPolicyStatus, FleetScalingPolicyStatusArgs
- Active
- ACTIVE
- Update
Requested - UPDATE_REQUESTED
- Updating
- UPDATING
- Delete
Requested - DELETE_REQUESTED
- Deleting
- DELETING
- Deleted
- DELETED
- Error
- ERROR
- Fleet
Scaling Policy Status Active - ACTIVE
- Fleet
Scaling Policy Status Update Requested - UPDATE_REQUESTED
- Fleet
Scaling Policy Status Updating - UPDATING
- Fleet
Scaling Policy Status Delete Requested - DELETE_REQUESTED
- Fleet
Scaling Policy Status Deleting - DELETING
- Fleet
Scaling Policy Status Deleted - DELETED
- Fleet
Scaling Policy Status Error - ERROR
- Active
- ACTIVE
- Update
Requested - UPDATE_REQUESTED
- Updating
- UPDATING
- Delete
Requested - DELETE_REQUESTED
- Deleting
- DELETING
- Deleted
- DELETED
- Error
- ERROR
- Active
- ACTIVE
- Update
Requested - UPDATE_REQUESTED
- Updating
- UPDATING
- Delete
Requested - DELETE_REQUESTED
- Deleting
- DELETING
- Deleted
- DELETED
- Error
- ERROR
- ACTIVE
- ACTIVE
- UPDATE_REQUESTED
- UPDATE_REQUESTED
- UPDATING
- UPDATING
- DELETE_REQUESTED
- DELETE_REQUESTED
- DELETING
- DELETING
- DELETED
- DELETED
- ERROR
- ERROR
- "ACTIVE"
- ACTIVE
- "UPDATE_REQUESTED"
- UPDATE_REQUESTED
- "UPDATING"
- UPDATING
- "DELETE_REQUESTED"
- DELETE_REQUESTED
- "DELETING"
- DELETING
- "DELETED"
- DELETED
- "ERROR"
- ERROR
FleetScalingPolicyUpdateStatus, FleetScalingPolicyUpdateStatusArgs
- Pending
Update - PENDING_UPDATE
- Fleet
Scaling Policy Update Status Pending Update - PENDING_UPDATE
- Pending
Update - PENDING_UPDATE
- Pending
Update - PENDING_UPDATE
- PENDING_UPDATE
- PENDING_UPDATE
- "PENDING_UPDATE"
- PENDING_UPDATE
FleetServerProcess, FleetServerProcessArgs
- Concurrent
Executions int - The number of server processes that use this configuration to run concurrently on an instance.
- Launch
Path string The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:
Windows (for custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe"
Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "/local/game/MyRealtimeScript.js"
- Parameters string
- An optional list of parameters to pass to the server executable or Realtime script on launch.
- Concurrent
Executions int - The number of server processes that use this configuration to run concurrently on an instance.
- Launch
Path string The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:
Windows (for custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe"
Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "/local/game/MyRealtimeScript.js"
- Parameters string
- An optional list of parameters to pass to the server executable or Realtime script on launch.
- concurrent
Executions Integer - The number of server processes that use this configuration to run concurrently on an instance.
- launch
Path String The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:
Windows (for custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe"
Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "/local/game/MyRealtimeScript.js"
- parameters String
- An optional list of parameters to pass to the server executable or Realtime script on launch.
- concurrent
Executions number - The number of server processes that use this configuration to run concurrently on an instance.
- launch
Path string The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:
Windows (for custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe"
Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "/local/game/MyRealtimeScript.js"
- parameters string
- An optional list of parameters to pass to the server executable or Realtime script on launch.
- concurrent_
executions int - The number of server processes that use this configuration to run concurrently on an instance.
- launch_
path str The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:
Windows (for custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe"
Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "/local/game/MyRealtimeScript.js"
- parameters str
- An optional list of parameters to pass to the server executable or Realtime script on launch.
- concurrent
Executions Number - The number of server processes that use this configuration to run concurrently on an instance.
- launch
Path String The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:
Windows (for custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe"
Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "/local/game/MyRealtimeScript.js"
- parameters String
- An optional list of parameters to pass to the server executable or Realtime script on launch.
FleetTargetConfiguration, FleetTargetConfigurationArgs
- Target
Value double - Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).
- Target
Value float64 - Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).
- target
Value Double - Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).
- target
Value number - Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).
- target_
value float - Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).
- target
Value Number - Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).
FleetType, FleetTypeArgs
- On
Demand - ON_DEMAND
- Spot
- SPOT
- Fleet
Type On Demand - ON_DEMAND
- Fleet
Type Spot - SPOT
- On
Demand - ON_DEMAND
- Spot
- SPOT
- On
Demand - ON_DEMAND
- Spot
- SPOT
- ON_DEMAND
- ON_DEMAND
- SPOT
- SPOT
- "ON_DEMAND"
- ON_DEMAND
- "SPOT"
- SPOT
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.