interface CfnContainerFleetProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.GameLift.CfnContainerFleetProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsgamelift#CfnContainerFleetProps |
![]() | software.amazon.awscdk.services.gamelift.CfnContainerFleetProps |
![]() | aws_cdk.aws_gamelift.CfnContainerFleetProps |
![]() | aws-cdk-lib » aws_gamelift » CfnContainerFleetProps |
Properties for defining a CfnContainerFleet
.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_gamelift as gamelift } from 'aws-cdk-lib';
const cfnContainerFleetProps: gamelift.CfnContainerFleetProps = {
fleetRoleArn: 'fleetRoleArn',
// the properties below are optional
billingType: 'billingType',
deploymentConfiguration: {
impairmentStrategy: 'impairmentStrategy',
minimumHealthyPercentage: 123,
protectionStrategy: 'protectionStrategy',
},
description: 'description',
gameServerContainerGroupDefinitionName: 'gameServerContainerGroupDefinitionName',
gameServerContainerGroupsPerInstance: 123,
gameSessionCreationLimitPolicy: {
newGameSessionsPerCreator: 123,
policyPeriodInMinutes: 123,
},
instanceConnectionPortRange: {
fromPort: 123,
toPort: 123,
},
instanceInboundPermissions: [{
fromPort: 123,
ipRange: 'ipRange',
protocol: 'protocol',
toPort: 123,
}],
instanceType: 'instanceType',
locations: [{
location: 'location',
// the properties below are optional
locationCapacity: {
desiredEc2Instances: 123,
maxSize: 123,
minSize: 123,
},
stoppedActions: ['stoppedActions'],
}],
logConfiguration: {
logDestination: 'logDestination',
s3BucketName: 's3BucketName',
},
metricGroups: ['metricGroups'],
newGameSessionProtectionPolicy: 'newGameSessionProtectionPolicy',
perInstanceContainerGroupDefinitionName: 'perInstanceContainerGroupDefinitionName',
scalingPolicies: [{
metricName: 'metricName',
name: 'name',
// the properties below are optional
comparisonOperator: 'comparisonOperator',
evaluationPeriods: 123,
policyType: 'policyType',
scalingAdjustment: 123,
scalingAdjustmentType: 'scalingAdjustmentType',
targetConfiguration: {
targetValue: 123,
},
threshold: 123,
}],
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
Name | Type | Description |
---|---|---|
fleet | string | 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. |
billing | string | Indicates whether the fleet uses On-Demand or Spot instances for this fleet. |
deployment | IResolvable | Deployment | Set of rules for processing a deployment for a container fleet update. |
description? | string | A meaningful description of the container fleet. |
game | string | 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. |
game | number | The number of times to replicate the game server container group on each fleet instance. |
game | IResolvable | Game | A policy that limits the number of game sessions that each individual player can create on instances in this fleet. |
instance | IResolvable | Connection | The set of port numbers to open on each instance in a container fleet. |
instance | IResolvable | IResolvable | Ip [] | The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. |
instance | string | The Amazon EC2 instance type to use for all instances in the fleet. |
locations? | IResolvable | IResolvable | Location [] | |
log | IResolvable | Log | The method that is used to collect container logs for the fleet. |
metric | string[] | The name of an AWS CloudWatch metric group to add this fleet to. |
new | string | Determines whether Amazon GameLift can shut down game sessions on the fleet that are actively running and hosting players. |
per | string | The name of the fleet's per-instance container group definition. |
scaling | IResolvable | IResolvable | Scaling [] | A list of rules that control how a fleet is scaled. |
tags? | Cfn [] | An array of key-value pairs to apply to this resource. |
fleetRoleArn
Type:
string
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.
See Set up an IAM service role . This fleet property can't be changed.
billingType?
Type:
string
(optional)
Indicates whether the fleet uses On-Demand or Spot instances for this fleet.
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
.
deploymentConfiguration?
Type:
IResolvable
|
Deployment
(optional)
Set of rules for processing a deployment for a container fleet update.
description?
Type:
string
(optional)
A meaningful description of the container fleet.
gameServerContainerGroupDefinitionName?
Type:
string
(optional)
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?
Type:
number
(optional)
The number of times to replicate the game server container group on each fleet instance.
gameSessionCreationLimitPolicy?
Type:
IResolvable
|
Game
(optional)
A policy that limits the number of game sessions that each individual player can create on instances in this fleet.
The limit applies for a specified span of time.
instanceConnectionPortRange?
Type:
IResolvable
|
Connection
(optional)
The set of port numbers to open on each instance in a container fleet.
Connection ports are used by inbound traffic to connect with processes that are running in containers on the fleet.
instanceInboundPermissions?
Type:
IResolvable
|
IResolvable
|
Ip
[]
(optional)
The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.
instanceType?
Type:
string
(optional)
The Amazon EC2 instance type to use for all instances in the fleet.
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.
locations?
Type:
IResolvable
|
IResolvable
|
Location
[]
(optional)
logConfiguration?
Type:
IResolvable
|
Log
(optional)
The method that is used to collect container logs for the fleet.
Amazon GameLift saves all standard output for each container in logs, including game session logs.
CLOUDWATCH
-- Send logs to an Amazon CloudWatch log group that you define. Each container emits a log stream, which is organized in the log group.S3
-- Store logs in an Amazon S3 bucket that you define.NONE
-- Don't collect container logs.
metricGroups?
Type:
string[]
(optional)
The name of an AWS CloudWatch metric group to add this fleet to.
Metric groups aggregate metrics for multiple fleets.
newGameSessionProtectionPolicy?
Type:
string
(optional)
Determines whether Amazon GameLift can shut down game sessions on the fleet that are actively running and hosting players.
Amazon GameLift 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 .
- NoProtection -- Game sessions can be shut down during active gameplay.
- FullProtection -- Game sessions in
ACTIVE
status can't be shut down.
perInstanceContainerGroupDefinitionName?
Type:
string
(optional)
The name of the fleet's per-instance container group definition.
scalingPolicies?
Type:
IResolvable
|
IResolvable
|
Scaling
[]
(optional)
A list of rules that control how a fleet is scaled.
tags?
Type:
Cfn
[]
(optional)
An array of key-value pairs to apply to this resource.