BuildFleetProps

class aws_cdk.aws_gamelift_alpha.BuildFleetProps(*, fleet_name, instance_type, runtime_configuration, description=None, desired_capacity=None, locations=None, max_size=None, metric_group=None, min_size=None, peer_vpc=None, protect_new_game_session=None, resource_creation_limit_policy=None, role=None, use_certificate=None, use_spot=None, content, ingress_rules=None)

Bases: FleetProps

(experimental) Properties for a new Gamelift build fleet.

Parameters:

fleet_name (str) – (experimental) A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
instance_type (InstanceType) – (experimental) The GameLift-supported Amazon EC2 instance type to use for all fleet instances. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity.
runtime_configuration (Union[RuntimeConfiguration, Dict[str, Any]]) – (experimental) A collection of server process configurations that describe the set of processes to run on each instance in a fleet. Server processes run either an executable in a custom game build or a Realtime Servers script. GameLift launches the configured processes, manages their life cycle, and replaces them as needed. Each instance checks regularly for an updated runtime configuration. A GameLift instance is limited to 50 processes running concurrently. To calculate the total number of processes in a runtime configuration, add the values of the ConcurrentExecutions parameter for each ServerProcess.
description (Optional[str]) – (experimental) A human-readable description of the fleet. Default: no description is provided
desired_capacity (Union[int, float, None]) – (experimental) 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. Default: Default capacity is 0
locations (Optional[Sequence[Union[Location, Dict[str, Any]]]]) – (experimental) A set of remote locations to deploy additional instances to and manage as part of the fleet. This parameter can only be used when creating fleets in AWS Regions that support multiple locations. You can add any GameLift-supported AWS Region as a remote location, in the form of an AWS Region code such as us-west-2. To create a fleet with instances in the home region only, omit this parameter. Default: Create a fleet with instances in the home region only
max_size (Union[int, float, None]) – (experimental) The maximum number of instances that are allowed in the specified fleet location. Default: the default is 1
metric_group (Optional[str]) – (experimental) The name of an AWS CloudWatch metric group to add this fleet to. A metric group is used to aggregate the metrics for multiple fleets. You can specify an existing metric group name or set a new name to create a new metric group. A fleet can be included in only one metric group at a time. Default: Fleet metrics are aggregated with other fleets in the default metric group
min_size (Union[int, float, None]) – (experimental) The minimum number of instances that are allowed in the specified fleet location. Default: the default is 0
peer_vpc (Optional[IVpc]) – (experimental) A VPC peering connection between your GameLift-hosted game servers and your other non-GameLift resources. Use Amazon Virtual Private Cloud (VPC) peering connections to enable your game servers to communicate directly and privately with your other AWS resources, such as a web service or a repository. You can establish VPC peering with any resources that run on AWS and are managed by an AWS account that you have access to. The VPC must be in the same Region as your fleet. Warning: Be sure to create a VPC Peering authorization through Gamelift Service API. Default: no vpc peering
protect_new_game_session (Optional[bool]) – (experimental) The status of termination protection for active game sessions on the fleet. By default, new game sessions are protected and cannot be terminated during a scale-down event. Default: true - Game sessions in ACTIVE status cannot be terminated during a scale-down event.
resource_creation_limit_policy (Union[ResourceCreationLimitPolicy, Dict[str, Any], None]) – (experimental) A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time. Default: No resource creation limit policy
role (Optional[IRole]) – (experimental) The IAM role assumed by GameLift fleet instances to access AWS ressources. With a role set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). If providing a custom role, it needs to trust the GameLift service principal (gamelift.amazonaws.com). No permission is required by default. This property cannot be changed after the fleet is created. Default: - a role will be created with default trust to Gamelift service principal.
use_certificate (Optional[bool]) – (experimental) Prompts GameLift to generate a TLS/SSL certificate for the fleet. GameLift uses the certificates to encrypt traffic between game clients and the game servers running on GameLift. You can’t change this property after you create the fleet. Additionnal info: AWS Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition. Default: TLS/SSL certificate are generated for the fleet
use_spot (Optional[bool]) – (experimental) Indicates whether to use On-Demand or Spot instances for this fleet. By default, fleet use on demand capacity. This property cannot be changed after the fleet is created. Default: Gamelift fleet use on demand capacity
content (IBuild) – (experimental) A build to be deployed on the fleet. 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.
ingress_rules (Optional[Sequence[Union[IngressRule, Dict[str, Any]]]]) – (experimental) The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet. This property must be set before players can connect to game sessions. Default: no inbound traffic allowed

Stability:

experimental

ExampleMetadata:

infused

Example:

# build: gamelift.Build

# Server processes can be delcared in a declarative way through the constructor
fleet = gamelift.BuildFleet(self, "Game server fleet",
    fleet_name="test-fleet",
    content=build,
    instance_type=ec2.InstanceType.of(ec2.InstanceClass.C4, ec2.InstanceSize.LARGE),
    runtime_configuration=gamelift.RuntimeConfiguration(
        server_processes=[gamelift.ServerProcess(
            launch_path="/local/game/GameLiftExampleServer.x86_64",
            parameters="-logFile /local/game/logs/myserver1935.log -port 1935",
            concurrent_executions=100
        )]
    )
)

Attributes

content

(experimental) A build to be deployed on the fleet.

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.

Stability:: experimental

description

(experimental) A human-readable description of the fleet.

Default:: no description is provided
Stability:: experimental

desired_capacity

(experimental) 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.

Default:: Default capacity is 0
Stability:: experimental

fleet_name

(experimental) A descriptive label that is associated with a fleet.

Fleet names do not need to be unique.

Stability:: experimental

ingress_rules

(experimental) The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet.

This property must be set before players can connect to game sessions.

Default:: no inbound traffic allowed
Stability:: experimental

instance_type

(experimental) The GameLift-supported Amazon EC2 instance type to use for all fleet instances.

Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity.

See:: http://aws.amazon.com/ec2/instance-types/ for detailed descriptions of Amazon EC2 instance types.
Stability:: experimental

locations

(experimental) A set of remote locations to deploy additional instances to and manage as part of the fleet.

This parameter can only be used when creating fleets in AWS Regions that support multiple locations. You can add any GameLift-supported AWS Region as a remote location, in the form of an AWS Region code such as us-west-2. To create a fleet with instances in the home region only, omit this parameter.

Default:: Create a fleet with instances in the home region only
Stability:: experimental

max_size

(experimental) The maximum number of instances that are allowed in the specified fleet location.

Default:: the default is 1
Stability:: experimental

metric_group

(experimental) The name of an AWS CloudWatch metric group to add this fleet to.

A metric group is used to aggregate the metrics for multiple fleets. You can specify an existing metric group name or set a new name to create a new metric group. A fleet can be included in only one metric group at a time.

Default:: Fleet metrics are aggregated with other fleets in the default metric group
Stability:: experimental

min_size

(experimental) The minimum number of instances that are allowed in the specified fleet location.

Default:: the default is 0
Stability:: experimental

peer_vpc

(experimental) A VPC peering connection between your GameLift-hosted game servers and your other non-GameLift resources.

Use Amazon Virtual Private Cloud (VPC) peering connections to enable your game servers to communicate directly and privately with your other AWS resources, such as a web service or a repository. You can establish VPC peering with any resources that run on AWS and are managed by an AWS account that you have access to. The VPC must be in the same Region as your fleet.

Warning: Be sure to create a VPC Peering authorization through Gamelift Service API.

Default:: no vpc peering
See:: https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html
Stability:: experimental

protect_new_game_session

(experimental) The status of termination protection for active game sessions on the fleet.

By default, new game sessions are protected and cannot be terminated during a scale-down event.

Default:: true - Game sessions in ACTIVE status cannot be terminated during a scale-down event.
Stability:: experimental

resource_creation_limit_policy

(experimental) A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.

Default:: No resource creation limit policy
Stability:: experimental

role

(experimental) The IAM role assumed by GameLift fleet instances to access AWS ressources.

With a role set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). If providing a custom role, it needs to trust the GameLift service principal (gamelift.amazonaws.com). No permission is required by default.

This property cannot be changed after the fleet is created.

Default:

a role will be created with default trust to Gamelift service principal.

See:

https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html

Stability:

experimental

runtime_configuration

(experimental) A collection of server process configurations that describe the set of processes to run on each instance in a fleet.

Server processes run either an executable in a custom game build or a Realtime Servers script. GameLift launches the configured processes, manages their life cycle, and replaces them as needed. Each instance checks regularly for an updated runtime configuration.

A GameLift instance is limited to 50 processes running concurrently. To calculate the total number of processes in a runtime configuration, add the values of the ConcurrentExecutions parameter for each ServerProcess.

See:: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html
Stability:: experimental

use_certificate

(experimental) Prompts GameLift to generate a TLS/SSL certificate for the fleet.

GameLift uses the certificates to encrypt traffic between game clients and the game servers running on GameLift.

You can’t change this property after you create the fleet.

Additionnal info: AWS Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition.

Default:: TLS/SSL certificate are generated for the fleet
Stability:: experimental

use_spot

(experimental) Indicates whether to use On-Demand or Spot instances for this fleet. By default, fleet use on demand capacity.

This property cannot be changed after the fleet is created.

Default:: Gamelift fleet use on demand capacity
See:: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot
Stability:: experimental