Package software.amazon.awscdk.services.gamelift

Interface CfnFleet.LocationCapacityProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFleet.LocationCapacityProperty.Jsii$Proxy

Enclosing class:

CfnFleet

@Stability(Stable)
public static interface CfnFleet.LocationCapacityProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.gamelift.*;
 LocationCapacityProperty locationCapacityProperty = LocationCapacityProperty.builder()
         .desiredEc2Instances(123)
         .maxSize(123)
         .minSize(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationcapacity.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFleet.LocationCapacityProperty.Builder	A builder for CfnFleet.LocationCapacityProperty
static final class	CfnFleet.LocationCapacityProperty.Jsii$Proxy	An implementation for CfnFleet.LocationCapacityProperty

Method Summary

Modifier and Type	Method	Description
static CfnFleet.LocationCapacityProperty.Builder	builder()
Number	getDesiredEc2Instances()	The number of Amazon EC2 instances you want to maintain in the specified fleet location.
Number	getMaxSize()	The maximum number of instances that are allowed in the specified fleet location.
Number	getMinSize()	The minimum number of instances that are allowed in the specified fleet location.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDesiredEc2Instances

@Stability(Stable)
@NotNull
Number getDesiredEc2Instances()

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. Changes in desired instance value can take up to 1 minute to be reflected when viewing the fleet's capacity settings.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationcapacity.html#cfn-gamelift-fleet-locationcapacity-desiredec2instances

getMaxSize

@Stability(Stable)
@NotNull
Number getMaxSize()

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationcapacity.html#cfn-gamelift-fleet-locationcapacity-maxsize

getMinSize

@Stability(Stable)
@NotNull
Number getMinSize()

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationcapacity.html#cfn-gamelift-fleet-locationcapacity-minsize

builder

@Stability(Stable)
static CfnFleet.LocationCapacityProperty.Builder builder()

Returns:

a CfnFleet.LocationCapacityProperty.Builder of CfnFleet.LocationCapacityProperty