software.amazon.awscdk.services.gamelift

Interface CfnFleetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFleetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:09.327Z")
 @Stability(value=Stable)
public interface CfnFleetProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnFleet`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.gamelift.*;
 CfnFleetProps cfnFleetProps = CfnFleetProps.builder()
         .buildId("buildId")
         .certificateConfiguration(CertificateConfigurationProperty.builder()
                 .certificateType("certificateType")
                 .build())
         .description("description")
         .desiredEc2Instances(123)
         .ec2InboundPermissions(List.of(IpPermissionProperty.builder()
                 .fromPort(123)
                 .ipRange("ipRange")
                 .protocol("protocol")
                 .toPort(123)
                 .build()))
         .ec2InstanceType("ec2InstanceType")
         .fleetType("fleetType")
         .instanceRoleArn("instanceRoleArn")
         .locations(List.of(LocationConfigurationProperty.builder()
                 .location("location")
                 // the properties below are optional
                 .locationCapacity(LocationCapacityProperty.builder()
                         .desiredEc2Instances(123)
                         .maxSize(123)
                         .minSize(123)
                         .build())
                 .build()))
         .maxSize(123)
         .metricGroups(List.of("metricGroups"))
         .minSize(123)
         .name("name")
         .newGameSessionProtectionPolicy("newGameSessionProtectionPolicy")
         .peerVpcAwsAccountId("peerVpcAwsAccountId")
         .peerVpcId("peerVpcId")
         .resourceCreationLimitPolicy(ResourceCreationLimitPolicyProperty.builder()
                 .newGameSessionsPerCreator(123)
                 .policyPeriodInMinutes(123)
                 .build())
         .runtimeConfiguration(RuntimeConfigurationProperty.builder()
                 .gameSessionActivationTimeoutSeconds(123)
                 .maxConcurrentGameSessionActivations(123)
                 .serverProcesses(List.of(ServerProcessProperty.builder()
                         .concurrentExecutions(123)
                         .launchPath("launchPath")
                         // the properties below are optional
                         .parameters("parameters")
                         .build()))
                 .build())
         .scriptId("scriptId")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnFleetProps.Builder A builder for CfnFleetProps
static class	CfnFleetProps.Jsii$Proxy An implementation for CfnFleetProps

Method Summary

Modifier and Type	Method and Description
static CfnFleetProps.Builder	builder()
default String	getBuildId() A unique identifier for a build to be deployed on the new fleet.
default Object	getCertificateConfiguration() Indicates whether to generate a TLS/SSL certificate for the new fleet.
default String	getDescription() A human-readable description of the fleet.
default Number	getDesiredEc2Instances() The number of EC2 instances that you want this fleet to host.
default Object	getEc2InboundPermissions() A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
default String	getEc2InstanceType() The GameLift-supported Amazon EC2 instance type to use for all fleet instances.
default String	getFleetType() Indicates whether to use On-Demand or Spot instances for this fleet.
default String	getInstanceRoleArn() A unique identifier for an IAM role that manages access to your AWS services.
default Object	getLocations() A set of remote locations to deploy additional instances to and manage as part of the fleet.
default Number	getMaxSize() The maximum value that is allowed for the fleet's instance count.
default List<String>	getMetricGroups() The name of an Amazon CloudWatch metric group.
default Number	getMinSize() The minimum value allowed for the fleet's instance count.
default String	getName() A descriptive label that is associated with a fleet.
default String	getNewGameSessionProtectionPolicy() A game session protection policy to apply to all game sessions hosted on instances in this fleet.
default String	getPeerVpcAwsAccountId() Used when peering your GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC.
default String	getPeerVpcId() A unique identifier for a VPC with resources to be accessed by your GameLift fleet.
default Object	getResourceCreationLimitPolicy() 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.
default Object	getRuntimeConfiguration() Instructions for launching server processes on each instance in the fleet.
default String	getScriptId() A unique identifier for a Realtime script to be deployed on a new Realtime Servers fleet.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBuildId

@Stability(value=Stable)
 @Nullable
default String getBuildId()

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.

getCertificateConfiguration

@Stability(value=Stable)
 @Nullable
default Object getCertificateConfiguration()

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.

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

A human-readable description of the fleet.

getDesiredEc2Instances

@Stability(value=Stable)
 @Nullable
default Number getDesiredEc2Instances()

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.

getEc2InboundPermissions

@Stability(value=Stable)
 @Nullable
default Object getEc2InboundPermissions()

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

getEc2InstanceType

@Stability(value=Stable)
 @Nullable
default String getEc2InstanceType()

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.

getFleetType

@Stability(value=Stable)
 @Nullable
default String getFleetType()

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.

getInstanceRoleArn

@Stability(value=Stable)
 @Nullable
default String getInstanceRoleArn()

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.

getLocations

@Stability(value=Stable)
 @Nullable
default Object getLocations()

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.

getMaxSize

@Stability(value=Stable)
 @Nullable
default Number getMaxSize()

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.

getMetricGroups

@Stability(value=Stable)
 @Nullable
default List<String> getMetricGroups()

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.

getMinSize

@Stability(value=Stable)
 @Nullable
default Number getMinSize()

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.

getName

@Stability(value=Stable)
 @Nullable
default String getName()

A descriptive label that is associated with a fleet.

Fleet names do not need to be unique.

getNewGameSessionProtectionPolicy

@Stability(value=Stable)
 @Nullable
default String getNewGameSessionProtectionPolicy()

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.

getPeerVpcAwsAccountId

@Stability(value=Stable)
 @Nullable
default String getPeerVpcAwsAccountId()

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.

getPeerVpcId

@Stability(value=Stable)
 @Nullable
default String getPeerVpcId()

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 .

getResourceCreationLimitPolicy

@Stability(value=Stable)
 @Nullable
default Object getResourceCreationLimitPolicy()

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.

getRuntimeConfiguration

@Stability(value=Stable)
 @Nullable
default Object getRuntimeConfiguration()

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.

getScriptId

@Stability(value=Stable)
 @Nullable
default String getScriptId()

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.

builder

@Stability(value=Stable)
static CfnFleetProps.Builder builder()

Returns:

a CfnFleetProps.Builder of CfnFleetProps