Class CfnFleet

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

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnFleet
Inherited Members
Namespace: Amazon.CDK.AWS.GameLift
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnFleet : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnFleet Inherits CfnResource Implements IInspectable, ITaggableV2
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",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnFleet(Construct, string, ICfnFleetProps)

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

Properties

AnywhereConfiguration

Amazon GameLift Servers Anywhere configuration options.
ApplyCapacity

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

The Amazon Resource Name ( ARN ) that is assigned to a Amazon GameLift Servers fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . In a GameLift fleet ARN, the resource ID matches the FleetId value.
AttrFleetId

A unique identifier for the fleet.
BuildId

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

The CloudFormation resource type name for this resource class.
CdkTagManager

Tag Manager which manages the tags for this resource.
CertificateConfiguration

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

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

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

A description for the fleet.
DesiredEc2Instances

(deprecated) [DEPRECATED] 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 Servers-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 InstanceRoleArn .
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

(deprecated) [DEPRECATED] The maximum value that is allowed for the fleet's instance count.
MetricGroups

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

(deprecated) [DEPRECATED] The minimum value allowed for the fleet's instance count.
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 Servers 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 Servers 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.
Tags

An array of key-value pairs to apply to this resource.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)

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

Constructors

CfnFleet(Construct, string, ICfnFleetProps)

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

public CfnFleet(Construct scope, string id, ICfnFleetProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnFleetProps

Resource properties.

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

Properties

AnywhereConfiguration

Amazon GameLift Servers Anywhere configuration options.

public virtual object? AnywhereConfiguration { get; set; }
Property Value

object

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

ApplyCapacity

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

public virtual string? ApplyCapacity { get; set; }
Property Value

string

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

AttrFleetArn

The Amazon Resource Name ( ARN ) that is assigned to a Amazon GameLift Servers fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . In a GameLift fleet ARN, the resource ID matches the FleetId value.

public virtual string AttrFleetArn { get; }
Property Value

string

Remarks

CloudformationAttribute: FleetArn

AttrFleetId

A unique identifier for the fleet.

public virtual string AttrFleetId { get; }
Property Value

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

string

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

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

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

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

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

CertificateConfiguration

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

public virtual object? CertificateConfiguration { get; set; }
Property Value

object

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

CfnProperties

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

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
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

ComputeType

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

public virtual string? ComputeType { get; set; }
Property Value

string

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

Description

A description for the fleet.

public virtual string? Description { get; set; }
Property Value

string

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

DesiredEc2Instances

(deprecated) [DEPRECATED] The number of EC2 instances that you want this fleet to host.

[Obsolete("this property has been deprecated")]
public virtual double? DesiredEc2Instances { get; set; }
Property Value

double?

Remarks

Stability: Deprecated

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

object

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

Ec2InstanceType

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

public virtual string? Ec2InstanceType { get; set; }
Property Value

string

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

FleetType

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

public virtual string? FleetType { get; set; }
Property Value

string

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

InstanceRoleArn

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

public virtual string? InstanceRoleArn { get; set; }
Property Value

string

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

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

string

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

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

object

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

LogPaths

(deprecated) This parameter is no longer used.

[Obsolete("this property has been deprecated")]
public virtual string[]? LogPaths { get; set; }
Property Value

string[]

Remarks

Stability: Deprecated

MaxSize

(deprecated) [DEPRECATED] The maximum value that is allowed for the fleet's instance count.

[Obsolete("this property has been deprecated")]
public virtual double? MaxSize { get; set; }
Property Value

double?

Remarks

Stability: Deprecated

MetricGroups

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

public virtual string[]? MetricGroups { get; set; }
Property Value

string[]

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

MinSize

(deprecated) [DEPRECATED] The minimum value allowed for the fleet's instance count.

[Obsolete("this property has been deprecated")]
public virtual double? MinSize { get; set; }
Property Value

double?

Remarks

Stability: Deprecated

Name

A descriptive label that is associated with a fleet.

public virtual string Name { get; set; }
Property Value

string

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

NewGameSessionProtectionPolicy

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

public virtual string? NewGameSessionProtectionPolicy { get; set; }
Property Value

string

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

PeerVpcAwsAccountId

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

public virtual string? PeerVpcAwsAccountId { get; set; }
Property Value

string

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

PeerVpcId

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

public virtual string? PeerVpcId { get; set; }
Property Value

string

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

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

object

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

RuntimeConfiguration

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

public virtual object? RuntimeConfiguration { get; set; }
Property Value

object

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

ScalingPolicies

Rule that controls how a fleet is scaled.

public virtual object? ScalingPolicies { get; set; }
Property Value

object

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

ScriptId

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

public virtual string? ScriptId { get; set; }
Property Value

string

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

ServerLaunchParameters

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

[Obsolete("this property has been deprecated")]
public virtual string? ServerLaunchParameters { get; set; }
Property Value

string

Remarks

Stability: Deprecated

ServerLaunchPath

(deprecated) This parameter is no longer used.

[Obsolete("this property has been deprecated")]
public virtual string? ServerLaunchPath { get; set; }
Property Value

string

Remarks

Stability: Deprecated

Tags

An array of key-value pairs to apply to this resource.

public virtual ICfnTag[]? Tags { get; set; }
Property Value

ICfnTag[]

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

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.

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

RenderProperties(IDictionary<string, object>)

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

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
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

Implements