Package software.amazon.awscdk.cfnpropertymixins.services.gamelift

Interface CfnContainerFleetPropsMixin.LocationCapacityProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnContainerFleetPropsMixin.LocationCapacityProperty.Jsii$Proxy

Enclosing class:

CfnContainerFleetPropsMixin

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

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:

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

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnContainerFleetPropsMixin.LocationCapacityProperty.Builder	builder()
default Number	getDesiredEc2Instances()	Defaults to MinSize if not defined.
default Object	getManagedCapacityConfiguration()	Configuration options for Amazon GameLift Servers managed capacity behavior.
default Number	getMaxSize()	The maximum value that is allowed for the fleet's instance count for a location.
default Number	getMinSize()	The minimum value allowed for the fleet's instance count for a location.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDesiredEc2Instances

@Stability(Stable)
@Nullable
default Number getDesiredEc2Instances()

Defaults to MinSize if not defined.

The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits. If any auto-scaling policy is defined for the container fleet, the desired instance will only be applied once during fleet creation and will be ignored in updates to avoid conflicts with auto-scaling. During updates with any auto-scaling policy defined, if current desired instance is lower than the new MinSize, it will be increased to the new MinSize; if current desired instance is larger than the new MaxSize, it will be decreased to the new MaxSize.

See Also:

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

getManagedCapacityConfiguration

@Stability(Stable)
@Nullable
default Object getManagedCapacityConfiguration()

Configuration options for Amazon GameLift Servers managed capacity behavior.

Returns union: either IResolvable or CfnContainerFleetPropsMixin.ManagedCapacityConfigurationProperty

See Also:

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

getMaxSize

@Stability(Stable)
@Nullable
default Number getMaxSize()

The maximum value that is allowed for the fleet's instance count for a location.

See Also:

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

getMinSize

@Stability(Stable)
@Nullable
default Number getMinSize()

The minimum value allowed for the fleet's instance count for a location.

See Also:

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

builder

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

Returns:

a CfnContainerFleetPropsMixin.LocationCapacityProperty.Builder of CfnContainerFleetPropsMixin.LocationCapacityProperty