software.amazon.awscdk.services.gamelift

Class CfnGameServerGroup.Builder

java.lang.Object

software.amazon.awscdk.services.gamelift.CfnGameServerGroup.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnGameServerGroup>

Enclosing class:

CfnGameServerGroup

@Stability(value=Stable)
public static final class CfnGameServerGroup.Builder
extends Object
implements software.amazon.jsii.Builder<CfnGameServerGroup>

A fluent builder for CfnGameServerGroup.

Method Summary

Modifier and Type	Method and Description
CfnGameServerGroup.Builder	autoScalingPolicy(CfnGameServerGroup.AutoScalingPolicyProperty autoScalingPolicy) `AWS::GameLift::GameServerGroup.AutoScalingPolicy`.
CfnGameServerGroup.Builder	autoScalingPolicy(IResolvable autoScalingPolicy) `AWS::GameLift::GameServerGroup.AutoScalingPolicy`.
CfnGameServerGroup.Builder	balancingStrategy(String balancingStrategy) Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group.
CfnGameServerGroup	build()
static CfnGameServerGroup.Builder	create(Construct scope, String id)
CfnGameServerGroup.Builder	deleteOption(String deleteOption) `AWS::GameLift::GameServerGroup.DeleteOption`.
CfnGameServerGroup.Builder	gameServerGroupName(String gameServerGroupName) A developer-defined identifier for the game server group.
CfnGameServerGroup.Builder	gameServerProtectionPolicy(String gameServerProtectionPolicy) A flag that indicates whether instances in the game server group are protected from early termination.
CfnGameServerGroup.Builder	instanceDefinitions(IResolvable instanceDefinitions) The set of Amazon EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
CfnGameServerGroup.Builder	instanceDefinitions(List<? extends Object> instanceDefinitions) The set of Amazon EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
CfnGameServerGroup.Builder	launchTemplate(CfnGameServerGroup.LaunchTemplateProperty launchTemplate) `AWS::GameLift::GameServerGroup.LaunchTemplate`.
CfnGameServerGroup.Builder	launchTemplate(IResolvable launchTemplate) `AWS::GameLift::GameServerGroup.LaunchTemplate`.
CfnGameServerGroup.Builder	maxSize(Number maxSize) `AWS::GameLift::GameServerGroup.MaxSize`.
CfnGameServerGroup.Builder	minSize(Number minSize) `AWS::GameLift::GameServerGroup.MinSize`.
CfnGameServerGroup.Builder	roleArn(String roleArn) 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.
CfnGameServerGroup.Builder	tags(List<? extends CfnTag> tags) `AWS::GameLift::GameServerGroup.Tags`.
CfnGameServerGroup.Builder	vpcSubnets(List<String> vpcSubnets) `AWS::GameLift::GameServerGroup.VpcSubnets`.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static CfnGameServerGroup.Builder create(Construct scope,
                                                                         String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnGameServerGroup.AutoScalingPolicyProperty.Builder.

gameServerGroupName

@Stability(value=Stable)
public CfnGameServerGroup.Builder gameServerGroupName(String gameServerGroupName)

A developer-defined identifier for the game server group.

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

Parameters:

gameServerGroupName - A developer-defined identifier for the game server group. This parameter is required.

Returns:

this

instanceDefinitions

@Stability(value=Stable)
public CfnGameServerGroup.Builder instanceDefinitions(IResolvable instanceDefinitions)

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

Parameters:

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

Returns:

this

instanceDefinitions

@Stability(value=Stable)
public CfnGameServerGroup.Builder instanceDefinitions(List<? extends Object> instanceDefinitions)

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

Parameters:

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

Returns:

this

launchTemplate

@Stability(value=Stable)
public CfnGameServerGroup.Builder launchTemplate(CfnGameServerGroup.LaunchTemplateProperty launchTemplate)

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

Parameters:

launchTemplate - `AWS::GameLift::GameServerGroup.LaunchTemplate`. This parameter is required.

Returns:

this

launchTemplate

@Stability(value=Stable)
public CfnGameServerGroup.Builder launchTemplate(IResolvable launchTemplate)

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

Parameters:

launchTemplate - `AWS::GameLift::GameServerGroup.LaunchTemplate`. This parameter is required.

Returns:

this

roleArn

@Stability(value=Stable)
public CfnGameServerGroup.Builder roleArn(String roleArn)

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.

Parameters:

roleArn - 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. This parameter is required.

Returns:

this

autoScalingPolicy

@Stability(value=Stable)
public CfnGameServerGroup.Builder autoScalingPolicy(CfnGameServerGroup.AutoScalingPolicyProperty autoScalingPolicy)

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

Parameters:

autoScalingPolicy - `AWS::GameLift::GameServerGroup.AutoScalingPolicy`. This parameter is required.

Returns:

this

autoScalingPolicy

@Stability(value=Stable)
public CfnGameServerGroup.Builder autoScalingPolicy(IResolvable autoScalingPolicy)

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

Parameters:

autoScalingPolicy - `AWS::GameLift::GameServerGroup.AutoScalingPolicy`. This parameter is required.

Returns:

this

balancingStrategy

@Stability(value=Stable)
public CfnGameServerGroup.Builder balancingStrategy(String balancingStrategy)

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.

Parameters:

balancingStrategy - Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. This parameter is required.

Returns:

this

deleteOption

@Stability(value=Stable)
public CfnGameServerGroup.Builder deleteOption(String deleteOption)

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

Parameters:

deleteOption - `AWS::GameLift::GameServerGroup.DeleteOption`. This parameter is required.

Returns:

this

gameServerProtectionPolicy

@Stability(value=Stable)
public CfnGameServerGroup.Builder gameServerProtectionPolicy(String gameServerProtectionPolicy)

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.

Parameters:

gameServerProtectionPolicy - A flag that indicates whether instances in the game server group are protected from early termination. This parameter is required.

Returns:

this

maxSize

@Stability(value=Stable)
public CfnGameServerGroup.Builder maxSize(Number maxSize)

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

Parameters:

maxSize - `AWS::GameLift::GameServerGroup.MaxSize`. This parameter is required.

Returns:

this

minSize

@Stability(value=Stable)
public CfnGameServerGroup.Builder minSize(Number minSize)

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

Parameters:

minSize - `AWS::GameLift::GameServerGroup.MinSize`. This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnGameServerGroup.Builder tags(List<? extends CfnTag> tags)

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

Parameters:

tags - `AWS::GameLift::GameServerGroup.Tags`. This parameter is required.

Returns:

this

vpcSubnets

@Stability(value=Stable)
public CfnGameServerGroup.Builder vpcSubnets(List<String> vpcSubnets)

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

Parameters:

vpcSubnets - `AWS::GameLift::GameServerGroup.VpcSubnets`. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnGameServerGroup build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnGameServerGroup>