Interface ICfnContainerFleetProps

Properties for defining a CfnContainerFleet.

Namespace: Amazon.CDK.AWS.GameLift

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnContainerFleetProps

Syntax (vb)

Public Interface ICfnContainerFleetProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.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 cfnContainerFleetProps = new CfnContainerFleetProps {
                 FleetRoleArn = "fleetRoleArn",

                 // the properties below are optional
                 BillingType = "billingType",
                 DeploymentConfiguration = new DeploymentConfigurationProperty {
                     ImpairmentStrategy = "impairmentStrategy",
                     MinimumHealthyPercentage = 123,
                     ProtectionStrategy = "protectionStrategy"
                 },
                 Description = "description",
                 GameServerContainerGroupDefinitionName = "gameServerContainerGroupDefinitionName",
                 GameServerContainerGroupsPerInstance = 123,
                 GameSessionCreationLimitPolicy = new GameSessionCreationLimitPolicyProperty {
                     NewGameSessionsPerCreator = 123,
                     PolicyPeriodInMinutes = 123
                 },
                 InstanceConnectionPortRange = new ConnectionPortRangeProperty {
                     FromPort = 123,
                     ToPort = 123
                 },
                 InstanceInboundPermissions = new [] { new IpPermissionProperty {
                     FromPort = 123,
                     IpRange = "ipRange",
                     Protocol = "protocol",
                     ToPort = 123
                 } },
                 InstanceType = "instanceType",
                 Locations = new [] { new LocationConfigurationProperty {
                     Location = "location",

                     // the properties below are optional
                     LocationCapacity = new LocationCapacityProperty {
                         MaxSize = 123,
                         MinSize = 123,

                         // the properties below are optional
                         DesiredEc2Instances = 123
                     },
                     StoppedActions = new [] { "stoppedActions" }
                 } },
                 LogConfiguration = new LogConfigurationProperty {
                     LogDestination = "logDestination",
                     LogGroupArn = "logGroupArn",
                     S3BucketName = "s3BucketName"
                 },
                 MetricGroups = new [] { "metricGroups" },
                 NewGameSessionProtectionPolicy = "newGameSessionProtectionPolicy",
                 PerInstanceContainerGroupDefinitionName = "perInstanceContainerGroupDefinitionName",
                 ScalingPolicies = new [] { new ScalingPolicyProperty {
                     MetricName = "metricName",
                     Name = "name",

                     // the properties below are optional
                     ComparisonOperator = "comparisonOperator",
                     EvaluationPeriods = 123,
                     PolicyType = "policyType",
                     ScalingAdjustment = 123,
                     ScalingAdjustmentType = "scalingAdjustmentType",
                     TargetConfiguration = new TargetConfigurationProperty {
                         TargetValue = 123
                     },
                     Threshold = 123
                 } },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Properties

BillingType	Indicates whether the fleet uses On-Demand or Spot instances for this fleet.
DeploymentConfiguration	Set of rules for processing a deployment for a container fleet update.
Description	A meaningful description of the container fleet.
FleetRoleArn	The unique identifier for an AWS Identity and Access Management (IAM) role with permissions to run your containers on resources that are managed by Amazon GameLift Servers.
GameServerContainerGroupDefinitionName	The name of the fleet's game server container group definition, which describes how to deploy containers with your game server build and support software onto each fleet instance.
GameServerContainerGroupsPerInstance	The number of times to replicate the game server container group on each fleet instance.
GameSessionCreationLimitPolicy	A policy that limits the number of game sessions that each individual player can create on instances in this fleet.
InstanceConnectionPortRange	The set of port numbers to open on each instance in a container fleet.
InstanceInboundPermissions	The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.
InstanceType	The Amazon EC2 instance type to use for all instances in the fleet.
Locations	Properties for defining a `CfnContainerFleet`.
LogConfiguration	The method that is used to collect container logs for the fleet.
MetricGroups	The name of an AWS CloudWatch metric group to add this fleet to.
NewGameSessionProtectionPolicy	Determines whether Amazon GameLift Servers can shut down game sessions on the fleet that are actively running and hosting players.
PerInstanceContainerGroupDefinitionName	The name of the fleet's per-instance container group definition.
ScalingPolicies	A list of rules that control how a fleet is scaled.
Tags	An array of key-value pairs to apply to this resource.

Properties

BillingType

Indicates whether the fleet uses On-Demand or Spot instances for this fleet.

string? BillingType { get; }

Property Value

string

Remarks

Learn more about when to use On-Demand versus Spot Instances . You can't update this fleet property.

By default, this property is set to ON_DEMAND .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-billingtype

DeploymentConfiguration

Set of rules for processing a deployment for a container fleet update.

object? DeploymentConfiguration { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-deploymentconfiguration

Type union: either IResolvable or CfnContainerFleet.IDeploymentConfigurationProperty

Description

A meaningful description of the container fleet.

string? Description { get; }

Property Value

string

Remarks

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

FleetRoleArn

The unique identifier for an AWS Identity and Access Management (IAM) role with permissions to run your containers on resources that are managed by Amazon GameLift Servers.

string FleetRoleArn { get; }

Property Value

string

Remarks

See Set up an IAM service role . This fleet property can't be changed.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-fleetrolearn

GameServerContainerGroupDefinitionName

The name of the fleet's game server container group definition, which describes how to deploy containers with your game server build and support software onto each fleet instance.

string? GameServerContainerGroupDefinitionName { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-gameservercontainergroupdefinitionname

GameServerContainerGroupsPerInstance

The number of times to replicate the game server container group on each fleet instance.

double? GameServerContainerGroupsPerInstance { get; }

Property Value

double?

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-gameservercontainergroupsperinstance

GameSessionCreationLimitPolicy

A policy that limits the number of game sessions that each individual player can create on instances in this fleet.

object? GameSessionCreationLimitPolicy { get; }

Property Value

object

Remarks

The limit applies for a specified span of time.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-gamesessioncreationlimitpolicy

Type union: either IResolvable or CfnContainerFleet.IGameSessionCreationLimitPolicyProperty

InstanceConnectionPortRange

The set of port numbers to open on each instance in a container fleet.

object? InstanceConnectionPortRange { get; }

Property Value

object

Remarks

Connection ports are used by inbound traffic to connect with processes that are running in containers on the fleet.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-instanceconnectionportrange

Type union: either IResolvable or CfnContainerFleet.IConnectionPortRangeProperty

InstanceInboundPermissions

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

object? InstanceInboundPermissions { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-instanceinboundpermissions

Type union: either IResolvable or (either IResolvable or CfnContainerFleet.IIpPermissionProperty)[]

InstanceType

The Amazon EC2 instance type to use for all instances in the fleet.

string? InstanceType { get; }

Property Value

string

Remarks

Instance type determines the computing resources and processing power that's available to host your game servers. This includes including CPU, memory, storage, and networking capacity. You can't update this fleet property.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-instancetype

Locations

Properties for defining a CfnContainerFleet.

object? Locations { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or (either IResolvable or CfnContainerFleet.ILocationConfigurationProperty)[]

LogConfiguration

The method that is used to collect container logs for the fleet.

object? LogConfiguration { get; }

Property Value

object

Remarks

Amazon GameLift Servers saves all standard output for each container in logs, including game session logs.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-logconfiguration

Type union: either IResolvable or CfnContainerFleet.ILogConfigurationProperty

MetricGroups

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

string[]? MetricGroups { get; }

Property Value

string[]

Remarks

Metric groups aggregate metrics for multiple fleets.

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

NewGameSessionProtectionPolicy

Determines whether Amazon GameLift Servers can shut down game sessions on the fleet that are actively running and hosting players.

string? NewGameSessionProtectionPolicy { get; }

Property Value

string

Remarks

Amazon GameLift Servers might prompt an instance shutdown when scaling down fleet capacity or when retiring unhealthy instances. You can also set game session protection for individual game sessions using UpdateGameSession .

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

PerInstanceContainerGroupDefinitionName

The name of the fleet's per-instance container group definition.

string? PerInstanceContainerGroupDefinitionName { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-perinstancecontainergroupdefinitionname

ScalingPolicies

A list of rules that control how a fleet is scaled.

object? ScalingPolicies { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or (either IResolvable or CfnContainerFleet.IScalingPolicyProperty)[]