Class CfnFleet
The AWS::GameLift::Fleet
resource creates an Amazon GameLift (GameLift) fleet to host custom game server or Realtime Servers.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.GameLift
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnFleet : CfnResource, IInspectable
Syntax (vb)
Public Class CfnFleet
Inherits CfnResource
Implements IInspectable
Remarks
A fleet is a set of EC2 instances, configured with instructions to run game servers on each instance.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html
CloudformationResource: AWS::GameLift::Fleet
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 cfnFleet = new CfnFleet(this, "MyCfnFleet", 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
CfnFleet(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnFleet(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnFleet(Construct, String, ICfnFleetProps) |
Properties
AnywhereConfiguration | Amazon GameLift Anywhere configuration options. |
ApplyCapacity | Current resource capacity settings for managed EC2 fleets and managed container fleets. |
AttrFleetId | A unique identifier for the fleet. |
BuildId | A unique identifier for a build to be deployed on the new fleet. |
CertificateConfiguration | Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ComputeType | The type of compute resource used to host your game servers. |
Description | A description for the fleet. |
DesiredEc2Instances | The number of EC2 instances that you want this fleet to host. |
Ec2InboundPermissions | The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. |
Ec2InstanceType | The Amazon GameLift-supported Amazon EC2 instance type to use with managed EC2 fleets. |
FleetType | Indicates whether to use On-Demand or Spot instances for this fleet. |
InstanceRoleArn | A unique identifier for an IAM role that manages access to your AWS services. |
InstanceRoleCredentialsProvider | 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. |
LogPaths | (deprecated) This parameter is no longer used. |
MaxSize | The maximum number of instances that are allowed in the specified fleet location. |
MetricGroups | The name of an AWS CloudWatch metric group to add this fleet to. |
MinSize | The minimum number of instances that are allowed in the specified fleet location. |
Name | A descriptive label that is associated with a fleet. |
NewGameSessionProtectionPolicy | The status of termination protection for active game sessions on the fleet. |
PeerVpcAwsAccountId | Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC. |
PeerVpcId | A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. |
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. |
RuntimeConfiguration | Instructions for how to launch and maintain server processes on instances in the fleet. |
ScalingPolicies | Rule that controls how a fleet is scaled. |
ScriptId | The unique identifier for a Realtime configuration script to be deployed on fleet instances. |
ServerLaunchParameters | (deprecated) This parameter is no longer used but is retained for backward compatibility. |
ServerLaunchPath | (deprecated) This parameter is no longer used. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnFleet(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnFleet(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnFleet(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnFleet(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnFleet(Construct, String, ICfnFleetProps)
public CfnFleet(Construct scope, string id, ICfnFleetProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnFleetProps
Resource properties.
Properties
AnywhereConfiguration
Amazon GameLift Anywhere configuration options.
public virtual object AnywhereConfiguration { get; set; }
Property Value
System.Object
ApplyCapacity
Current resource capacity settings for managed EC2 fleets and managed container fleets.
public virtual string ApplyCapacity { get; set; }
Property Value
System.String
AttrFleetId
A unique identifier for the fleet.
public virtual string AttrFleetId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: FleetId
BuildId
A unique identifier for a build to be deployed on the new fleet.
public virtual string BuildId { get; set; }
Property Value
System.String
CertificateConfiguration
Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.
public virtual object CertificateConfiguration { get; set; }
Property Value
System.Object
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ComputeType
The type of compute resource used to host your game servers.
public virtual string ComputeType { get; set; }
Property Value
System.String
Description
A description for the fleet.
public virtual string Description { get; set; }
Property Value
System.String
DesiredEc2Instances
The number of EC2 instances that you want this fleet to host.
public virtual Nullable<double> DesiredEc2Instances { get; set; }
Property Value
System.Nullable<System.Double>
Ec2InboundPermissions
The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.
public virtual object Ec2InboundPermissions { get; set; }
Property Value
System.Object
Ec2InstanceType
The Amazon GameLift-supported Amazon EC2 instance type to use with managed EC2 fleets.
public virtual string Ec2InstanceType { get; set; }
Property Value
System.String
FleetType
Indicates whether to use On-Demand or Spot instances for this fleet.
public virtual string FleetType { get; set; }
Property Value
System.String
InstanceRoleArn
A unique identifier for an IAM role that manages access to your AWS services.
public virtual string InstanceRoleArn { get; set; }
Property Value
System.String
InstanceRoleCredentialsProvider
Indicates that fleet instances maintain a shared credentials file for the IAM role defined in InstanceRoleArn
.
public virtual string InstanceRoleCredentialsProvider { get; set; }
Property Value
System.String
Locations
A set of remote locations to deploy additional instances to and manage as a multi-location fleet.
public virtual object Locations { get; set; }
Property Value
System.Object
LogPaths
(deprecated) This parameter is no longer used.
public virtual string[] LogPaths { get; set; }
Property Value
System.String[]
Remarks
Stability: Deprecated
MaxSize
The maximum number of instances that are allowed in the specified fleet location.
public virtual Nullable<double> MaxSize { get; set; }
Property Value
System.Nullable<System.Double>
MetricGroups
The name of an AWS CloudWatch metric group to add this fleet to.
public virtual string[] MetricGroups { get; set; }
Property Value
System.String[]
MinSize
The minimum number of instances that are allowed in the specified fleet location.
public virtual Nullable<double> MinSize { get; set; }
Property Value
System.Nullable<System.Double>
Name
A descriptive label that is associated with a fleet.
public virtual string Name { get; set; }
Property Value
System.String
NewGameSessionProtectionPolicy
The status of termination protection for active game sessions on the fleet.
public virtual string NewGameSessionProtectionPolicy { get; set; }
Property Value
System.String
PeerVpcAwsAccountId
Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC.
public virtual string PeerVpcAwsAccountId { get; set; }
Property Value
System.String
PeerVpcId
A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.
public virtual string PeerVpcId { get; set; }
Property Value
System.String
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 virtual object ResourceCreationLimitPolicy { get; set; }
Property Value
System.Object
RuntimeConfiguration
Instructions for how to launch and maintain server processes on instances in the fleet.
public virtual object RuntimeConfiguration { get; set; }
Property Value
System.Object
ScalingPolicies
Rule that controls how a fleet is scaled.
public virtual object ScalingPolicies { get; set; }
Property Value
System.Object
ScriptId
The unique identifier for a Realtime configuration script to be deployed on fleet instances.
public virtual string ScriptId { get; set; }
Property Value
System.String
ServerLaunchParameters
(deprecated) This parameter is no longer used but is retained for backward compatibility.
public virtual string ServerLaunchParameters { get; set; }
Property Value
System.String
Remarks
Stability: Deprecated
ServerLaunchPath
(deprecated) This parameter is no longer used.
public virtual string ServerLaunchPath { get; set; }
Property Value
System.String
Remarks
Stability: Deprecated
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>