Package software.amazon.awscdk.services.gamelift

Class CfnContainerFleet.Builder

java.lang.Object

software.amazon.awscdk.services.gamelift.CfnContainerFleet.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnContainerFleet>

Enclosing class:

CfnContainerFleet

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

A fluent builder for CfnContainerFleet.

Method Summary

Modifier and Type	Method	Description
CfnContainerFleet.Builder	billingType(String billingType)	Indicates whether to use On-Demand instances or Spot instances for this fleet.
CfnContainerFleet	build()
static CfnContainerFleet.Builder	create(software.constructs.Construct scope, String id)
CfnContainerFleet.Builder	deploymentConfiguration(IResolvable deploymentConfiguration)	Provides details about how to drain old tasks and replace them with new updated tasks.
CfnContainerFleet.Builder	deploymentConfiguration(CfnContainerFleet.DeploymentConfigurationProperty deploymentConfiguration)	Provides details about how to drain old tasks and replace them with new updated tasks.
CfnContainerFleet.Builder	description(String description)	A human-readable description of a fleet.
CfnContainerFleet.Builder	fleetRoleArn(String fleetRoleArn)	A unique identifier for an AWS IAM role that manages access to your AWS services.
CfnContainerFleet.Builder	gameServerContainerGroupDefinitionName(String gameServerContainerGroupDefinitionName)	The name of the container group definition that will be created per game server.
CfnContainerFleet.Builder	gameServerContainerGroupsPerInstance(Number gameServerContainerGroupsPerInstance)	The number of desired game server container groups per instance, a number between 1-5000.
CfnContainerFleet.Builder	gameSessionCreationLimitPolicy(IResolvable gameSessionCreationLimitPolicy)	A policy that limits the number of game sessions a player can create on the same fleet.
CfnContainerFleet.Builder	gameSessionCreationLimitPolicy(CfnContainerFleet.GameSessionCreationLimitPolicyProperty gameSessionCreationLimitPolicy)	A policy that limits the number of game sessions a player can create on the same fleet.
CfnContainerFleet.Builder	instanceConnectionPortRange(IResolvable instanceConnectionPortRange)	Defines the range of ports on the instance that allow inbound traffic to connect with containers in a fleet.
CfnContainerFleet.Builder	instanceConnectionPortRange(CfnContainerFleet.ConnectionPortRangeProperty instanceConnectionPortRange)	Defines the range of ports on the instance that allow inbound traffic to connect with containers in a fleet.
CfnContainerFleet.Builder	instanceInboundPermissions(List<? extends Object> instanceInboundPermissions)	A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
CfnContainerFleet.Builder	instanceInboundPermissions(IResolvable instanceInboundPermissions)	A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
CfnContainerFleet.Builder	instanceType(String instanceType)	The name of an EC2 instance type that is supported in Amazon GameLift.
CfnContainerFleet.Builder	locations(List<? extends Object> locations)
CfnContainerFleet.Builder	locations(IResolvable locations)
CfnContainerFleet.Builder	logConfiguration(IResolvable logConfiguration)	A policy the location and provider of logs from the fleet.
CfnContainerFleet.Builder	logConfiguration(CfnContainerFleet.LogConfigurationProperty logConfiguration)	A policy the location and provider of logs from the fleet.
CfnContainerFleet.Builder	metricGroups(List<String> metricGroups)	The name of an Amazon CloudWatch metric group.
CfnContainerFleet.Builder	newGameSessionProtectionPolicy(String newGameSessionProtectionPolicy)	A game session protection policy to apply to all game sessions hosted on instances in this fleet.
CfnContainerFleet.Builder	perInstanceContainerGroupDefinitionName(String perInstanceContainerGroupDefinitionName)	The name of the container group definition that will be created per instance.
CfnContainerFleet.Builder	scalingPolicies(List<? extends Object> scalingPolicies)	A list of rules that control how a fleet is scaled.
CfnContainerFleet.Builder	scalingPolicies(IResolvable scalingPolicies)	A list of rules that control how a fleet is scaled.
CfnContainerFleet.Builder	tags(List<? extends CfnTag> tags)	An array of key-value pairs to apply to this resource.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnContainerFleet.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnContainerFleet.Builder.

fleetRoleArn

@Stability(Stable)
public CfnContainerFleet.Builder fleetRoleArn(String fleetRoleArn)

A unique identifier for an AWS IAM role that manages access to your AWS services.

Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console.

Parameters:

fleetRoleArn - A unique identifier for an AWS IAM role that manages access to your AWS services. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-fleetrolearn

billingType

@Stability(Stable)
public CfnContainerFleet.Builder billingType(String billingType)

Indicates whether to use On-Demand instances or Spot instances for this fleet.

If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet.

Parameters:

billingType - Indicates whether to use On-Demand instances or Spot instances for this fleet. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-billingtype

deploymentConfiguration

@Stability(Stable)
public CfnContainerFleet.Builder deploymentConfiguration(IResolvable deploymentConfiguration)

Provides details about how to drain old tasks and replace them with new updated tasks.

Parameters:

deploymentConfiguration - Provides details about how to drain old tasks and replace them with new updated tasks. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-deploymentconfiguration

deploymentConfiguration

@Stability(Stable)
public CfnContainerFleet.Builder deploymentConfiguration(CfnContainerFleet.DeploymentConfigurationProperty deploymentConfiguration)

Provides details about how to drain old tasks and replace them with new updated tasks.

Parameters:

deploymentConfiguration - Provides details about how to drain old tasks and replace them with new updated tasks. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-deploymentconfiguration

description

@Stability(Stable)
public CfnContainerFleet.Builder description(String description)

A human-readable description of a fleet.

Parameters:

description - A human-readable description of a fleet. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-description

gameServerContainerGroupDefinitionName

@Stability(Stable)
public CfnContainerFleet.Builder gameServerContainerGroupDefinitionName(String gameServerContainerGroupDefinitionName)

The name of the container group definition that will be created per game server.

You must specify GAME_SERVER container group. You have the option to also specify one PER_INSTANCE container group.

Parameters:

gameServerContainerGroupDefinitionName - The name of the container group definition that will be created per game server. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-gameservercontainergroupdefinitionname

gameServerContainerGroupsPerInstance

@Stability(Stable)
public CfnContainerFleet.Builder gameServerContainerGroupsPerInstance(Number gameServerContainerGroupsPerInstance)

The number of desired game server container groups per instance, a number between 1-5000.

Parameters:

gameServerContainerGroupsPerInstance - The number of desired game server container groups per instance, a number between 1-5000. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-gameservercontainergroupsperinstance

gameSessionCreationLimitPolicy

@Stability(Stable)
public CfnContainerFleet.Builder gameSessionCreationLimitPolicy(IResolvable gameSessionCreationLimitPolicy)

A policy that limits the number of game sessions a player can create on the same fleet.

This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: "An individual player can create a maximum number of new game sessions within a specified time period".

The policy is evaluated when a player tries to create a new game session. For example, assume you have a policy of 10 new game sessions and a time period of 60 minutes. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than 10 game sessions in the past 60 minutes.

Parameters:

gameSessionCreationLimitPolicy - A policy that limits the number of game sessions a player can create on the same fleet. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-gamesessioncreationlimitpolicy

gameSessionCreationLimitPolicy

@Stability(Stable)
public CfnContainerFleet.Builder gameSessionCreationLimitPolicy(CfnContainerFleet.GameSessionCreationLimitPolicyProperty gameSessionCreationLimitPolicy)

A policy that limits the number of game sessions a player can create on the same fleet.

This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: "An individual player can create a maximum number of new game sessions within a specified time period".

The policy is evaluated when a player tries to create a new game session. For example, assume you have a policy of 10 new game sessions and a time period of 60 minutes. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than 10 game sessions in the past 60 minutes.

Parameters:

gameSessionCreationLimitPolicy - A policy that limits the number of game sessions a player can create on the same fleet. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-gamesessioncreationlimitpolicy

instanceConnectionPortRange

@Stability(Stable)
public CfnContainerFleet.Builder instanceConnectionPortRange(IResolvable instanceConnectionPortRange)

Defines the range of ports on the instance that allow inbound traffic to connect with containers in a fleet.

Parameters:

instanceConnectionPortRange - Defines the range of ports on the instance that allow inbound traffic to connect with containers in a fleet. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-instanceconnectionportrange

instanceConnectionPortRange

@Stability(Stable)
public CfnContainerFleet.Builder instanceConnectionPortRange(CfnContainerFleet.ConnectionPortRangeProperty instanceConnectionPortRange)

Defines the range of ports on the instance that allow inbound traffic to connect with containers in a fleet.

Parameters:

instanceConnectionPortRange - Defines the range of ports on the instance that allow inbound traffic to connect with containers in a fleet. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-instanceconnectionportrange

instanceInboundPermissions

@Stability(Stable)
public CfnContainerFleet.Builder instanceInboundPermissions(IResolvable instanceInboundPermissions)

A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.

Parameters:

instanceInboundPermissions - A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-instanceinboundpermissions

instanceInboundPermissions

@Stability(Stable)
public CfnContainerFleet.Builder instanceInboundPermissions(List<? extends Object> instanceInboundPermissions)

A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.

Parameters:

instanceInboundPermissions - A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-instanceinboundpermissions

instanceType

@Stability(Stable)
public CfnContainerFleet.Builder instanceType(String instanceType)

The name of an EC2 instance type that is supported in Amazon GameLift.

A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

Parameters:

instanceType - The name of an EC2 instance type that is supported in Amazon GameLift. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-instancetype

locations

@Stability(Stable)
public CfnContainerFleet.Builder locations(IResolvable locations)

Parameters:

locations - This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-locations

locations

@Stability(Stable)
public CfnContainerFleet.Builder locations(List<? extends Object> locations)

Parameters:

locations - This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-locations

logConfiguration

@Stability(Stable)
public CfnContainerFleet.Builder logConfiguration(IResolvable logConfiguration)

A policy the location and provider of logs from the fleet.

Parameters:

logConfiguration - A policy the location and provider of logs from the fleet. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-logconfiguration

logConfiguration

@Stability(Stable)
public CfnContainerFleet.Builder logConfiguration(CfnContainerFleet.LogConfigurationProperty logConfiguration)

A policy the location and provider of logs from the fleet.

Parameters:

logConfiguration - A policy the location and provider of logs from the fleet. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-logconfiguration

metricGroups

@Stability(Stable)
public CfnContainerFleet.Builder metricGroups(List<String> metricGroups)

The name of an Amazon CloudWatch metric group.

A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string.

Parameters:

metricGroups - The name of an Amazon CloudWatch metric group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-metricgroups

newGameSessionProtectionPolicy

@Stability(Stable)
public CfnContainerFleet.Builder newGameSessionProtectionPolicy(String newGameSessionProtectionPolicy)

A game session protection policy to apply to all game sessions hosted on instances in this fleet.

When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions.

Parameters:

newGameSessionProtectionPolicy - A game session protection policy to apply to all game sessions hosted on instances in this fleet. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-newgamesessionprotectionpolicy

perInstanceContainerGroupDefinitionName

@Stability(Stable)
public CfnContainerFleet.Builder perInstanceContainerGroupDefinitionName(String perInstanceContainerGroupDefinitionName)

The name of the container group definition that will be created per instance.

This field is optional if you specify GameServerContainerGroupDefinitionName.

Parameters:

perInstanceContainerGroupDefinitionName - The name of the container group definition that will be created per instance. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-perinstancecontainergroupdefinitionname

scalingPolicies

@Stability(Stable)
public CfnContainerFleet.Builder scalingPolicies(IResolvable scalingPolicies)

A list of rules that control how a fleet is scaled.

Parameters:

scalingPolicies - A list of rules that control how a fleet is scaled. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-scalingpolicies

scalingPolicies

@Stability(Stable)
public CfnContainerFleet.Builder scalingPolicies(List<? extends Object> scalingPolicies)

A list of rules that control how a fleet is scaled.

Parameters:

scalingPolicies - A list of rules that control how a fleet is scaled. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-scalingpolicies

tags

@Stability(Stable)
public CfnContainerFleet.Builder tags(List<? extends CfnTag> tags)

An array of key-value pairs to apply to this resource.

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-tags

build

@Stability(Stable)
public CfnContainerFleet build()

Specified by:

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

Returns:

a newly built instance of CfnContainerFleet.