Class FleetBase

(experimental) Base class for new and imported GameLift fleet.

Inheritance

object

Resource

FleetBase

BuildFleet

Implements

IFleet

IResource

IConstruct

IDependable

IEnvironmentAware

IGrantable

IGameSessionQueueDestination

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.GameLift.Alpha

Assembly: Amazon.CDK.AWS.GameLift.Alpha.dll

Syntax (csharp)

public abstract class FleetBase : Resource, IFleet, IResource, IConstruct, IDependable, IEnvironmentAware, IGrantable, IGameSessionQueueDestination

Syntax (vb)

Public MustInherit Class FleetBase Inherits Resource Implements IFleet, IResource, IConstruct, IDependable, IEnvironmentAware, IGrantable, IGameSessionQueueDestination

Remarks

Stability: Experimental

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.Alpha;
             using Amazon.CDK.AWS.IAM;

             Role role;

             var fleetBase = FleetBase.FromFleetAttributes(this, "MyFleetBase", new FleetAttributes {
                 FleetArn = "fleetArn",
                 FleetId = "fleetId",
                 Role = role
             });

Synopsis

Constructors

FleetBase(Construct, string, IResourceProps?)

(experimental) Base class for new and imported GameLift fleet.

Properties

FleetArn	(experimental) The ARN of the fleet.
FleetId	(experimental) The Identifier of the fleet.
GrantPrincipal	(experimental) The principal this GameLift fleet is using.
ResourceArnForDestination	(experimental) The ARN to put into the destination field of a game session queue.

Methods

AddAlias(string, IAliasOptions?)	(experimental) Defines an alias for this fleet.
AddInternalLocation(ILocation)	(experimental) Adds a remote locations to deploy additional instances to and manage as part of the fleet.
AddLocation(string, double?, double?, double?)	(experimental) Adds a remote locations to deploy additional instances to and manage as part of the fleet.
FromFleetAttributes(Construct, string, IFleetAttributes)	(experimental) Import an existing fleet from its attributes.
Grant(IGrantable, params string[])	(experimental) Grant the `grantee` identity permissions to perform `actions`.
Metric(string, IMetricOptions?)	(experimental) Return the given named metric for this fleet.
MetricActiveInstances(IMetricOptions?)	(experimental) Instances with `ACTIVE` status, which means they are running active server processes.
MetricDesiredInstances(IMetricOptions?)	(experimental) Target number of active instances that GameLift is working to maintain in the fleet.
MetricIdleInstances(IMetricOptions?)	(experimental) Active instances that are currently hosting zero (0) game sessions.
MetricInstanceInterruptions(IMetricOptions?)	(experimental) Number of spot instances that have been interrupted.
MetricMaxInstances(IMetricOptions?)	(experimental) Maximum number of instances that are allowed for the fleet.
MetricMinInstances(IMetricOptions?)	(experimental) Minimum number of instances allowed for the fleet.
MetricPercentIdleInstances(IMetricOptions?)	(experimental) Percentage of all active instances that are idle (calculated as IdleInstances / ActiveInstances).
ParseLocationCapacity(ILocationCapacity?)	(experimental) Base class for new and imported GameLift fleet.
ParseLocations()	(experimental) Base class for new and imported GameLift fleet.
ParseResourceCreationLimitPolicy(IFleetProps)	(experimental) Base class for new and imported GameLift fleet.
ParseRuntimeConfiguration(IFleetProps)	(experimental) Base class for new and imported GameLift fleet.
WarnVpcPeeringAuthorizations(Construct)	(experimental) Base class for new and imported GameLift fleet.

Constructors

FleetBase(Construct, string, IResourceProps?)

(experimental) Base class for new and imported GameLift fleet.

protected FleetBase(Construct scope, string id, IResourceProps? props = null)

Parameters

scope Construct
id string
props IResourceProps

Remarks

Stability: Experimental

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.Alpha;
             using Amazon.CDK.AWS.IAM;

             Role role;

             var fleetBase = FleetBase.FromFleetAttributes(this, "MyFleetBase", new FleetAttributes {
                 FleetArn = "fleetArn",
                 FleetId = "fleetId",
                 Role = role
             });

Properties

FleetArn

(experimental) The ARN of the fleet.

public abstract string FleetArn { get; }

Property Value

string

Remarks

Stability: Experimental

FleetId

(experimental) The Identifier of the fleet.

public abstract string FleetId { get; }

Property Value

string

Remarks

Stability: Experimental

GrantPrincipal

(experimental) The principal this GameLift fleet is using.

public abstract IPrincipal GrantPrincipal { get; }

Property Value

IPrincipal

Remarks

Stability: Experimental

ResourceArnForDestination

(experimental) The ARN to put into the destination field of a game session queue.

public virtual string ResourceArnForDestination { get; }

Property Value

string

Remarks

Stability: Experimental

Methods

AddAlias(string, IAliasOptions?)

(experimental) Defines an alias for this fleet.

public virtual Alias AddAlias(string aliasName, IAliasOptions? options = null)

Parameters

aliasName string: The name of the alias.
options IAliasOptions: Alias options.

Returns

Alias

Remarks

FleetBase fleet;


fleet.AddAlias("Live");

// Is equivalent to

// Is equivalent to
new Alias(this, "AliasLive", new AliasProps {
    AliasName = "Live",
    Fleet = fleet
});

Stability: Experimental

AddInternalLocation(ILocation)

(experimental) Adds a remote locations to deploy additional instances to and manage as part of the fleet.

public virtual void AddInternalLocation(ILocation location)

Parameters

location ILocation: The location to add.

Remarks

Stability: Experimental

AddLocation(string, double?, double?, double?)

(experimental) Adds a remote locations to deploy additional instances to and manage as part of the fleet.

public virtual void AddLocation(string region, double? desiredCapacity = null, double? minSize = null, double? maxSize = null)

Parameters

region string: The AWS region to add.
desiredCapacity double?: The AWS region to add.
minSize double?: The AWS region to add.
maxSize double?: The AWS region to add.

Remarks

Stability: Experimental

FromFleetAttributes(Construct, string, IFleetAttributes)

(experimental) Import an existing fleet from its attributes.

public static IFleet FromFleetAttributes(Construct scope, string id, IFleetAttributes attrs)

Parameters

scope Construct
id string
attrs IFleetAttributes

Returns

IFleet

Remarks

Stability: Experimental

Grant(IGrantable, params string[])

(experimental) Grant the grantee identity permissions to perform actions.

public virtual Grant Grant(IGrantable grantee, params string[] actions)

Parameters

grantee IGrantable
actions string[]

Returns

Grant

Remarks

Stability: Experimental

Metric(string, IMetricOptions?)

(experimental) Return the given named metric for this fleet.

public virtual Metric Metric(string metricName, IMetricOptions? props = null)

Parameters

metricName string
props IMetricOptions

Returns

Metric

Remarks

Stability: Experimental

MetricActiveInstances(IMetricOptions?)

(experimental) Instances with ACTIVE status, which means they are running active server processes.

public virtual Metric MetricActiveInstances(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

The count includes idle instances and those that are hosting one or more game sessions. This metric measures current total instance capacity.

This metric can be used with automatic scaling.

Stability: Experimental

MetricDesiredInstances(IMetricOptions?)

(experimental) Target number of active instances that GameLift is working to maintain in the fleet.

public virtual Metric MetricDesiredInstances(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

With automatic scaling, this value is determined based on the scaling policies currently in force. Without automatic scaling, this value is set manually. This metric is not available when viewing data for fleet metric groups.

Stability: Experimental

MetricIdleInstances(IMetricOptions?)

(experimental) Active instances that are currently hosting zero (0) game sessions.

public virtual Metric MetricIdleInstances(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

This metric measures capacity that is available but unused. This metric can be used with automatic scaling.

Stability: Experimental

MetricInstanceInterruptions(IMetricOptions?)

(experimental) Number of spot instances that have been interrupted.

public virtual Metric MetricInstanceInterruptions(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Stability: Experimental

MetricMaxInstances(IMetricOptions?)

(experimental) Maximum number of instances that are allowed for the fleet.

public virtual Metric MetricMaxInstances(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

A fleet's instance maximum determines the capacity ceiling during manual or automatic scaling up. This metric is not available when viewing data for fleet metric groups.

Stability: Experimental

MetricMinInstances(IMetricOptions?)

(experimental) Minimum number of instances allowed for the fleet.

public virtual Metric MetricMinInstances(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

A fleet's instance minimum determines the capacity floor during manual or automatic scaling down. This metric is not available when viewing data for fleet metric groups.

Stability: Experimental

MetricPercentIdleInstances(IMetricOptions?)

(experimental) Percentage of all active instances that are idle (calculated as IdleInstances / ActiveInstances).

public virtual Metric MetricPercentIdleInstances(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

This metric can be used for automatic scaling.

Stability: Experimental

ParseLocationCapacity(ILocationCapacity?)

(experimental) Base class for new and imported GameLift fleet.

protected virtual CfnFleet.ILocationCapacityProperty? ParseLocationCapacity(ILocationCapacity? capacity = null)

Parameters

capacity ILocationCapacity

Returns

CfnFleet.ILocationCapacityProperty

Remarks

Stability: Experimental

ParseLocations()

(experimental) Base class for new and imported GameLift fleet.

protected virtual CfnFleet.ILocationConfigurationProperty[]? ParseLocations()

Returns

ILocationConfigurationProperty[]

Remarks

Stability: Experimental

ParseResourceCreationLimitPolicy(IFleetProps)

(experimental) Base class for new and imported GameLift fleet.

protected virtual CfnFleet.IResourceCreationLimitPolicyProperty? ParseResourceCreationLimitPolicy(IFleetProps props)

Parameters

props IFleetProps

Returns

CfnFleet.IResourceCreationLimitPolicyProperty

Remarks

Stability: Experimental

ParseRuntimeConfiguration(IFleetProps)

(experimental) Base class for new and imported GameLift fleet.

protected virtual CfnFleet.IRuntimeConfigurationProperty? ParseRuntimeConfiguration(IFleetProps props)

Parameters

props IFleetProps

Returns

CfnFleet.IRuntimeConfigurationProperty

Remarks

Stability: Experimental

WarnVpcPeeringAuthorizations(Construct)

(experimental) Base class for new and imported GameLift fleet.

protected virtual void WarnVpcPeeringAuthorizations(Construct scope)

Parameters

scope Construct

Remarks

Stability: Experimental

Implements

IFleet

IResource

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

IGrantable

IGameSessionQueueDestination