Package software.amazon.awscdk.services.gamelift

Interface CfnFleet.ContainerGroupsPerInstanceProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFleet.ContainerGroupsPerInstanceProperty.Jsii$Proxy

Enclosing class:

CfnFleet

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

This data type is used with the Amazon GameLift containers feature, which is currently in public preview..

Determines how many replica container groups that Amazon GameLift deploys to each instance in a container fleet.

Amazon GameLift calculates the maximum possible replica groups per instance based on the instance 's CPU and memory resources. When deploying a fleet, Amazon GameLift places replica container groups on each fleet instance based on the following:

• If no desired value is set, Amazon GameLift places the calculated maximum.
• If a desired number is set to a value higher than the calculated maximum, fleet creation fails..
• If a desired number is set to a value lower than the calculated maximum, Amazon GameLift places the desired number.

Part of: ContainerGroupsConfiguration , ContainerGroupsAttributes

Returned by: DescribeFleetAttributes , CreateFleet

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.*;
 ContainerGroupsPerInstanceProperty containerGroupsPerInstanceProperty = ContainerGroupsPerInstanceProperty.builder()
         .desiredReplicaContainerGroupsPerInstance(123)
         .maxReplicaContainerGroupsPerInstance(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFleet.ContainerGroupsPerInstanceProperty.Builder	builder()
default Number	getDesiredReplicaContainerGroupsPerInstance()	The desired number of replica container groups to place on each fleet instance.
default Number	getMaxReplicaContainerGroupsPerInstance()	The maximum possible number of replica container groups that each fleet instance can have.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDesiredReplicaContainerGroupsPerInstance

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

The desired number of replica container groups to place on each fleet instance.

See Also:

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

getMaxReplicaContainerGroupsPerInstance

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

The maximum possible number of replica container groups that each fleet instance can have.

See Also:

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

builder

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

Returns:

a CfnFleet.ContainerGroupsPerInstanceProperty.Builder of CfnFleet.ContainerGroupsPerInstanceProperty