software.amazon.awscdk.services.gamelift

Class CfnFleet.Builder

java.lang.Object

software.amazon.awscdk.services.gamelift.CfnFleet.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnFleet>

Enclosing class:

CfnFleet

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

A fluent builder for CfnFleet.

Method Summary

Modifier and Type	Method and Description
CfnFleet	build()
CfnFleet.Builder	buildId(String buildId) A unique identifier for a build to be deployed on the new fleet.
CfnFleet.Builder	certificateConfiguration(CfnFleet.CertificateConfigurationProperty certificateConfiguration) Indicates whether to generate a TLS/SSL certificate for the new fleet.
CfnFleet.Builder	certificateConfiguration(IResolvable certificateConfiguration) Indicates whether to generate a TLS/SSL certificate for the new fleet.
static CfnFleet.Builder	create(Construct scope, String id)
CfnFleet.Builder	description(String description) A human-readable description of the fleet.
CfnFleet.Builder	desiredEc2Instances(Number desiredEc2Instances) The number of EC2 instances that you want this fleet to host.
CfnFleet.Builder	ec2InboundPermissions(IResolvable ec2InboundPermissions) A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
CfnFleet.Builder	ec2InboundPermissions(List<? extends Object> ec2InboundPermissions) A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
CfnFleet.Builder	ec2InstanceType(String ec2InstanceType) The GameLift-supported Amazon EC2 instance type to use for all fleet instances.
CfnFleet.Builder	fleetType(String fleetType) Indicates whether to use On-Demand or Spot instances for this fleet.
CfnFleet.Builder	instanceRoleArn(String instanceRoleArn) A unique identifier for an IAM role that manages access to your AWS services.
CfnFleet.Builder	locations(IResolvable locations) A set of remote locations to deploy additional instances to and manage as part of the fleet.
CfnFleet.Builder	locations(List<? extends Object> locations) A set of remote locations to deploy additional instances to and manage as part of the fleet.
CfnFleet.Builder	maxSize(Number maxSize) The maximum value that is allowed for the fleet's instance count.
CfnFleet.Builder	metricGroups(List<String> metricGroups) The name of an Amazon CloudWatch metric group.
CfnFleet.Builder	minSize(Number minSize) The minimum value allowed for the fleet's instance count.
CfnFleet.Builder	name(String name) A descriptive label that is associated with a fleet.
CfnFleet.Builder	newGameSessionProtectionPolicy(String newGameSessionProtectionPolicy) A game session protection policy to apply to all game sessions hosted on instances in this fleet.
CfnFleet.Builder	peerVpcAwsAccountId(String peerVpcAwsAccountId) Used when peering your GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC.
CfnFleet.Builder	peerVpcId(String peerVpcId) A unique identifier for a VPC with resources to be accessed by your GameLift fleet.
CfnFleet.Builder	resourceCreationLimitPolicy(CfnFleet.ResourceCreationLimitPolicyProperty resourceCreationLimitPolicy) A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.
CfnFleet.Builder	resourceCreationLimitPolicy(IResolvable resourceCreationLimitPolicy) A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.
CfnFleet.Builder	runtimeConfiguration(CfnFleet.RuntimeConfigurationProperty runtimeConfiguration) Instructions for launching server processes on each instance in the fleet.
CfnFleet.Builder	runtimeConfiguration(IResolvable runtimeConfiguration) Instructions for launching server processes on each instance in the fleet.
CfnFleet.Builder	scriptId(String scriptId) A unique identifier for a Realtime script to be deployed on a new Realtime Servers fleet.

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 CfnFleet.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 CfnFleet.CertificateConfigurationProperty.Builder.

buildId

@Stability(value=Stable)
public CfnFleet.Builder buildId(String buildId)

A unique identifier for a build to be deployed on the new fleet.

If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.

Parameters:

buildId - A unique identifier for a build to be deployed on the new fleet. This parameter is required.

Returns:

this

certificateConfiguration

@Stability(value=Stable)
public CfnFleet.Builder certificateConfiguration(CfnFleet.CertificateConfigurationProperty certificateConfiguration)

Indicates whether to generate a TLS/SSL certificate for the new fleet.

TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not set, certificate generation is disabled. This fleet setting cannot be changed once the fleet is created. Learn more at Securing Client/Server Communication .

Note: This feature requires the AWS Certificate Manager service, which is available in the AWS global partition but not in all other partitions. When working in a partition that does not support this feature, a request for a new fleet with certificate generation results fails with a 4xx unsupported region error.

Parameters:

certificateConfiguration - Indicates whether to generate a TLS/SSL certificate for the new fleet. This parameter is required.

Returns:

this

certificateConfiguration

@Stability(value=Stable)
public CfnFleet.Builder certificateConfiguration(IResolvable certificateConfiguration)

Indicates whether to generate a TLS/SSL certificate for the new fleet.

TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not set, certificate generation is disabled. This fleet setting cannot be changed once the fleet is created. Learn more at Securing Client/Server Communication .

Note: This feature requires the AWS Certificate Manager service, which is available in the AWS global partition but not in all other partitions. When working in a partition that does not support this feature, a request for a new fleet with certificate generation results fails with a 4xx unsupported region error.

Parameters:

certificateConfiguration - Indicates whether to generate a TLS/SSL certificate for the new fleet. This parameter is required.

Returns:

this

description

@Stability(value=Stable)
public CfnFleet.Builder description(String description)

A human-readable description of the fleet.

Parameters:

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

Returns:

this

desiredEc2Instances

@Stability(value=Stable)
public CfnFleet.Builder desiredEc2Instances(Number desiredEc2Instances)

The number of EC2 instances that you want this fleet to host.

When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.

Parameters:

desiredEc2Instances - The number of EC2 instances that you want this fleet to host. This parameter is required.

Returns:

this

ec2InboundPermissions

@Stability(value=Stable)
public CfnFleet.Builder ec2InboundPermissions(IResolvable ec2InboundPermissions)

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

Parameters:

ec2InboundPermissions - 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

ec2InboundPermissions

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

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

Parameters:

ec2InboundPermissions - 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

ec2InstanceType

@Stability(value=Stable)
public CfnFleet.Builder ec2InstanceType(String ec2InstanceType)

The GameLift-supported Amazon EC2 instance type to use for all fleet instances.

Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions of Amazon EC2 instance types.

Parameters:

ec2InstanceType - The GameLift-supported Amazon EC2 instance type to use for all fleet instances. This parameter is required.

Returns:

this

fleetType

@Stability(value=Stable)
public CfnFleet.Builder fleetType(String fleetType)

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

By default, this property is set to ON_DEMAND . Learn more about when to use On-Demand versus Spot Instances . This property cannot be changed after the fleet is created.

Parameters:

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

Returns:

this

instanceRoleArn

@Stability(value=Stable)
public CfnFleet.Builder instanceRoleArn(String instanceRoleArn)

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

With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the IAM dashboard in the AWS Management Console . Learn more about using on-box credentials for your game servers at Access external resources from a game server . This property cannot be changed after the fleet is created.

Parameters:

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

Returns:

this

locations

@Stability(value=Stable)
public CfnFleet.Builder locations(IResolvable locations)

A set of remote locations to deploy additional instances to and manage as part of the fleet.

This parameter can only be used when creating fleets in AWS Regions that support multiple locations. You can add any GameLift-supported AWS Region as a remote location, in the form of an AWS Region code such as us-west-2 . To create a fleet with instances in the home Region only, omit this parameter.

Parameters:

locations - A set of remote locations to deploy additional instances to and manage as part of the fleet. This parameter is required.

Returns:

this

locations

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

A set of remote locations to deploy additional instances to and manage as part of the fleet.

This parameter can only be used when creating fleets in AWS Regions that support multiple locations. You can add any GameLift-supported AWS Region as a remote location, in the form of an AWS Region code such as us-west-2 . To create a fleet with instances in the home Region only, omit this parameter.

Parameters:

locations - A set of remote locations to deploy additional instances to and manage as part of the fleet. This parameter is required.

Returns:

this

maxSize

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

The maximum value that is allowed for the fleet's instance count.

When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.

Parameters:

maxSize - The maximum value that is allowed for the fleet's instance count. This parameter is required.

Returns:

this

metricGroups

@Stability(value=Stable)
public CfnFleet.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

minSize

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

The minimum value allowed for the fleet's instance count.

When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.

Parameters:

minSize - The minimum value allowed for the fleet's instance count. This parameter is required.

Returns:

this

name

@Stability(value=Stable)
public CfnFleet.Builder name(String name)

A descriptive label that is associated with a fleet.

Fleet names do not need to be unique.

Parameters:

name - A descriptive label that is associated with a fleet. This parameter is required.

Returns:

this

newGameSessionProtectionPolicy

@Stability(value=Stable)
public CfnFleet.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

peerVpcAwsAccountId

@Stability(value=Stable)
public CfnFleet.Builder peerVpcAwsAccountId(String peerVpcAwsAccountId)

Used when peering your GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC.

You can find your account ID in the AWS Management Console under account settings.

Parameters:

peerVpcAwsAccountId - Used when peering your GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC. This parameter is required.

Returns:

this

peerVpcId

@Stability(value=Stable)
public CfnFleet.Builder peerVpcId(String peerVpcId)

A unique identifier for a VPC with resources to be accessed by your GameLift fleet.

The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console . Learn more about VPC peering in VPC Peering with GameLift Fleets .

Parameters:

peerVpcId - A unique identifier for a VPC with resources to be accessed by your GameLift fleet. This parameter is required.

Returns:

this

resourceCreationLimitPolicy

@Stability(value=Stable)
public CfnFleet.Builder resourceCreationLimitPolicy(CfnFleet.ResourceCreationLimitPolicyProperty resourceCreationLimitPolicy)

A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.

Parameters:

resourceCreationLimitPolicy - A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time. This parameter is required.

Returns:

this

resourceCreationLimitPolicy

@Stability(value=Stable)
public CfnFleet.Builder resourceCreationLimitPolicy(IResolvable resourceCreationLimitPolicy)

A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.

Parameters:

resourceCreationLimitPolicy - A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time. This parameter is required.

Returns:

this

runtimeConfiguration

@Stability(value=Stable)
public CfnFleet.Builder runtimeConfiguration(CfnFleet.RuntimeConfigurationProperty runtimeConfiguration)

Instructions for launching server processes on each instance in the fleet.

Server processes run either a custom game build executable or a Realtime script. The runtime configuration defines the server executables or launch script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails with an invalid request exception.

This parameter is required unless the parameters ServerLaunchPath and ServerLaunchParameters are defined. Runtime configuration has replaced these parameters, but fleets that use them will continue to work.

Parameters:

runtimeConfiguration - Instructions for launching server processes on each instance in the fleet. This parameter is required.

Returns:

this

runtimeConfiguration

@Stability(value=Stable)
public CfnFleet.Builder runtimeConfiguration(IResolvable runtimeConfiguration)

Instructions for launching server processes on each instance in the fleet.

Server processes run either a custom game build executable or a Realtime script. The runtime configuration defines the server executables or launch script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails with an invalid request exception.

This parameter is required unless the parameters ServerLaunchPath and ServerLaunchParameters are defined. Runtime configuration has replaced these parameters, but fleets that use them will continue to work.

Parameters:

runtimeConfiguration - Instructions for launching server processes on each instance in the fleet. This parameter is required.

Returns:

this

scriptId

@Stability(value=Stable)
public CfnFleet.Builder scriptId(String scriptId)

A unique identifier for a Realtime script to be deployed on a new Realtime Servers fleet.

The script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created.

Note: It is not currently possible to use the !Ref command to reference a script created with a CloudFormation template for the fleet property ScriptId . Instead, use Fn::GetAtt Script.Arn or Fn::GetAtt Script.Id to retrieve either of these properties as input for ScriptId . Alternatively, enter a ScriptId string manually.

Parameters:

scriptId - A unique identifier for a Realtime script to be deployed on a new Realtime Servers fleet. This parameter is required.

Returns:

this

build

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

Specified by:

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