software.amazon.awscdk.services.gamelift

Class CfnFleetProps.Builder

java.lang.Object

software.amazon.awscdk.services.gamelift.CfnFleetProps.Builder

Enclosing interface:

CfnFleetProps

public static final class CfnFleetProps.Builder
extends java.lang.Object

A builder for CfnFleetProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnFleetProps.Builder	anywhereConfiguration(CfnFleet.AnywhereConfigurationProperty anywhereConfiguration) Sets the value of CfnFleetProps.getAnywhereConfiguration()
CfnFleetProps.Builder	anywhereConfiguration(IResolvable anywhereConfiguration) Sets the value of CfnFleetProps.getAnywhereConfiguration()
CfnFleetProps	build() Builds the configured instance.
CfnFleetProps.Builder	buildId(java.lang.String buildId) Sets the value of CfnFleetProps.getBuildId()
CfnFleetProps.Builder	certificateConfiguration(CfnFleet.CertificateConfigurationProperty certificateConfiguration) Sets the value of CfnFleetProps.getCertificateConfiguration()
CfnFleetProps.Builder	certificateConfiguration(IResolvable certificateConfiguration) Sets the value of CfnFleetProps.getCertificateConfiguration()
CfnFleetProps.Builder	computeType(java.lang.String computeType) Sets the value of CfnFleetProps.getComputeType()
CfnFleetProps.Builder	description(java.lang.String description) Sets the value of CfnFleetProps.getDescription()
CfnFleetProps.Builder	desiredEc2Instances(java.lang.Number desiredEc2Instances) Sets the value of CfnFleetProps.getDesiredEc2Instances()
CfnFleetProps.Builder	ec2InboundPermissions(IResolvable ec2InboundPermissions) Sets the value of CfnFleetProps.getEc2InboundPermissions()
CfnFleetProps.Builder	ec2InboundPermissions(java.util.List<? extends java.lang.Object> ec2InboundPermissions) Sets the value of CfnFleetProps.getEc2InboundPermissions()
CfnFleetProps.Builder	ec2InstanceType(java.lang.String ec2InstanceType) Sets the value of CfnFleetProps.getEc2InstanceType()
CfnFleetProps.Builder	fleetType(java.lang.String fleetType) Sets the value of CfnFleetProps.getFleetType()
CfnFleetProps.Builder	instanceRoleArn(java.lang.String instanceRoleArn) Sets the value of CfnFleetProps.getInstanceRoleArn()
CfnFleetProps.Builder	locations(IResolvable locations) Sets the value of CfnFleetProps.getLocations()
CfnFleetProps.Builder	locations(java.util.List<? extends java.lang.Object> locations) Sets the value of CfnFleetProps.getLocations()
CfnFleetProps.Builder	maxSize(java.lang.Number maxSize) Sets the value of CfnFleetProps.getMaxSize()
CfnFleetProps.Builder	metricGroups(java.util.List<java.lang.String> metricGroups) Sets the value of CfnFleetProps.getMetricGroups()
CfnFleetProps.Builder	minSize(java.lang.Number minSize) Sets the value of CfnFleetProps.getMinSize()
CfnFleetProps.Builder	name(java.lang.String name) Sets the value of CfnFleetProps.getName()
CfnFleetProps.Builder	newGameSessionProtectionPolicy(java.lang.String newGameSessionProtectionPolicy) Sets the value of CfnFleetProps.getNewGameSessionProtectionPolicy()
CfnFleetProps.Builder	peerVpcAwsAccountId(java.lang.String peerVpcAwsAccountId) Sets the value of CfnFleetProps.getPeerVpcAwsAccountId()
CfnFleetProps.Builder	peerVpcId(java.lang.String peerVpcId) Sets the value of CfnFleetProps.getPeerVpcId()
CfnFleetProps.Builder	resourceCreationLimitPolicy(CfnFleet.ResourceCreationLimitPolicyProperty resourceCreationLimitPolicy) Sets the value of CfnFleetProps.getResourceCreationLimitPolicy()
CfnFleetProps.Builder	resourceCreationLimitPolicy(IResolvable resourceCreationLimitPolicy) Sets the value of CfnFleetProps.getResourceCreationLimitPolicy()
CfnFleetProps.Builder	runtimeConfiguration(CfnFleet.RuntimeConfigurationProperty runtimeConfiguration) Sets the value of CfnFleetProps.getRuntimeConfiguration()
CfnFleetProps.Builder	runtimeConfiguration(IResolvable runtimeConfiguration) Sets the value of CfnFleetProps.getRuntimeConfiguration()
CfnFleetProps.Builder	scriptId(java.lang.String scriptId) Sets the value of CfnFleetProps.getScriptId()

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

name

public CfnFleetProps.Builder name(java.lang.String name)

Sets the value of CfnFleetProps.getName()

Parameters:

name - A descriptive label that is associated with a fleet. This parameter is required. Fleet names do not need to be unique.

Returns:

this

anywhereConfiguration

public CfnFleetProps.Builder anywhereConfiguration(IResolvable anywhereConfiguration)

Sets the value of CfnFleetProps.getAnywhereConfiguration()

Parameters:

anywhereConfiguration - `AWS::GameLift::Fleet.AnywhereConfiguration`.

Returns:

this

anywhereConfiguration

public CfnFleetProps.Builder anywhereConfiguration(CfnFleet.AnywhereConfigurationProperty anywhereConfiguration)

Sets the value of CfnFleetProps.getAnywhereConfiguration()

Parameters:

anywhereConfiguration - `AWS::GameLift::Fleet.AnywhereConfiguration`.

Returns:

this

buildId

public CfnFleetProps.Builder buildId(java.lang.String buildId)

Sets the value of CfnFleetProps.getBuildId()

Parameters:

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.

Returns:

this

certificateConfiguration

public CfnFleetProps.Builder certificateConfiguration(IResolvable certificateConfiguration)

Sets the value of CfnFleetProps.getCertificateConfiguration()

Parameters:

certificateConfiguration - Prompts GameLift to generate a TLS/SSL certificate for the fleet. GameLift uses the certificates to encrypt traffic between game clients and the game servers running on GameLift. By default, the CertificateConfiguration is DISABLED . You can't change this property after you create the fleet.

AWS Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition.

ACM isn't available in all AWS regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see Supported Regions in the AWS Certificate Manager User Guide .

Returns:

this

certificateConfiguration

public CfnFleetProps.Builder certificateConfiguration(CfnFleet.CertificateConfigurationProperty certificateConfiguration)

Sets the value of CfnFleetProps.getCertificateConfiguration()

Parameters:

certificateConfiguration - Prompts GameLift to generate a TLS/SSL certificate for the fleet. GameLift uses the certificates to encrypt traffic between game clients and the game servers running on GameLift. By default, the CertificateConfiguration is DISABLED . You can't change this property after you create the fleet.

AWS Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition.

ACM isn't available in all AWS regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see Supported Regions in the AWS Certificate Manager User Guide .

Returns:

this

computeType

public CfnFleetProps.Builder computeType(java.lang.String computeType)

Sets the value of CfnFleetProps.getComputeType()

Parameters:

computeType - The type of compute resource used to host your game servers. You can use your own compute resources with GameLift Anywhere or use Amazon EC2 instances with managed GameLift.

Returns:

this

description

public CfnFleetProps.Builder description(java.lang.String description)

Sets the value of CfnFleetProps.getDescription()

Parameters:

description - A description for the fleet.

Returns:

this

desiredEc2Instances

public CfnFleetProps.Builder desiredEc2Instances(java.lang.Number desiredEc2Instances)

Sets the value of CfnFleetProps.getDesiredEc2Instances()

Parameters:

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.

Returns:

this

ec2InboundPermissions

public CfnFleetProps.Builder ec2InboundPermissions(IResolvable ec2InboundPermissions)

Sets the value of CfnFleetProps.getEc2InboundPermissions()

Parameters:

ec2InboundPermissions - The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet. If the fleet is hosting a custom game build, this property must be set before players can connect to game sessions. For Realtime Servers fleets, GameLift automatically sets TCP and UDP ranges.

Returns:

this

ec2InboundPermissions

public CfnFleetProps.Builder ec2InboundPermissions(java.util.List<? extends java.lang.Object> ec2InboundPermissions)

Sets the value of CfnFleetProps.getEc2InboundPermissions()

Parameters:

ec2InboundPermissions - The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet. If the fleet is hosting a custom game build, this property must be set before players can connect to game sessions. For Realtime Servers fleets, GameLift automatically sets TCP and UDP ranges.

Returns:

this

ec2InstanceType

public CfnFleetProps.Builder ec2InstanceType(java.lang.String ec2InstanceType)

Sets the value of CfnFleetProps.getEc2InstanceType()

Parameters:

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.

Returns:

this

fleetType

public CfnFleetProps.Builder fleetType(java.lang.String fleetType)

Sets the value of CfnFleetProps.getFleetType()

Parameters:

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.

Returns:

this

instanceRoleArn

public CfnFleetProps.Builder instanceRoleArn(java.lang.String instanceRoleArn)

Sets the value of CfnFleetProps.getInstanceRoleArn()

Parameters:

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.

Returns:

this

locations

public CfnFleetProps.Builder locations(IResolvable locations)

Sets the value of CfnFleetProps.getLocations()

Parameters:

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.

Returns:

this

locations

public CfnFleetProps.Builder locations(java.util.List<? extends java.lang.Object> locations)

Sets the value of CfnFleetProps.getLocations()

Parameters:

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.

Returns:

this

maxSize

public CfnFleetProps.Builder maxSize(java.lang.Number maxSize)

Sets the value of CfnFleetProps.getMaxSize()

Parameters:

maxSize - The maximum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 1.

Returns:

this

metricGroups

public CfnFleetProps.Builder metricGroups(java.util.List<java.lang.String> metricGroups)

Sets the value of CfnFleetProps.getMetricGroups()

Parameters:

metricGroups - The name of an AWS CloudWatch metric group to add this fleet to. A metric group is used to aggregate the metrics for multiple fleets. You can specify an existing metric group name or set a new name to create a new metric group. A fleet can be included in only one metric group at a time.

Returns:

this

minSize

public CfnFleetProps.Builder minSize(java.lang.Number minSize)

Sets the value of CfnFleetProps.getMinSize()

Parameters:

minSize - The minimum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 0.

Returns:

this

newGameSessionProtectionPolicy

public CfnFleetProps.Builder newGameSessionProtectionPolicy(java.lang.String newGameSessionProtectionPolicy)

Sets the value of CfnFleetProps.getNewGameSessionProtectionPolicy()

Parameters:

newGameSessionProtectionPolicy - The status of termination protection for active game sessions on the fleet. By default, this property is set to NoProtection .

• NoProtection - Game sessions can be terminated during active gameplay as a result of a scale-down event.
• FullProtection - Game sessions in ACTIVE status cannot be terminated during a scale-down event.

Returns:

this

peerVpcAwsAccountId

public CfnFleetProps.Builder peerVpcAwsAccountId(java.lang.String peerVpcAwsAccountId)

Sets the value of CfnFleetProps.getPeerVpcAwsAccountId()

Parameters:

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.

Returns:

this

peerVpcId

public CfnFleetProps.Builder peerVpcId(java.lang.String peerVpcId)

Sets the value of CfnFleetProps.getPeerVpcId()

Parameters:

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 .

Returns:

this

resourceCreationLimitPolicy

public CfnFleetProps.Builder resourceCreationLimitPolicy(IResolvable resourceCreationLimitPolicy)

Sets the value of CfnFleetProps.getResourceCreationLimitPolicy()

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.

Returns:

this

resourceCreationLimitPolicy

public CfnFleetProps.Builder resourceCreationLimitPolicy(CfnFleet.ResourceCreationLimitPolicyProperty resourceCreationLimitPolicy)

Sets the value of CfnFleetProps.getResourceCreationLimitPolicy()

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.

Returns:

this

runtimeConfiguration

public CfnFleetProps.Builder runtimeConfiguration(IResolvable runtimeConfiguration)

Sets the value of CfnFleetProps.getRuntimeConfiguration()

Parameters:

runtimeConfiguration - Instructions for how to launch and maintain server processes on instances in the fleet. The runtime configuration defines one or more server process configurations, each identifying a build executable or Realtime script file and the number of processes of that type to run concurrently.

The RuntimeConfiguration parameter is required unless the fleet is being configured using the older parameters ServerLaunchPath and ServerLaunchParameters , which are still supported for backward compatibility.

Returns:

this

runtimeConfiguration

public CfnFleetProps.Builder runtimeConfiguration(CfnFleet.RuntimeConfigurationProperty runtimeConfiguration)

Sets the value of CfnFleetProps.getRuntimeConfiguration()

Parameters:

runtimeConfiguration - Instructions for how to launch and maintain server processes on instances in the fleet. The runtime configuration defines one or more server process configurations, each identifying a build executable or Realtime script file and the number of processes of that type to run concurrently.

The RuntimeConfiguration parameter is required unless the fleet is being configured using the older parameters ServerLaunchPath and ServerLaunchParameters , which are still supported for backward compatibility.

Returns:

this

scriptId

public CfnFleetProps.Builder scriptId(java.lang.String scriptId)

Sets the value of CfnFleetProps.getScriptId()

Parameters:

scriptId - The unique identifier for a Realtime configuration script to be deployed on fleet instances. You can use either the script ID or ARN. Scripts must be uploaded to GameLift prior to creating the fleet. This fleet property cannot be changed later.

You can't 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.

Returns:

this

build

public CfnFleetProps build()

Builds the configured instance.

Returns:

a new instance of CfnFleetProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided