software.amazon.awscdk.services.gamelift

Class CfnGameServerGroupProps.Builder

java.lang.Object

software.amazon.awscdk.services.gamelift.CfnGameServerGroupProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnGameServerGroupProps>

Enclosing interface:

CfnGameServerGroupProps

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

A builder for CfnGameServerGroupProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnGameServerGroupProps.Builder	autoScalingPolicy(CfnGameServerGroup.AutoScalingPolicyProperty autoScalingPolicy) Sets the value of CfnGameServerGroupProps.getAutoScalingPolicy()
CfnGameServerGroupProps.Builder	autoScalingPolicy(IResolvable autoScalingPolicy) Sets the value of CfnGameServerGroupProps.getAutoScalingPolicy()
CfnGameServerGroupProps.Builder	balancingStrategy(String balancingStrategy) Sets the value of CfnGameServerGroupProps.getBalancingStrategy()
CfnGameServerGroupProps	build() Builds the configured instance.
CfnGameServerGroupProps.Builder	deleteOption(String deleteOption) Sets the value of CfnGameServerGroupProps.getDeleteOption()
CfnGameServerGroupProps.Builder	gameServerGroupName(String gameServerGroupName) Sets the value of CfnGameServerGroupProps.getGameServerGroupName()
CfnGameServerGroupProps.Builder	gameServerProtectionPolicy(String gameServerProtectionPolicy) Sets the value of CfnGameServerGroupProps.getGameServerProtectionPolicy()
CfnGameServerGroupProps.Builder	instanceDefinitions(IResolvable instanceDefinitions) Sets the value of CfnGameServerGroupProps.getInstanceDefinitions()
CfnGameServerGroupProps.Builder	instanceDefinitions(List<? extends Object> instanceDefinitions) Sets the value of CfnGameServerGroupProps.getInstanceDefinitions()
CfnGameServerGroupProps.Builder	launchTemplate(CfnGameServerGroup.LaunchTemplateProperty launchTemplate) Sets the value of CfnGameServerGroupProps.getLaunchTemplate()
CfnGameServerGroupProps.Builder	launchTemplate(IResolvable launchTemplate) Sets the value of CfnGameServerGroupProps.getLaunchTemplate()
CfnGameServerGroupProps.Builder	maxSize(Number maxSize) Sets the value of CfnGameServerGroupProps.getMaxSize()
CfnGameServerGroupProps.Builder	minSize(Number minSize) Sets the value of CfnGameServerGroupProps.getMinSize()
CfnGameServerGroupProps.Builder	roleArn(String roleArn) Sets the value of CfnGameServerGroupProps.getRoleArn()
CfnGameServerGroupProps.Builder	tags(List<? extends CfnTag> tags) Sets the value of CfnGameServerGroupProps.getTags()
CfnGameServerGroupProps.Builder	vpcSubnets(List<String> vpcSubnets) Sets the value of CfnGameServerGroupProps.getVpcSubnets()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

gameServerGroupName

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

Sets the value of CfnGameServerGroupProps.getGameServerGroupName()

Parameters:

gameServerGroupName - A developer-defined identifier for the game server group. This parameter is required. The name is unique for each Region in each AWS account.

Returns:

this

instanceDefinitions

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

Sets the value of CfnGameServerGroupProps.getInstanceDefinitions()

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 CfnGameServerGroupProps.Builder instanceDefinitions(List<? extends Object> instanceDefinitions)

Sets the value of CfnGameServerGroupProps.getInstanceDefinitions()

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 CfnGameServerGroupProps.Builder launchTemplate(CfnGameServerGroup.LaunchTemplateProperty launchTemplate)

Sets the value of CfnGameServerGroupProps.getLaunchTemplate()

Parameters:

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

Returns:

this

launchTemplate

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

Sets the value of CfnGameServerGroupProps.getLaunchTemplate()

Parameters:

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

Returns:

this

roleArn

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

Sets the value of CfnGameServerGroupProps.getRoleArn()

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 CfnGameServerGroupProps.Builder autoScalingPolicy(CfnGameServerGroup.AutoScalingPolicyProperty autoScalingPolicy)

Sets the value of CfnGameServerGroupProps.getAutoScalingPolicy()

Parameters:

autoScalingPolicy - `AWS::GameLift::GameServerGroup.AutoScalingPolicy`.

Returns:

this

autoScalingPolicy

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

Sets the value of CfnGameServerGroupProps.getAutoScalingPolicy()

Parameters:

autoScalingPolicy - `AWS::GameLift::GameServerGroup.AutoScalingPolicy`.

Returns:

this

balancingStrategy

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

Sets the value of CfnGameServerGroupProps.getBalancingStrategy()

Parameters:

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.

Returns:

this

deleteOption

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

Sets the value of CfnGameServerGroupProps.getDeleteOption()

Parameters:

deleteOption - `AWS::GameLift::GameServerGroup.DeleteOption`.

Returns:

this

gameServerProtectionPolicy

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

Sets the value of CfnGameServerGroupProps.getGameServerProtectionPolicy()

Parameters:

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.

Returns:

this

maxSize

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

Sets the value of CfnGameServerGroupProps.getMaxSize()

Parameters:

maxSize - `AWS::GameLift::GameServerGroup.MaxSize`.

Returns:

this

minSize

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

Sets the value of CfnGameServerGroupProps.getMinSize()

Parameters:

minSize - `AWS::GameLift::GameServerGroup.MinSize`.

Returns:

this

tags

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

Sets the value of CfnGameServerGroupProps.getTags()

Parameters:

tags - `AWS::GameLift::GameServerGroup.Tags`.

Returns:

this

vpcSubnets

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

Sets the value of CfnGameServerGroupProps.getVpcSubnets()

Parameters:

vpcSubnets - `AWS::GameLift::GameServerGroup.VpcSubnets`.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnGameServerGroupProps

Throws:

NullPointerException - if any required attribute was not provided