software.amazon.awscdk.services.gamelift

Interface CfnGameServerGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGameServerGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:09.336Z")
 @Stability(value=Stable)
public interface CfnGameServerGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnGameServerGroup`.

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.*;
 CfnGameServerGroupProps cfnGameServerGroupProps = CfnGameServerGroupProps.builder()
         .gameServerGroupName("gameServerGroupName")
         .instanceDefinitions(List.of(InstanceDefinitionProperty.builder()
                 .instanceType("instanceType")
                 // the properties below are optional
                 .weightedCapacity("weightedCapacity")
                 .build()))
         .launchTemplate(LaunchTemplateProperty.builder()
                 .launchTemplateId("launchTemplateId")
                 .launchTemplateName("launchTemplateName")
                 .version("version")
                 .build())
         .roleArn("roleArn")
         // the properties below are optional
         .autoScalingPolicy(AutoScalingPolicyProperty.builder()
                 .targetTrackingConfiguration(TargetTrackingConfigurationProperty.builder()
                         .targetValue(123)
                         .build())
                 // the properties below are optional
                 .estimatedInstanceWarmup(123)
                 .build())
         .balancingStrategy("balancingStrategy")
         .deleteOption("deleteOption")
         .gameServerProtectionPolicy("gameServerProtectionPolicy")
         .maxSize(123)
         .minSize(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcSubnets(List.of("vpcSubnets"))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnGameServerGroupProps.Builder	builder()
default Object	getAutoScalingPolicy() `AWS::GameLift::GameServerGroup.AutoScalingPolicy`.
default String	getBalancingStrategy() Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group.
default String	getDeleteOption() `AWS::GameLift::GameServerGroup.DeleteOption`.
String	getGameServerGroupName() A developer-defined identifier for the game server group.
default String	getGameServerProtectionPolicy() A flag that indicates whether instances in the game server group are protected from early termination.
Object	getInstanceDefinitions() The set of Amazon EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
Object	getLaunchTemplate() `AWS::GameLift::GameServerGroup.LaunchTemplate`.
default Number	getMaxSize() `AWS::GameLift::GameServerGroup.MaxSize`.
default Number	getMinSize() `AWS::GameLift::GameServerGroup.MinSize`.
String	getRoleArn() The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) for an IAM role that allows Amazon Web Services to access your Amazon EC2 Auto Scaling groups.
default List<CfnTag>	getTags() `AWS::GameLift::GameServerGroup.Tags`.
default List<String>	getVpcSubnets() `AWS::GameLift::GameServerGroup.VpcSubnets`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getGameServerGroupName

@Stability(value=Stable)
 @NotNull
String getGameServerGroupName()

A developer-defined identifier for the game server group.

The name is unique for each Region in each AWS account.

getInstanceDefinitions

@Stability(value=Stable)
 @NotNull
Object getInstanceDefinitions()

The set of Amazon EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

getLaunchTemplate

@Stability(value=Stable)
 @NotNull
Object getLaunchTemplate()

`AWS::GameLift::GameServerGroup.LaunchTemplate`.

getRoleArn

@Stability(value=Stable)
 @NotNull
String getRoleArn()

The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) for an IAM role that allows Amazon Web Services to access your Amazon EC2 Auto Scaling groups.

getAutoScalingPolicy

@Stability(value=Stable)
 @Nullable
default Object getAutoScalingPolicy()

`AWS::GameLift::GameServerGroup.AutoScalingPolicy`.

getBalancingStrategy

@Stability(value=Stable)
 @Nullable
default String getBalancingStrategy()

Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group.

Method options include the following:

• SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.
• SPOT_PREFERRED - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.
• ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.

getDeleteOption

@Stability(value=Stable)
 @Nullable
default String getDeleteOption()

`AWS::GameLift::GameServerGroup.DeleteOption`.

getGameServerProtectionPolicy

@Stability(value=Stable)
 @Nullable
default String getGameServerProtectionPolicy()

A flag that indicates whether instances in the game server group are protected from early termination.

Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status.

getMaxSize

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

`AWS::GameLift::GameServerGroup.MaxSize`.

getMinSize

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

`AWS::GameLift::GameServerGroup.MinSize`.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

`AWS::GameLift::GameServerGroup.Tags`.

getVpcSubnets

@Stability(value=Stable)
 @Nullable
default List<String> getVpcSubnets()

`AWS::GameLift::GameServerGroup.VpcSubnets`.

builder

@Stability(value=Stable)
static CfnGameServerGroupProps.Builder builder()

Returns:

a CfnGameServerGroupProps.Builder of CfnGameServerGroupProps