@aws-cdk_aws-gamelift-alpha.LocationCapacity

interface LocationCapacity ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.GameLift.Alpha.LocationCapacity
Gogithub.com/aws/aws-cdk-go/awscdkgameliftalpha/v2#LocationCapacity
Javasoftware.amazon.awscdk.services.gamelift.alpha.LocationCapacity
Pythonaws_cdk.aws_gamelift_alpha.LocationCapacity
TypeScript (source)@aws-cdk/aws-gamelift-alpha ยป LocationCapacity

Current resource capacity settings in a specified fleet or location.

The location value might refer to a fleet's remote location or its home Region.

Example

declare const build: gamelift.Build;

// Locations can be added directly through constructor
const fleet = new gamelift.BuildFleet(this, 'Game server fleet', {
  fleetName: 'test-fleet',
  content: build,
  instanceType: ec2.InstanceType.of(ec2.InstanceClass.C4, ec2.InstanceSize.LARGE),
  runtimeConfiguration: {
    serverProcesses: [{
      launchPath: '/local/game/GameLiftExampleServer.x86_64',
    }]
  },
  locations: [ {
    region: 'eu-west-1',
    capacity: {
      desiredCapacity: 5,
      minSize: 2,
      maxSize: 10
    }
  }, {
    region: 'us-east-1',
    capacity: {
      desiredCapacity: 5,
      minSize: 2,
      maxSize: 10
    }
  }]
});

// Or through dedicated methods
fleet.addLocation('ap-southeast-1', 5, 2, 10);

Properties

NameTypeDescription
desiredCapacity?๐Ÿ”นnumberThe number of Amazon EC2 instances you want to maintain in the specified fleet location.
maxSize?๐Ÿ”นnumberThe maximum number of instances that are allowed in the specified fleet location.
minSize?๐Ÿ”นnumberThe minimum number of instances that are allowed in the specified fleet location.

desiredCapacity?๐Ÿ”น

Type: number (optional, default: the default value is 0)

The number of Amazon EC2 instances you want to maintain in the specified fleet location.

This value must fall between the minimum and maximum size limits.


maxSize?๐Ÿ”น

Type: number (optional, default: the default value is 1)

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


minSize?๐Ÿ”น

Type: number (optional, default: the default value is 0)

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