class CfnFleet (construct)

Language	Type name
.NET	Amazon.CDK.AWS.GameLift.CfnFleet
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsgamelift#CfnFleet
Java	software.amazon.awscdk.services.gamelift.CfnFleet
Python	aws_cdk.aws_gamelift.CfnFleet
TypeScript	aws-cdk-lib » aws_gamelift » CfnFleet

Implements IConstruct, IDependable, IInspectable

The AWS::GameLift::Fleet resource creates an Amazon GameLift (GameLift) fleet to host custom game server or Realtime Servers.

A fleet is a set of EC2 instances, configured with instructions to run game servers on each instance.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_gamelift as gamelift } from 'aws-cdk-lib';
const cfnFleet = new gamelift.CfnFleet(this, 'MyCfnFleet', {
  name: 'name',

  // the properties below are optional
  anywhereConfiguration: {
    cost: 'cost',
  },
  applyCapacity: 'applyCapacity',
  buildId: 'buildId',
  certificateConfiguration: {
    certificateType: 'certificateType',
  },
  computeType: 'computeType',
  description: 'description',
  desiredEc2Instances: 123,
  ec2InboundPermissions: [{
    fromPort: 123,
    ipRange: 'ipRange',
    protocol: 'protocol',
    toPort: 123,
  }],
  ec2InstanceType: 'ec2InstanceType',
  fleetType: 'fleetType',
  instanceRoleArn: 'instanceRoleArn',
  instanceRoleCredentialsProvider: 'instanceRoleCredentialsProvider',
  locations: [{
    location: 'location',

    // the properties below are optional
    locationCapacity: {
      desiredEc2Instances: 123,
      maxSize: 123,
      minSize: 123,
    },
  }],
  logPaths: ['logPaths'],
  maxSize: 123,
  metricGroups: ['metricGroups'],
  minSize: 123,
  newGameSessionProtectionPolicy: 'newGameSessionProtectionPolicy',
  peerVpcAwsAccountId: 'peerVpcAwsAccountId',
  peerVpcId: 'peerVpcId',
  resourceCreationLimitPolicy: {
    newGameSessionsPerCreator: 123,
    policyPeriodInMinutes: 123,
  },
  runtimeConfiguration: {
    gameSessionActivationTimeoutSeconds: 123,
    maxConcurrentGameSessionActivations: 123,
    serverProcesses: [{
      concurrentExecutions: 123,
      launchPath: 'launchPath',

      // the properties below are optional
      parameters: 'parameters',
    }],
  },
  scalingPolicies: [{
    metricName: 'metricName',
    name: 'name',

    // the properties below are optional
    comparisonOperator: 'comparisonOperator',
    evaluationPeriods: 123,
    location: 'location',
    policyType: 'policyType',
    scalingAdjustment: 123,
    scalingAdjustmentType: 'scalingAdjustmentType',
    status: 'status',
    targetConfiguration: {
      targetValue: 123,
    },
    threshold: 123,
    updateStatus: 'updateStatus',
  }],
  scriptId: 'scriptId',
  serverLaunchParameters: 'serverLaunchParameters',
  serverLaunchPath: 'serverLaunchPath',
});

Initializer

new CfnFleet(scope: Construct, id: string, props: CfnFleetProps)

Parameters

• scope Construct — Scope in which this resource is defined.
• id string — Construct identifier for this resource (unique in its scope).
• props CfnFleetProps — Resource properties.

Construct Props

Name	Type	Description
name	string	A descriptive label that is associated with a fleet.
anywhereConfiguration?	IResolvable | AnywhereConfigurationProperty	Amazon GameLift Anywhere configuration options.
applyCapacity?	string	Current resource capacity settings for managed EC2 fleets and managed container fleets.
buildId?	string	A unique identifier for a build to be deployed on the new fleet.
certificateConfiguration?	IResolvable | CertificateConfigurationProperty	Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.
computeType?	string	The type of compute resource used to host your game servers.
description?	string	A description for the fleet.
desiredEc2Instances?	number	The number of EC2 instances that you want this fleet to host.
ec2InboundPermissions?	IResolvable | IResolvable | IpPermissionProperty[]	The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.
ec2InstanceType?	string	The Amazon GameLift-supported Amazon EC2 instance type to use with managed EC2 fleets.
fleetType?	string	Indicates whether to use On-Demand or Spot instances for this fleet.
instanceRoleArn?	string	A unique identifier for an IAM role that manages access to your AWS services.
instanceRoleCredentialsProvider?	string	Indicates that fleet instances maintain a shared credentials file for the IAM role defined in InstanceRoleArn .
locations?	IResolvable | IResolvable | LocationConfigurationProperty[]	A set of remote locations to deploy additional instances to and manage as a multi-location fleet.
logPaths?⚠️	string[]	This parameter is no longer used.
maxSize?	number	The maximum number of instances that are allowed in the specified fleet location.
metricGroups?	string[]	The name of an AWS CloudWatch metric group to add this fleet to.
minSize?	number	The minimum number of instances that are allowed in the specified fleet location.
newGameSessionProtectionPolicy?	string	The status of termination protection for active game sessions on the fleet.
peerVpcAwsAccountId?	string	Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC.
peerVpcId?	string	A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.
resourceCreationLimitPolicy?	IResolvable | ResourceCreationLimitPolicyProperty	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.
runtimeConfiguration?	IResolvable | RuntimeConfigurationProperty	Instructions for how to launch and maintain server processes on instances in the fleet.
scalingPolicies?	IResolvable | IResolvable | ScalingPolicyProperty[]	Rule that controls how a fleet is scaled.
scriptId?	string	The unique identifier for a Realtime configuration script to be deployed on fleet instances.
serverLaunchParameters?⚠️	string	This parameter is no longer used but is retained for backward compatibility.
serverLaunchPath?⚠️	string	This parameter is no longer used.

---

name

Type: string

A descriptive label that is associated with a fleet.

Fleet names do not need to be unique.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-name

---

anywhereConfiguration?

Type: IResolvable | AnywhereConfigurationProperty (optional)

Amazon GameLift Anywhere configuration options.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-anywhereconfiguration

---

applyCapacity?

Type: string (optional)

Current resource capacity settings for managed EC2 fleets and managed container fleets.

For multi-location fleets, location values might refer to a fleet's remote location or its home Region.

Returned by: DescribeFleetCapacity , DescribeFleetLocationCapacity , UpdateFleetCapacity

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-applycapacity

---

buildId?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-buildid

---

certificateConfiguration?

Type: IResolvable | CertificateConfigurationProperty (optional)

Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.

Amazon GameLift uses the certificates to encrypt traffic between game clients and the game servers running on Amazon 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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-certificateconfiguration

---

computeType?

Type: string (optional)

The type of compute resource used to host your game servers.

• EC2 – The game server build is deployed to Amazon EC2 instances for cloud hosting. This is the default setting.
• ANYWHERE – Game servers and supporting software are deployed to compute resources that you provide and manage. With this compute type, you can also set the AnywhereConfiguration parameter.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-computetype

---

description?

Type: string (optional)

A description for the fleet.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-description

---

desiredEc2Instances?

Type: number (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-desiredec2instances

---

ec2InboundPermissions?

Type: IResolvable | IResolvable | IpPermissionProperty[] (optional)

The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.

Set this parameter for managed EC2 fleets. You can leave this parameter empty when creating the fleet, but you must call to set it before players can connect to game sessions. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-ec2inboundpermissions

---

ec2InstanceType?

Type: string (optional)

The Amazon GameLift-supported Amazon EC2 instance type to use with managed EC2 fleets.

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-ec2instancetype

---

fleetType?

Type: string (optional)

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 fleet property can't be changed after the fleet is created.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-fleettype

---

instanceRoleArn?

Type: string (optional)

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 attribute is used with fleets where ComputeType is EC2 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-instancerolearn

---

instanceRoleCredentialsProvider?

Type: string (optional)

Indicates that fleet instances maintain a shared credentials file for the IAM role defined in InstanceRoleArn .

Shared credentials allow applications that are deployed with the game server executable to communicate with other AWS resources. This property is used only when the game server is integrated with the server SDK version 5.x. For more information about using shared credentials, see Communicate with other AWS resources from your fleets . This attribute is used with fleets where ComputeType is EC2 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-instancerolecredentialsprovider

---

locations?

Type: IResolvable | IResolvable | LocationConfigurationProperty[] (optional)

A set of remote locations to deploy additional instances to and manage as a multi-location fleet.

Use this parameter when creating a fleet in AWS Regions that support multiple locations. You can add any AWS Region or Local Zone that's supported by Amazon GameLift. Provide a list of one or more AWS Region codes, such as us-west-2 , or Local Zone names. When using this parameter, Amazon GameLift requires you to include your home location in the request. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-locations

---

logPaths?⚠️

⚠️ Deprecated: this property has been deprecated

Type: string[] (optional)

This parameter is no longer used.

When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady()

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-logpaths

---

maxSize?

Type: number (optional)

The maximum number of instances that are allowed in the specified fleet location.

If this parameter is not set, the default is 1.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-maxsize

---

metricGroups?

Type: string[] (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-metricgroups

---

minSize?

Type: number (optional)

The minimum number of instances that are allowed in the specified fleet location.

If this parameter is not set, the default is 0.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-minsize

---

newGameSessionProtectionPolicy?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-newgamesessionprotectionpolicy

---

peerVpcAwsAccountId?

Type: string (optional)

Used when peering your Amazon 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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-peervpcawsaccountid

---

peerVpcId?

Type: string (optional)

A unique identifier for a VPC with resources to be accessed by your Amazon 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 Amazon GameLift Fleets .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-peervpcid

---

resourceCreationLimitPolicy?

Type: IResolvable | ResourceCreationLimitPolicyProperty (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-resourcecreationlimitpolicy

---

runtimeConfiguration?

Type: IResolvable | RuntimeConfigurationProperty (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-runtimeconfiguration

---

scalingPolicies?

Type: IResolvable | IResolvable | ScalingPolicyProperty[] (optional)

Rule that controls how a fleet is scaled.

Scaling policies are uniquely identified by the combination of name and fleet ID.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-scalingpolicies

---

scriptId?

Type: string (optional)

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 Amazon 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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-scriptid

---

serverLaunchParameters?⚠️

⚠️ Deprecated: this property has been deprecated

Type: string (optional)

This parameter is no longer used but is retained for backward compatibility.

Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-serverlaunchparameters

---

serverLaunchPath?⚠️

⚠️ Deprecated: this property has been deprecated

Type: string (optional)

This parameter is no longer used.

Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-serverlaunchpath

Properties

Name	Type	Description
attrFleetId	string	A unique identifier for the fleet.
cfnOptions	ICfnResourceOptions	Options for this resource, such as condition, update policy etc.
cfnProperties	{ [string]: any }
cfnResourceType	string	AWS resource type.
creationStack	string[]
logicalId	string	The logical ID for this CloudFormation stack element.
name	string	A descriptive label that is associated with a fleet.
node	Node	The tree node.
ref	string	Return a string that will be resolved to a CloudFormation { Ref } for this element.
stack	Stack	The stack in which this element is defined.
anywhereConfiguration?	IResolvable | AnywhereConfigurationProperty	Amazon GameLift Anywhere configuration options.
applyCapacity?	string	Current resource capacity settings for managed EC2 fleets and managed container fleets.
buildId?	string	A unique identifier for a build to be deployed on the new fleet.
certificateConfiguration?	IResolvable | CertificateConfigurationProperty	Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.
computeType?	string	The type of compute resource used to host your game servers.
description?	string	A description for the fleet.
desiredEc2Instances?	number	The number of EC2 instances that you want this fleet to host.
ec2InboundPermissions?	IResolvable | IResolvable | IpPermissionProperty[]	The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.
ec2InstanceType?	string	The Amazon GameLift-supported Amazon EC2 instance type to use with managed EC2 fleets.
fleetType?	string	Indicates whether to use On-Demand or Spot instances for this fleet.
instanceRoleArn?	string	A unique identifier for an IAM role that manages access to your AWS services.
instanceRoleCredentialsProvider?	string	Indicates that fleet instances maintain a shared credentials file for the IAM role defined in InstanceRoleArn .
locations?	IResolvable | IResolvable | LocationConfigurationProperty[]	A set of remote locations to deploy additional instances to and manage as a multi-location fleet.
logPaths?⚠️	string[]	This parameter is no longer used.
maxSize?	number	The maximum number of instances that are allowed in the specified fleet location.
metricGroups?	string[]	The name of an AWS CloudWatch metric group to add this fleet to.
minSize?	number	The minimum number of instances that are allowed in the specified fleet location.
newGameSessionProtectionPolicy?	string	The status of termination protection for active game sessions on the fleet.
peerVpcAwsAccountId?	string	Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC.
peerVpcId?	string	A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.
resourceCreationLimitPolicy?	IResolvable | ResourceCreationLimitPolicyProperty	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.
runtimeConfiguration?	IResolvable | RuntimeConfigurationProperty	Instructions for how to launch and maintain server processes on instances in the fleet.
scalingPolicies?	IResolvable | IResolvable | ScalingPolicyProperty[]	Rule that controls how a fleet is scaled.
scriptId?	string	The unique identifier for a Realtime configuration script to be deployed on fleet instances.
serverLaunchParameters?⚠️	string	This parameter is no longer used but is retained for backward compatibility.
serverLaunchPath?⚠️	string	This parameter is no longer used.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

attrFleetId

Type: string

A unique identifier for the fleet.

---

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

---

cfnProperties

Type: { [string]: any }

---

cfnResourceType

Type: string

AWS resource type.

---

creationStack

Type: string[]

---

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

---

name

Type: string

A descriptive label that is associated with a fleet.

---

node

Type: Node

The tree node.

---

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

---

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

---

anywhereConfiguration?

Type: IResolvable | AnywhereConfigurationProperty (optional)

Amazon GameLift Anywhere configuration options.

---

applyCapacity?

Type: string (optional)

Current resource capacity settings for managed EC2 fleets and managed container fleets.

---

buildId?

Type: string (optional)

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

---

certificateConfiguration?

Type: IResolvable | CertificateConfigurationProperty (optional)

Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.

---

computeType?

Type: string (optional)

The type of compute resource used to host your game servers.

---

description?

Type: string (optional)

A description for the fleet.

---

desiredEc2Instances?

Type: number (optional)

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

---

ec2InboundPermissions?

Type: IResolvable | IResolvable | IpPermissionProperty[] (optional)

The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.

---

ec2InstanceType?

Type: string (optional)

The Amazon GameLift-supported Amazon EC2 instance type to use with managed EC2 fleets.

---

fleetType?

Type: string (optional)

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

---

instanceRoleArn?

Type: string (optional)

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

---

instanceRoleCredentialsProvider?

Type: string (optional)

Indicates that fleet instances maintain a shared credentials file for the IAM role defined in InstanceRoleArn .

---

locations?

Type: IResolvable | IResolvable | LocationConfigurationProperty[] (optional)

A set of remote locations to deploy additional instances to and manage as a multi-location fleet.

---

logPaths?⚠️

⚠️ Deprecated: this property has been deprecated

Type: string[] (optional)

This parameter is no longer used.

---

maxSize?

Type: number (optional)

The maximum number of instances that are allowed in the specified fleet location.

---

metricGroups?

Type: string[] (optional)

The name of an AWS CloudWatch metric group to add this fleet to.

---

minSize?

Type: number (optional)

The minimum number of instances that are allowed in the specified fleet location.

---

newGameSessionProtectionPolicy?

Type: string (optional)

The status of termination protection for active game sessions on the fleet.

---

peerVpcAwsAccountId?

Type: string (optional)

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

---

peerVpcId?

Type: string (optional)

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

---

resourceCreationLimitPolicy?

Type: IResolvable | ResourceCreationLimitPolicyProperty (optional)

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.

---

runtimeConfiguration?

Type: IResolvable | RuntimeConfigurationProperty (optional)

Instructions for how to launch and maintain server processes on instances in the fleet.

---

scalingPolicies?

Type: IResolvable | IResolvable | ScalingPolicyProperty[] (optional)

Rule that controls how a fleet is scaled.

---

scriptId?

Type: string (optional)

The unique identifier for a Realtime configuration script to be deployed on fleet instances.

---

serverLaunchParameters?⚠️

⚠️ Deprecated: this property has been deprecated

Type: string (optional)

This parameter is no longer used but is retained for backward compatibility.

---

serverLaunchPath?⚠️

⚠️ Deprecated: this property has been deprecated

Type: string (optional)

This parameter is no longer used.

---

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for addOverride(path, undefined).
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

---

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

• path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

---

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

---

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

---

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

• key string
• value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

• path string — - The path of the property, you can use dot notation to override values in complex types.
• value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

---

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

• propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

---

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

• propertyPath string — The path of the property.
• value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

---

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

• policy RemovalPolicy
• options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

---

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

• attributeName string — The name of the attribute.
• typeHint ResolutionTypeHint

Returns

• Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

---

getMetadata(key)

public getMetadata(key: string): any

Parameters

• key string

Returns

• any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

• inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

---

obtainDependencies()

public obtainDependencies(): Stack | CfnResource[]

Returns

• Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

---

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

• CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

---

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

• newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

---

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

---

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

• target CfnResource — The dependency to replace.
• newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

• props { [string]: any }

Returns

• { [string]: any }