Class CfnFleetProps
Properties for defining a CfnFleet.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.GameLift
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnFleetProps : Object, ICfnFleetPropsSyntax (vb)
Public Class CfnFleetProps
Inherits Object
Implements ICfnFleetPropsRemarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.GameLift;
var cfnFleetProps = new CfnFleetProps {
Name = "name",
// the properties below are optional
AnywhereConfiguration = new AnywhereConfigurationProperty {
Cost = "cost"
},
ApplyCapacity = "applyCapacity",
BuildId = "buildId",
CertificateConfiguration = new CertificateConfigurationProperty {
CertificateType = "certificateType"
},
ComputeType = "computeType",
Description = "description",
DesiredEc2Instances = 123,
Ec2InboundPermissions = new [] { new IpPermissionProperty {
FromPort = 123,
IpRange = "ipRange",
Protocol = "protocol",
ToPort = 123
} },
Ec2InstanceType = "ec2InstanceType",
FleetType = "fleetType",
InstanceRoleArn = "instanceRoleArn",
InstanceRoleCredentialsProvider = "instanceRoleCredentialsProvider",
Locations = new [] { new LocationConfigurationProperty {
Location = "location",
// the properties below are optional
LocationCapacity = new LocationCapacityProperty {
DesiredEc2Instances = 123,
MaxSize = 123,
MinSize = 123
}
} },
LogPaths = new [] { "logPaths" },
MaxSize = 123,
MetricGroups = new [] { "metricGroups" },
MinSize = 123,
NewGameSessionProtectionPolicy = "newGameSessionProtectionPolicy",
PeerVpcAwsAccountId = "peerVpcAwsAccountId",
PeerVpcId = "peerVpcId",
ResourceCreationLimitPolicy = new ResourceCreationLimitPolicyProperty {
NewGameSessionsPerCreator = 123,
PolicyPeriodInMinutes = 123
},
RuntimeConfiguration = new RuntimeConfigurationProperty {
GameSessionActivationTimeoutSeconds = 123,
MaxConcurrentGameSessionActivations = 123,
ServerProcesses = new [] { new ServerProcessProperty {
ConcurrentExecutions = 123,
LaunchPath = "launchPath",
// the properties below are optional
Parameters = "parameters"
} }
},
ScalingPolicies = new [] { new ScalingPolicyProperty {
MetricName = "metricName",
Name = "name",
// the properties below are optional
ComparisonOperator = "comparisonOperator",
EvaluationPeriods = 123,
Location = "location",
PolicyType = "policyType",
ScalingAdjustment = 123,
ScalingAdjustmentType = "scalingAdjustmentType",
Status = "status",
TargetConfiguration = new TargetConfigurationProperty {
TargetValue = 123
},
Threshold = 123,
UpdateStatus = "updateStatus"
} },
ScriptId = "scriptId",
ServerLaunchParameters = "serverLaunchParameters",
ServerLaunchPath = "serverLaunchPath"
};Synopsis
Constructors
| Cfn |
Properties
| Anywhere |
Amazon GameLift Anywhere configuration options. |
| Apply |
Current resource capacity settings for managed EC2 fleets and managed container fleets. |
| Build |
A unique identifier for a build to be deployed on the new fleet. |
| Certificate |
Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet. |
| Compute |
The type of compute resource used to host your game servers. |
| Description | A description for the fleet. |
| Desired |
The number of EC2 instances that you want this fleet to host. |
| Ec2Inbound |
The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. |
| Ec2Instance |
The Amazon GameLift-supported Amazon EC2 instance type to use with managed EC2 fleets. |
| Fleet |
Indicates whether to use On-Demand or Spot instances for this fleet. |
| Instance |
A unique identifier for an IAM role that manages access to your AWS services. |
| Instance |
Indicates that fleet instances maintain a shared credentials file for the IAM role defined in |
| Locations | A set of remote locations to deploy additional instances to and manage as a multi-location fleet. |
| Log |
(deprecated) This parameter is no longer used. |
| Max |
The maximum number of instances that are allowed in the specified fleet location. |
| Metric |
The name of an AWS CloudWatch metric group to add this fleet to. |
| Min |
The minimum number of instances that are allowed in the specified fleet location. |
| Name | A descriptive label that is associated with a fleet. |
| New |
The status of termination protection for active game sessions on the fleet. |
| Peer |
Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC. |
| Peer |
A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. |
| Resource |
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. |
| Runtime |
Instructions for how to launch and maintain server processes on instances in the fleet. |
| Scaling |
Rule that controls how a fleet is scaled. |
| Script |
The unique identifier for a Realtime configuration script to be deployed on fleet instances. |
| Server |
(deprecated) This parameter is no longer used but is retained for backward compatibility. |
| Server |
(deprecated) This parameter is no longer used. |
Constructors
CfnFleetProps()
public CfnFleetProps()Properties
AnywhereConfiguration
Amazon GameLift Anywhere configuration options.
public object AnywhereConfiguration { get; set; }Property Value
System.
Remarks
ApplyCapacity
Current resource capacity settings for managed EC2 fleets and managed container fleets.
public string ApplyCapacity { get; set; }Property Value
System.
Remarks
For multi-location fleets, location values might refer to a fleet's remote location or its home Region.
Returned by: DescribeFleetCapacity , DescribeFleetLocationCapacity , UpdateFleetCapacity
BuildId
A unique identifier for a build to be deployed on the new fleet.
public string BuildId { get; set; }Property Value
System.
Remarks
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.
CertificateConfiguration
Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.
public object CertificateConfiguration { get; set; }Property Value
System.
Remarks
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 .
ComputeType
The type of compute resource used to host your game servers.
public string ComputeType { get; set; }Property Value
System.
Remarks
Description
A description for the fleet.
public string Description { get; set; }Property Value
System.
Remarks
DesiredEc2Instances
The number of EC2 instances that you want this fleet to host.
public Nullable<double> DesiredEc2Instances { get; set; }Property Value
System.
Remarks
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.
Ec2InboundPermissions
The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.
public object Ec2InboundPermissions { get; set; }Property Value
System.
Remarks
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.
Ec2InstanceType
The Amazon GameLift-supported Amazon EC2 instance type to use with managed EC2 fleets.
public string Ec2InstanceType { get; set; }Property Value
System.
Remarks
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.
FleetType
Indicates whether to use On-Demand or Spot instances for this fleet.
public string FleetType { get; set; }Property Value
System.
Remarks
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.
InstanceRoleArn
A unique identifier for an IAM role that manages access to your AWS services.
public string InstanceRoleArn { get; set; }Property Value
System.
Remarks
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 .
InstanceRoleCredentialsProvider
Indicates that fleet instances maintain a shared credentials file for the IAM role defined in InstanceRoleArn .
public string InstanceRoleCredentialsProvider { get; set; }Property Value
System.
Remarks
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 .
Locations
A set of remote locations to deploy additional instances to and manage as a multi-location fleet.
public object Locations { get; set; }Property Value
System.
Remarks
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.
LogPaths
(deprecated) This parameter is no longer used.
public string[] LogPaths { get; set; }Property Value
System.
Remarks
When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady()
Stability: Deprecated
MaxSize
The maximum number of instances that are allowed in the specified fleet location.
public Nullable<double> MaxSize { get; set; }Property Value
System.
Remarks
If this parameter is not set, the default is 1.
MetricGroups
The name of an AWS CloudWatch metric group to add this fleet to.
public string[] MetricGroups { get; set; }Property Value
System.
Remarks
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.
MinSize
The minimum number of instances that are allowed in the specified fleet location.
public Nullable<double> MinSize { get; set; }Property Value
System.
Remarks
If this parameter is not set, the default is 0.
Name
A descriptive label that is associated with a fleet.
public string Name { get; set; }Property Value
System.
Remarks
Fleet names do not need to be unique.
NewGameSessionProtectionPolicy
The status of termination protection for active game sessions on the fleet.
public string NewGameSessionProtectionPolicy { get; set; }Property Value
System.
Remarks
By default, this property is set to NoProtection .
PeerVpcAwsAccountId
Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC.
public string PeerVpcAwsAccountId { get; set; }Property Value
System.
Remarks
You can find your account ID in the AWS Management Console under account settings.
PeerVpcId
A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.
public string PeerVpcId { get; set; }Property Value
System.
Remarks
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 .
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.
public object ResourceCreationLimitPolicy { get; set; }Property Value
System.
Remarks
RuntimeConfiguration
Instructions for how to launch and maintain server processes on instances in the fleet.
public object RuntimeConfiguration { get; set; }Property Value
System.
Remarks
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.
ScalingPolicies
Rule that controls how a fleet is scaled.
public object ScalingPolicies { get; set; }Property Value
System.
Remarks
Scaling policies are uniquely identified by the combination of name and fleet ID.
ScriptId
The unique identifier for a Realtime configuration script to be deployed on fleet instances.
public string ScriptId { get; set; }Property Value
System.
Remarks
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.
ServerLaunchParameters
(deprecated) This parameter is no longer used but is retained for backward compatibility.
public string ServerLaunchParameters { get; set; }Property Value
System.
Remarks
Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath.
Stability: Deprecated
ServerLaunchPath
(deprecated) This parameter is no longer used.
public string ServerLaunchPath { get; set; }Property Value
System.
Remarks
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.
Stability: Deprecated