aws-cdk-lib.aws_gamelift.CfnFleet.LocationCapacityProperty

interface LocationCapacityProperty

LanguageType name
.NETAmazon.CDK.AWS.GameLift.CfnFleet.LocationCapacityProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsgamelift#CfnFleet_LocationCapacityProperty
Javasoftware.amazon.awscdk.services.gamelift.CfnFleet.LocationCapacityProperty
Pythonaws_cdk.aws_gamelift.CfnFleet.LocationCapacityProperty
TypeScript aws-cdk-lib » aws_gamelift » CfnFleet » LocationCapacityProperty

Obtainable from FleetBase.parseLocationCapacity()

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.

Related actions

DescribeFleetCapacity | DescribeFleetLocationCapacity | UpdateFleetCapacity

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_gamelift as gamelift } from 'aws-cdk-lib';
const locationCapacityProperty: gamelift.CfnFleet.LocationCapacityProperty = {
  desiredEc2Instances: 123,
  maxSize: 123,
  minSize: 123,
};

Properties

NameTypeDescription
desiredEc2InstancesnumberThe number of Amazon EC2 instances you want to maintain in the specified fleet location.
maxSizenumberThe maximum number of instances that are allowed in the specified fleet location.
minSizenumberThe minimum number of instances that are allowed in the specified fleet location.

desiredEc2Instances

Type: number

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

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

If this parameter is not set, the default is 1.


minSize

Type: number

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

If this parameter is not set, the default is 0.