Interface ILocationCapacity

(experimental) Current resource capacity settings in a specified fleet or location.

Namespace: Amazon.CDK.AWS.GameLift.Alpha

Assembly: Amazon.CDK.AWS.GameLift.Alpha.dll

Syntax (csharp)

public interface ILocationCapacity

Syntax (vb)

Public Interface ILocationCapacity

Remarks

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

Stability: Experimental

ExampleMetadata: infused

Examples

Build build;


// Locations can be added directly through constructor
var fleet = new BuildFleet(this, "Game server fleet", new BuildFleetProps {
    FleetName = "test-fleet",
    Content = build,
    InstanceType = InstanceType.Of(InstanceClass.C4, InstanceSize.LARGE),
    RuntimeConfiguration = new RuntimeConfiguration {
        ServerProcesses = new [] { new ServerProcess {
            LaunchPath = "/local/game/GameLiftExampleServer.x86_64"
        } }
    },
    Locations = new [] { new Location {
        Region = "eu-west-1",
        Capacity = new LocationCapacity {
            DesiredCapacity = 5,
            MinSize = 2,
            MaxSize = 10
        }
    }, new Location {
        Region = "us-east-1",
        Capacity = new LocationCapacity {
            DesiredCapacity = 5,
            MinSize = 2,
            MaxSize = 10
        }
    } }
});

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

Synopsis

Properties

DesiredCapacity	(experimental) The number of Amazon EC2 instances you want to maintain in the specified fleet location.
MaxSize	(experimental) The maximum number of instances that are allowed in the specified fleet location.
MinSize	(experimental) The minimum number of instances that are allowed in the specified fleet location.

Properties

DesiredCapacity

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

virtual Nullable<double> DesiredCapacity { get; }

Property Value

System.Nullable<System.Double>

Remarks

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

Default: the default value is 0

Stability: Experimental

MaxSize

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

virtual Nullable<double> MaxSize { get; }

Property Value

System.Nullable<System.Double>

Remarks

Default: the default value is 1

Stability: Experimental

MinSize

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

virtual Nullable<double> MinSize { get; }

Property Value

System.Nullable<System.Double>

Remarks

Default: the default value is 0

Stability: Experimental