import * as cdk from "../../core/lib"; import * as constructs from "constructs"; import * as cfn_parse from "../../core/lib/helpers-internal"; import { AliasReference, BuildReference, ContainerFleetReference, ContainerGroupDefinitionReference, FleetReference, GameServerGroupReference, GameSessionQueueReference, IAliasRef, IBuildRef, IContainerFleetRef, IContainerGroupDefinitionRef, IFleetRef, IGameServerGroupRef, IGameSessionQueueRef, ILocationRef, IMatchmakingConfigurationRef, IMatchmakingRuleSetRef, IScriptRef, LocationReference, MatchmakingConfigurationReference, MatchmakingRuleSetReference, ScriptReference } from "../../interfaces/generated/aws-gamelift-interfaces.generated"; /** * The `AWS::GameLift::Alias` resource creates an alias for an Amazon GameLift (GameLift) fleet destination. * * There are two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias displays a message instead of routing players to an active fleet. For example, a terminal alias might display a URL link that directs players to an upgrade site. You can use aliases to define destinations in a game session queue or when requesting new game sessions. * * @cloudformationResource AWS::GameLift::Alias * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html */ export declare class CfnAlias extends cdk.CfnResource implements cdk.IInspectable, IAliasRef, cdk.ITaggableV2 { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnAlias from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnAlias; /** * Checks whether the given object is a CfnAlias */ static isCfnAlias(x: any): x is CfnAlias; /** * Creates a new IAliasRef from an ARN */ static fromAliasArn(scope: constructs.Construct, id: string, arn: string): IAliasRef; /** * Creates a new IAliasRef from a aliasId */ static fromAliasId(scope: constructs.Construct, id: string, aliasId: string): IAliasRef; static arnForAlias(resource: IAliasRef): string; /** * Tag Manager which manages the tags for this resource */ readonly cdkTagManager: cdk.TagManager; /** * A human-readable description of the alias. */ private _description?; /** * A descriptive label that is associated with an alias. */ private _name; /** * The routing configuration, including routing type and fleet target, for the alias. */ private _routingStrategy; /** * An array of key-value pairs to apply to this resource. */ private _tags?; /** * Create a new `AWS::GameLift::Alias`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnAliasProps); get aliasRef(): AliasReference; /** * A human-readable description of the alias. */ get description(): string | undefined; /** * A human-readable description of the alias. */ set description(value: string | undefined); /** * A descriptive label that is associated with an alias. */ get name(): string; /** * A descriptive label that is associated with an alias. */ set name(value: string); /** * The routing configuration, including routing type and fleet target, for the alias. */ get routingStrategy(): cdk.IResolvable | CfnAlias.RoutingStrategyProperty; /** * The routing configuration, including routing type and fleet target, for the alias. */ set routingStrategy(value: cdk.IResolvable | CfnAlias.RoutingStrategyProperty); /** * An array of key-value pairs to apply to this resource. */ get tags(): Array | undefined; /** * An array of key-value pairs to apply to this resource. */ set tags(value: Array | undefined); /** * The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) that is assigned to a Amazon GameLift Servers alias resource and uniquely identifies it. ARNs are unique across all Regions. Format is `arn:aws:gamelift:::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912` . In a GameLift alias ARN, the resource ID matches the alias ID value. * * @cloudformationAttribute AliasArn */ get attrAliasArn(): string; /** * A unique identifier for the alias. For example, `arn:aws:gamelift:us-west-1::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912` * * Alias IDs are unique within a Region. * * @cloudformationAttribute AliasId */ get attrAliasId(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } export declare namespace CfnAlias { /** * The routing configuration for a fleet alias. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-alias-routingstrategy.html */ interface RoutingStrategyProperty { /** * A unique identifier for a fleet that the alias points to. * * If you specify `SIMPLE` for the `Type` property, you must specify this property. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-alias-routingstrategy.html#cfn-gamelift-alias-routingstrategy-fleetid */ readonly fleetId?: string; /** * The message text to be used with a terminal routing strategy. * * If you specify `TERMINAL` for the `Type` property, you must specify this property. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-alias-routingstrategy.html#cfn-gamelift-alias-routingstrategy-message */ readonly message?: string; /** * A type of routing strategy. * * Possible routing types include the following: * * - *SIMPLE* - The alias resolves to one specific fleet. Use this type when routing to active fleets. * - *TERMINAL* - The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a `TerminalRoutingStrategyException` with the message that you specified in the `Message` property. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-alias-routingstrategy.html#cfn-gamelift-alias-routingstrategy-type */ readonly type: string; } } /** * Properties for defining a `CfnAlias` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html */ export interface CfnAliasProps { /** * A human-readable description of the alias. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html#cfn-gamelift-alias-description */ readonly description?: string; /** * A descriptive label that is associated with an alias. * * Alias names do not need to be unique. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html#cfn-gamelift-alias-name */ readonly name: string; /** * The routing configuration, including routing type and fleet target, for the alias. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html#cfn-gamelift-alias-routingstrategy */ readonly routingStrategy: cdk.IResolvable | CfnAlias.RoutingStrategyProperty; /** * An array of key-value pairs to apply to this resource. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html#cfn-gamelift-alias-tags */ readonly tags?: Array; } /** * The `AWS::GameLift::Build` resource creates a game server build that is installed and run on instances in an Amazon GameLift fleet. * * This resource points to an Amazon S3 location that contains a zip file with all of the components of the game server build. * * @cloudformationResource AWS::GameLift::Build * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html */ export declare class CfnBuild extends cdk.CfnResource implements cdk.IInspectable, IBuildRef, cdk.ITaggableV2 { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnBuild from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnBuild; /** * Checks whether the given object is a CfnBuild */ static isCfnBuild(x: any): x is CfnBuild; /** * Creates a new IBuildRef from an ARN */ static fromBuildArn(scope: constructs.Construct, id: string, arn: string): IBuildRef; /** * Creates a new IBuildRef from a buildId */ static fromBuildId(scope: constructs.Construct, id: string, buildId: string): IBuildRef; static arnForBuild(resource: IBuildRef): string; /** * Tag Manager which manages the tags for this resource */ readonly cdkTagManager: cdk.TagManager; /** * A descriptive label that is associated with a build. */ private _name?; /** * The operating system that your game server binaries run on. */ private _operatingSystem?; /** * A server SDK version you used when integrating your game server build with Amazon GameLift Servers. */ private _serverSdkVersion?; /** * Information indicating where your game build files are stored. */ private _storageLocation?; /** * An array of key-value pairs to apply to this resource. */ private _tags?; /** * Version information that is associated with this build. */ private _version?; /** * Create a new `AWS::GameLift::Build`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props?: CfnBuildProps); get buildRef(): BuildReference; /** * A descriptive label that is associated with a build. */ get name(): string | undefined; /** * A descriptive label that is associated with a build. */ set name(value: string | undefined); /** * The operating system that your game server binaries run on. */ get operatingSystem(): string | undefined; /** * The operating system that your game server binaries run on. */ set operatingSystem(value: string | undefined); /** * A server SDK version you used when integrating your game server build with Amazon GameLift Servers. */ get serverSdkVersion(): string | undefined; /** * A server SDK version you used when integrating your game server build with Amazon GameLift Servers. */ set serverSdkVersion(value: string | undefined); /** * Information indicating where your game build files are stored. */ get storageLocation(): cdk.IResolvable | CfnBuild.StorageLocationProperty | undefined; /** * Information indicating where your game build files are stored. */ set storageLocation(value: cdk.IResolvable | CfnBuild.StorageLocationProperty | undefined); /** * An array of key-value pairs to apply to this resource. */ get tags(): Array | undefined; /** * An array of key-value pairs to apply to this resource. */ set tags(value: Array | undefined); /** * Version information that is associated with this build. */ get version(): string | undefined; /** * Version information that is associated with this build. */ set version(value: string | undefined); /** * The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) that is assigned to a Amazon GameLift Servers build resource and uniquely identifies it. ARNs are unique across all Regions. Format is `arn:aws:gamelift:::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912` . In a GameLift build ARN, the resource ID matches the *BuildId* value. * * @cloudformationAttribute BuildArn */ get attrBuildArn(): string; /** * A unique identifier for the build. * * @cloudformationAttribute BuildId */ get attrBuildId(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } export declare namespace CfnBuild { /** * The location in Amazon S3 where build or script files are stored for access by Amazon GameLift. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html */ interface StorageLocationProperty { /** * An Amazon S3 bucket identifier. The name of the S3 bucket. * * > Amazon GameLift doesn't support uploading from Amazon S3 buckets with names that contain a dot (.). * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html#cfn-gamelift-build-storagelocation-bucket */ readonly bucket: string; /** * The name of the zip file that contains the build files or script files. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html#cfn-gamelift-build-storagelocation-key */ readonly key: string; /** * A version of a stored file to retrieve, if the object versioning feature is turned on for the S3 bucket. * * Use this parameter to specify a specific version. If this parameter isn't set, Amazon GameLift Servers retrieves the latest version of the file. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html#cfn-gamelift-build-storagelocation-objectversion */ readonly objectVersion?: string; /** * The ARNfor an IAM role that allows Amazon GameLift to access the S3 bucket. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html#cfn-gamelift-build-storagelocation-rolearn */ readonly roleArn: string; } } /** * Properties for defining a `CfnBuild` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html */ export interface CfnBuildProps { /** * A descriptive label that is associated with a build. * * Build names do not need to be unique. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-name */ readonly name?: string; /** * The operating system that your game server binaries run on. * * This value determines the type of fleet resources that you use for this build. If your game build contains multiple executables, they all must run on the same operating system. You must specify a valid operating system in this request. There is no default value. You can't change a build's operating system later. * * > Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the [Amazon Linux 2 FAQs](https://docs.aws.amazon.com/amazon-linux-2/faqs/) . For game servers that are hosted on AL2 and use server SDK version 4.x for Amazon GameLift Servers, first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See [Migrate to server SDK version 5.](https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html) * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-operatingsystem */ readonly operatingSystem?: string; /** * A server SDK version you used when integrating your game server build with Amazon GameLift Servers. * * For more information see [Integrate games with custom game servers](https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-custom-intro.html) . By default Amazon GameLift Servers sets this value to `4.0.2` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-serversdkversion */ readonly serverSdkVersion?: string; /** * Information indicating where your game build files are stored. * * Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon GameLift Servers to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region. * * If a `StorageLocation` is specified, the size of your file can be found in your Amazon S3 bucket. Amazon GameLift Servers will report a `SizeOnDisk` of 0. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-storagelocation */ readonly storageLocation?: cdk.IResolvable | CfnBuild.StorageLocationProperty; /** * An array of key-value pairs to apply to this resource. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-tags */ readonly tags?: Array; /** * Version information that is associated with this build. * * Version strings do not need to be unique. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-version */ readonly version?: string; } /** * The `AWS::GameLift::Fleet` resource creates an Amazon GameLift (GameLift) fleet to host custom game server or Realtime Servers. * * A fleet is a set of EC2 instances, configured with instructions to run game servers on each instance. * * @cloudformationResource AWS::GameLift::Fleet * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html */ export declare class CfnFleet extends cdk.CfnResource implements cdk.IInspectable, IFleetRef, cdk.ITaggableV2 { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnFleet from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnFleet; /** * Checks whether the given object is a CfnFleet */ static isCfnFleet(x: any): x is CfnFleet; /** * Creates a new IFleetRef from an ARN */ static fromFleetArn(scope: constructs.Construct, id: string, arn: string): IFleetRef; /** * Creates a new IFleetRef from a fleetId */ static fromFleetId(scope: constructs.Construct, id: string, fleetId: string): IFleetRef; static arnForFleet(resource: IFleetRef): string; /** * Amazon GameLift Servers Anywhere configuration options. */ private _anywhereConfiguration?; /** * Current resource capacity settings for managed EC2 fleets and managed container fleets. */ private _applyCapacity?; /** * A unique identifier for a build to be deployed on the new fleet. */ private _buildId?; /** * Tag Manager which manages the tags for this resource */ readonly cdkTagManager: cdk.TagManager; /** * Prompts Amazon GameLift Servers to generate a TLS/SSL certificate for the fleet. */ private _certificateConfiguration?; /** * The type of compute resource used to host your game servers. */ private _computeType?; /** * A description for the fleet. */ private _description?; /** * [DEPRECATED] The number of EC2 instances that you want this fleet to host. * * @deprecated this property has been deprecated */ private _desiredEc2Instances?; /** * The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. */ private _ec2InboundPermissions?; /** * The Amazon GameLift Servers-supported Amazon EC2 instance type to use with managed EC2 fleets. */ private _ec2InstanceType?; /** * Indicates whether to use On-Demand or Spot instances for this fleet. */ private _fleetType?; /** * A unique identifier for an IAM role that manages access to your AWS services. */ private _instanceRoleArn?; /** * Indicates that fleet instances maintain a shared credentials file for the IAM role defined in `InstanceRoleArn` . */ private _instanceRoleCredentialsProvider?; /** * A set of remote locations to deploy additional instances to and manage as a multi-location fleet. */ private _locations?; /** * This parameter is no longer used. * * @deprecated this property has been deprecated */ private _logPaths?; /** * [DEPRECATED] The maximum value that is allowed for the fleet's instance count. * * @deprecated this property has been deprecated */ private _maxSize?; /** * The name of an AWS CloudWatch metric group to add this fleet to. */ private _metricGroups?; /** * [DEPRECATED] The minimum value allowed for the fleet's instance count. * * @deprecated this property has been deprecated */ private _minSize?; /** * A descriptive label that is associated with a fleet. */ private _name; /** * The status of termination protection for active game sessions on the fleet. */ private _newGameSessionProtectionPolicy?; /** * Used when peering your Amazon GameLift Servers fleet with a VPC, the unique identifier for the AWS account that owns the VPC. */ private _peerVpcAwsAccountId?; /** * A unique identifier for a VPC with resources to be accessed by your Amazon GameLift Servers fleet. */ private _peerVpcId?; /** * Configuration for player gateway. */ private _playerGatewayConfiguration?; /** * The player gateway mode for the fleet. */ private _playerGatewayMode?; /** * 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. */ private _resourceCreationLimitPolicy?; /** * Instructions for how to launch and maintain server processes on instances in the fleet. */ private _runtimeConfiguration?; /** * Rule that controls how a fleet is scaled. */ private _scalingPolicies?; /** * The unique identifier for a Realtime configuration script to be deployed on fleet instances. */ private _scriptId?; /** * This parameter is no longer used but is retained for backward compatibility. * * @deprecated this property has been deprecated */ private _serverLaunchParameters?; /** * This parameter is no longer used. * * @deprecated this property has been deprecated */ private _serverLaunchPath?; /** * An array of key-value pairs to apply to this resource. */ private _tags?; /** * Create a new `AWS::GameLift::Fleet`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnFleetProps); get fleetRef(): FleetReference; /** * Amazon GameLift Servers Anywhere configuration options. */ get anywhereConfiguration(): CfnFleet.AnywhereConfigurationProperty | cdk.IResolvable | undefined; /** * Amazon GameLift Servers Anywhere configuration options. */ set anywhereConfiguration(value: CfnFleet.AnywhereConfigurationProperty | cdk.IResolvable | undefined); /** * Current resource capacity settings for managed EC2 fleets and managed container fleets. */ get applyCapacity(): string | undefined; /** * Current resource capacity settings for managed EC2 fleets and managed container fleets. */ set applyCapacity(value: string | undefined); /** * A unique identifier for a build to be deployed on the new fleet. */ get buildId(): string | undefined; /** * A unique identifier for a build to be deployed on the new fleet. */ set buildId(value: string | undefined); /** * Prompts Amazon GameLift Servers to generate a TLS/SSL certificate for the fleet. */ get certificateConfiguration(): CfnFleet.CertificateConfigurationProperty | cdk.IResolvable | undefined; /** * Prompts Amazon GameLift Servers to generate a TLS/SSL certificate for the fleet. */ set certificateConfiguration(value: CfnFleet.CertificateConfigurationProperty | cdk.IResolvable | undefined); /** * The type of compute resource used to host your game servers. */ get computeType(): string | undefined; /** * The type of compute resource used to host your game servers. */ set computeType(value: string | undefined); /** * A description for the fleet. */ get description(): string | undefined; /** * A description for the fleet. */ set description(value: string | undefined); /** * [DEPRECATED] The number of EC2 instances that you want this fleet to host. * * @deprecated this property has been deprecated */ get desiredEc2Instances(): number | undefined; /** * [DEPRECATED] The number of EC2 instances that you want this fleet to host. * * @deprecated this property has been deprecated */ set desiredEc2Instances(value: number | undefined); /** * The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. */ get ec2InboundPermissions(): Array | cdk.IResolvable | undefined; /** * The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. */ set ec2InboundPermissions(value: Array | cdk.IResolvable | undefined); /** * The Amazon GameLift Servers-supported Amazon EC2 instance type to use with managed EC2 fleets. */ get ec2InstanceType(): string | undefined; /** * The Amazon GameLift Servers-supported Amazon EC2 instance type to use with managed EC2 fleets. */ set ec2InstanceType(value: string | undefined); /** * Indicates whether to use On-Demand or Spot instances for this fleet. */ get fleetType(): string | undefined; /** * Indicates whether to use On-Demand or Spot instances for this fleet. */ set fleetType(value: string | undefined); /** * A unique identifier for an IAM role that manages access to your AWS services. */ get instanceRoleArn(): string | undefined; /** * A unique identifier for an IAM role that manages access to your AWS services. */ set instanceRoleArn(value: string | undefined); /** * Indicates that fleet instances maintain a shared credentials file for the IAM role defined in `InstanceRoleArn` . */ get instanceRoleCredentialsProvider(): string | undefined; /** * Indicates that fleet instances maintain a shared credentials file for the IAM role defined in `InstanceRoleArn` . */ set instanceRoleCredentialsProvider(value: string | undefined); /** * A set of remote locations to deploy additional instances to and manage as a multi-location fleet. */ get locations(): Array | cdk.IResolvable | undefined; /** * A set of remote locations to deploy additional instances to and manage as a multi-location fleet. */ set locations(value: Array | cdk.IResolvable | undefined); /** * This parameter is no longer used. * * @deprecated this property has been deprecated */ get logPaths(): Array | undefined; /** * This parameter is no longer used. * * @deprecated this property has been deprecated */ set logPaths(value: Array | undefined); /** * [DEPRECATED] The maximum value that is allowed for the fleet's instance count. * * @deprecated this property has been deprecated */ get maxSize(): number | undefined; /** * [DEPRECATED] The maximum value that is allowed for the fleet's instance count. * * @deprecated this property has been deprecated */ set maxSize(value: number | undefined); /** * The name of an AWS CloudWatch metric group to add this fleet to. */ get metricGroups(): Array | undefined; /** * The name of an AWS CloudWatch metric group to add this fleet to. */ set metricGroups(value: Array | undefined); /** * [DEPRECATED] The minimum value allowed for the fleet's instance count. * * @deprecated this property has been deprecated */ get minSize(): number | undefined; /** * [DEPRECATED] The minimum value allowed for the fleet's instance count. * * @deprecated this property has been deprecated */ set minSize(value: number | undefined); /** * A descriptive label that is associated with a fleet. */ get name(): string; /** * A descriptive label that is associated with a fleet. */ set name(value: string); /** * The status of termination protection for active game sessions on the fleet. */ get newGameSessionProtectionPolicy(): string | undefined; /** * The status of termination protection for active game sessions on the fleet. */ set newGameSessionProtectionPolicy(value: string | undefined); /** * Used when peering your Amazon GameLift Servers fleet with a VPC, the unique identifier for the AWS account that owns the VPC. */ get peerVpcAwsAccountId(): string | undefined; /** * Used when peering your Amazon GameLift Servers fleet with a VPC, the unique identifier for the AWS account that owns the VPC. */ set peerVpcAwsAccountId(value: string | undefined); /** * A unique identifier for a VPC with resources to be accessed by your Amazon GameLift Servers fleet. */ get peerVpcId(): string | undefined; /** * A unique identifier for a VPC with resources to be accessed by your Amazon GameLift Servers fleet. */ set peerVpcId(value: string | undefined); /** * Configuration for player gateway. */ get playerGatewayConfiguration(): cdk.IResolvable | CfnFleet.PlayerGatewayConfigurationProperty | undefined; /** * Configuration for player gateway. */ set playerGatewayConfiguration(value: cdk.IResolvable | CfnFleet.PlayerGatewayConfigurationProperty | undefined); /** * The player gateway mode for the fleet. */ get playerGatewayMode(): string | undefined; /** * The player gateway mode for the fleet. */ set playerGatewayMode(value: string | undefined); /** * 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. */ get resourceCreationLimitPolicy(): cdk.IResolvable | CfnFleet.ResourceCreationLimitPolicyProperty | undefined; /** * 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. */ set resourceCreationLimitPolicy(value: cdk.IResolvable | CfnFleet.ResourceCreationLimitPolicyProperty | undefined); /** * Instructions for how to launch and maintain server processes on instances in the fleet. */ get runtimeConfiguration(): cdk.IResolvable | CfnFleet.RuntimeConfigurationProperty | undefined; /** * Instructions for how to launch and maintain server processes on instances in the fleet. */ set runtimeConfiguration(value: cdk.IResolvable | CfnFleet.RuntimeConfigurationProperty | undefined); /** * Rule that controls how a fleet is scaled. */ get scalingPolicies(): Array | cdk.IResolvable | undefined; /** * Rule that controls how a fleet is scaled. */ set scalingPolicies(value: Array | cdk.IResolvable | undefined); /** * The unique identifier for a Realtime configuration script to be deployed on fleet instances. */ get scriptId(): string | undefined; /** * The unique identifier for a Realtime configuration script to be deployed on fleet instances. */ set scriptId(value: string | undefined); /** * This parameter is no longer used but is retained for backward compatibility. * * @deprecated this property has been deprecated */ get serverLaunchParameters(): string | undefined; /** * This parameter is no longer used but is retained for backward compatibility. * * @deprecated this property has been deprecated */ set serverLaunchParameters(value: string | undefined); /** * This parameter is no longer used. * * @deprecated this property has been deprecated */ get serverLaunchPath(): string | undefined; /** * This parameter is no longer used. * * @deprecated this property has been deprecated */ set serverLaunchPath(value: string | undefined); /** * An array of key-value pairs to apply to this resource. */ get tags(): Array | undefined; /** * An array of key-value pairs to apply to this resource. */ set tags(value: Array | undefined); /** * The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) 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:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912` . In a GameLift fleet ARN, the resource ID matches the `FleetId` value. * * @cloudformationAttribute FleetArn */ get attrFleetArn(): string; /** * A unique identifier for the fleet. * * @cloudformationAttribute FleetId */ get attrFleetId(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } export declare namespace CfnFleet { /** * A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an instance in a fleet. * * New game sessions are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges. Fleets with custom game builds must have permissions explicitly set. For Realtime Servers fleets, GameLift automatically opens two port ranges, one for TCP messaging and one for UDP. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ippermission.html */ interface IpPermissionProperty { /** * A starting value for a range of allowed port numbers. * * For fleets using Linux builds, only ports `22` and `1026-60000` are valid. * * For fleets using Windows builds, only ports `1026-60000` are valid. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ippermission.html#cfn-gamelift-fleet-ippermission-fromport */ readonly fromPort: number; /** * A range of allowed IP addresses. * * This value must be expressed in CIDR notation. Example: " `000.000.000.000/[subnet mask]` " or optionally the shortened version " `0.0.0.0/[subnet mask]` ". * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ippermission.html#cfn-gamelift-fleet-ippermission-iprange */ readonly ipRange: string; /** * The network communication protocol used by the fleet. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ippermission.html#cfn-gamelift-fleet-ippermission-protocol */ readonly protocol: string; /** * An ending value for a range of allowed port numbers. * * Port numbers are end-inclusive. This value must be equal to or greater than `FromPort` . * * For fleets using Linux builds, only ports `22` and `1026-60000` are valid. * * For fleets using Windows builds, only ports `1026-60000` are valid. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ippermission.html#cfn-gamelift-fleet-ippermission-toport */ readonly toPort: number; } /** * A remote location where a multi-location fleet can deploy game servers for game hosting. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationconfiguration.html */ interface LocationConfigurationProperty { /** * An AWS Region code, such as `us-west-2` . * * For a list of supported Regions and Local Zones, see [Amazon GameLift Servers service locations](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html) for managed hosting. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationconfiguration.html#cfn-gamelift-fleet-locationconfiguration-location */ readonly location: string; /** * Current resource capacity settings for managed EC2 fleets and managed container fleets. * * For multi-location fleets, location values might refer to a fleet's remote location or its home Region. * * *Returned by:* [DescribeFleetCapacity](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html) , [DescribeFleetLocationCapacity](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html) , [UpdateFleetCapacity](https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html) * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationconfiguration.html#cfn-gamelift-fleet-locationconfiguration-locationcapacity */ readonly locationCapacity?: cdk.IResolvable | CfnFleet.LocationCapacityProperty; /** * The player gateway status for the location. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationconfiguration.html#cfn-gamelift-fleet-locationconfiguration-playergatewaystatus */ readonly playerGatewayStatus?: string; } /** * Current resource capacity settings for managed EC2 fleets and managed container fleets. * * For multi-location fleets, location values might refer to a fleet's remote location or its home Region. * * *Returned by:* [DescribeFleetCapacity](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html) , [DescribeFleetLocationCapacity](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html) , [UpdateFleetCapacity](https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html) * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationcapacity.html */ interface LocationCapacityProperty { /** * The number of Amazon EC2 instances you want to maintain in the specified fleet location. * * This value must fall between the minimum and maximum size limits. Changes in desired instance value can take up to 1 minute to be reflected when viewing the fleet's capacity settings. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationcapacity.html#cfn-gamelift-fleet-locationcapacity-desiredec2instances */ readonly desiredEc2Instances?: number; /** * Configuration options for Amazon GameLift Servers-managed capacity behavior. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationcapacity.html#cfn-gamelift-fleet-locationcapacity-managedcapacityconfiguration */ readonly managedCapacityConfiguration?: cdk.IResolvable | CfnFleet.ManagedCapacityConfigurationProperty; /** * The maximum number of instances that are allowed in the specified fleet location. * * If this parameter is not set, the default is 1. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationcapacity.html#cfn-gamelift-fleet-locationcapacity-maxsize */ readonly maxSize: number; /** * The minimum number of instances that are allowed in the specified fleet location. * * If this parameter is not set, the default is 0. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationcapacity.html#cfn-gamelift-fleet-locationcapacity-minsize */ readonly minSize?: number; } /** * Configuration options for Amazon GameLift Servers-managed capacity behavior. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-managedcapacityconfiguration.html */ interface ManagedCapacityConfigurationProperty { /** * Length of time, in minutes, that Amazon GameLift Servers will wait before scaling in your MinSize and DesiredInstances to 0 after a period with no game session activity. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-managedcapacityconfiguration.html#cfn-gamelift-fleet-managedcapacityconfiguration-scaleinafterinactivityminutes */ readonly scaleInAfterInactivityMinutes?: number; /** * The strategy Amazon GameLift Servers will use to automatically scale your capacity to and from zero in response to game session activity. * * Game session activity refers to any active running sessions or game session requests. When set to SCALE_TO_AND_FROM_ZERO, MinSize must not be specified and will be managed automatically. When set to MANUAL, MinSize is required. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-managedcapacityconfiguration.html#cfn-gamelift-fleet-managedcapacityconfiguration-zerocapacitystrategy */ readonly zeroCapacityStrategy: string; } /** * A collection of server process configurations that describe the set of processes to run on each instance in a fleet. * * Server processes run either an executable in a custom game build or a Realtime Servers script. GameLift launches the configured processes, manages their life cycle, and replaces them as needed. Each instance checks regularly for an updated runtime configuration. * * A GameLift instance is limited to 50 processes running concurrently. To calculate the total number of processes in a runtime configuration, add the values of the `ConcurrentExecutions` parameter for each ServerProcess. Learn more about [Running Multiple Processes on a Fleet](https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html) . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-runtimeconfiguration.html */ interface RuntimeConfigurationProperty { /** * The maximum amount of time (in seconds) allowed to launch a new game session and have it report ready to host players. * * During this time, the game session is in status `ACTIVATING` . If the game session does not become active before the timeout, it is ended and the game session status is changed to `TERMINATED` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-runtimeconfiguration.html#cfn-gamelift-fleet-runtimeconfiguration-gamesessionactivationtimeoutseconds */ readonly gameSessionActivationTimeoutSeconds?: number; /** * The number of game sessions in status `ACTIVATING` to allow on an instance or compute. * * This setting limits the instance resources that can be used for new game activations at any one time. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-runtimeconfiguration.html#cfn-gamelift-fleet-runtimeconfiguration-maxconcurrentgamesessionactivations */ readonly maxConcurrentGameSessionActivations?: number; /** * A collection of server process configurations that identify what server processes to run on fleet computes. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-runtimeconfiguration.html#cfn-gamelift-fleet-runtimeconfiguration-serverprocesses */ readonly serverProcesses?: Array | cdk.IResolvable; } /** * A set of instructions for launching server processes on each instance in a fleet. * * Server processes run either an executable in a custom game build or a Realtime Servers script. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-serverprocess.html */ interface ServerProcessProperty { /** * The number of server processes using this configuration that run concurrently on each instance or compute. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-serverprocess.html#cfn-gamelift-fleet-serverprocess-concurrentexecutions */ readonly concurrentExecutions: number; /** * The location of a game build executable or Realtime script. * * Game builds and Realtime scripts are installed on instances at the root: * * - Windows (custom game builds only): `C:\game` . Example: " `C:\game\MyGame\server.exe` " * - Linux: `/local/game` . Examples: " `/local/game/MyGame/server.exe` " or " `/local/game/MyRealtimeScript.js` " * * > Amazon GameLift Servers doesn't support the use of setup scripts that launch the game executable. For custom game builds, this parameter must indicate the executable that calls the server SDK operations `initSDK()` and `ProcessReady()` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-serverprocess.html#cfn-gamelift-fleet-serverprocess-launchpath */ readonly launchPath: string; /** * An optional list of parameters to pass to the server executable or Realtime script on launch. * * Length Constraints: Minimum length of 1. Maximum length of 1024. * * Pattern: [A-Za-z0-9_:.+\/\\\- =@{},?'\[\]"]+ * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-serverprocess.html#cfn-gamelift-fleet-serverprocess-parameters */ readonly parameters?: string; } /** * Amazon GameLift Servers configuration options for your Anywhere fleets. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-anywhereconfiguration.html */ interface AnywhereConfigurationProperty { /** * The cost to run your fleet per hour. * * Amazon GameLift Servers uses the provided cost of your fleet to balance usage in queues. For more information about queues, see [Setting up queues](https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html) in the *Amazon GameLift Servers Developer Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-anywhereconfiguration.html#cfn-gamelift-fleet-anywhereconfiguration-cost */ readonly cost: string; } /** * A policy that limits the number of game sessions a player can create on the same fleet. * * This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: "An individual player can create a maximum number of new game sessions within a specified time period". * * The policy is evaluated when a player tries to create a new game session. For example, assume you have a policy of 10 new game sessions and a time period of 60 minutes. On receiving a `CreateGameSession` request, Amazon GameLift checks that the player (identified by `CreatorId` ) has created fewer than 10 game sessions in the past 60 minutes. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-resourcecreationlimitpolicy.html */ interface ResourceCreationLimitPolicyProperty { /** * A policy that puts limits on the number of game sessions that a player can create within a specified span of time. * * With this policy, you can control players' ability to consume available resources. * * The policy is evaluated when a player tries to create a new game session. On receiving a `CreateGameSession` request, Amazon GameLift Servers checks that the player (identified by `CreatorId` ) has created fewer than game session limit in the specified time period. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-resourcecreationlimitpolicy.html#cfn-gamelift-fleet-resourcecreationlimitpolicy-newgamesessionspercreator */ readonly newGameSessionsPerCreator?: number; /** * The time span used in evaluating the resource creation limit policy. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-resourcecreationlimitpolicy.html#cfn-gamelift-fleet-resourcecreationlimitpolicy-policyperiodinminutes */ readonly policyPeriodInMinutes?: number; } /** * Determines whether a TLS/SSL certificate is generated for a fleet. * * This feature must be enabled when creating the fleet. All instances in a fleet share the same certificate. The certificate can be retrieved by calling the [GameLift Server SDK](https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html) operation `GetInstanceCertificate` . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-certificateconfiguration.html */ interface CertificateConfigurationProperty { /** * Indicates whether a TLS/SSL certificate is generated for a fleet. * * Valid values include: * * - *GENERATED* - Generate a TLS/SSL certificate for this fleet. * - *DISABLED* - (default) Do not generate a TLS/SSL certificate for this fleet. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-certificateconfiguration.html#cfn-gamelift-fleet-certificateconfiguration-certificatetype */ readonly certificateType: string; } /** * Rule that controls how a fleet is scaled. * * Scaling policies are uniquely identified by the combination of name and fleet ID. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html */ interface ScalingPolicyProperty { /** * Comparison operator to use when measuring a metric against the threshold value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-comparisonoperator */ readonly comparisonOperator?: string; /** * Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-evaluationperiods */ readonly evaluationPeriods?: number; /** * The fleet location. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-location */ readonly location?: string; /** * Name of the Amazon GameLift Servers-defined metric that is used to trigger a scaling adjustment. * * For detailed descriptions of fleet metrics, see [Monitor Amazon GameLift Servers with Amazon CloudWatch](https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html) . * * - *ActivatingGameSessions* -- Game sessions in the process of being created. * - *ActiveGameSessions* -- Game sessions that are currently running. * - *ActiveInstances* -- Fleet instances that are currently running at least one game session. * - *AvailableGameSessions* -- Additional game sessions that fleet could host simultaneously, given current capacity. * - *AvailablePlayerSessions* -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included. * - *CurrentPlayerSessions* -- Player slots in active game sessions that are being used by a player or are reserved for a player. * - *IdleInstances* -- Active instances that are currently hosting zero game sessions. * - *PercentAvailableGameSessions* -- Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy. * - *PercentIdleInstances* -- Percentage of the total number of active instances that are hosting zero game sessions. * - *QueueDepth* -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination. * - *WaitTime* -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-metricname */ readonly metricName: string; /** * A descriptive label that is associated with a fleet's scaling policy. * * Policy names do not need to be unique. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-name */ readonly name: string; /** * The type of scaling policy to create. * * For a target-based policy, set the parameter *MetricName* to 'PercentAvailableGameSessions' and specify a *TargetConfiguration* . For a rule-based policy set the following parameters: *MetricName* , *ComparisonOperator* , *Threshold* , *EvaluationPeriods* , *ScalingAdjustmentType* , and *ScalingAdjustment* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-policytype */ readonly policyType?: string; /** * Amount of adjustment to make, based on the scaling adjustment type. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-scalingadjustment */ readonly scalingAdjustment?: number; /** * The type of adjustment to make to a fleet's instance count. * * - *ChangeInCapacity* -- add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down. * - *ExactCapacity* -- set the instance count to the scaling adjustment value. * - *PercentChangeInCapacity* -- increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-scalingadjustmenttype */ readonly scalingAdjustmentType?: string; /** * Current status of the scaling policy. * * The scaling policy can be in force only when in an `ACTIVE` status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change. * * - *ACTIVE* -- The scaling policy can be used for auto-scaling a fleet. * - *UPDATE_REQUESTED* -- A request to update the scaling policy has been received. * - *UPDATING* -- A change is being made to the scaling policy. * - *DELETE_REQUESTED* -- A request to delete the scaling policy has been received. * - *DELETING* -- The scaling policy is being deleted. * - *DELETED* -- The scaling policy has been deleted. * - *ERROR* -- An error occurred in creating the policy. It should be removed and recreated. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-status */ readonly status?: string; /** * An object that contains settings for a target-based scaling policy. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-targetconfiguration */ readonly targetConfiguration?: cdk.IResolvable | CfnFleet.TargetConfigurationProperty; /** * Metric value used to trigger a scaling event. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-threshold */ readonly threshold?: number; /** * The current status of the fleet's scaling policies in a requested fleet location. * * The status `PENDING_UPDATE` indicates that an update was requested for the fleet but has not yet been completed for the location. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-updatestatus */ readonly updateStatus?: string; } /** * Settings for a target-based scaling policy. * * A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon GameLift Servers to adjust capacity so that the metric returns to the target value. The target configuration specifies settings as needed for the target based policy, including the target value. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-targetconfiguration.html */ interface TargetConfigurationProperty { /** * Desired value to use with a target-based scaling policy. * * The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions). * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-targetconfiguration.html#cfn-gamelift-fleet-targetconfiguration-targetvalue */ readonly targetValue: number; } /** * Configuration for player gateway. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-playergatewayconfiguration.html */ interface PlayerGatewayConfigurationProperty { /** * The IP protocol supported by the game server. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-playergatewayconfiguration.html#cfn-gamelift-fleet-playergatewayconfiguration-gameserveripprotocolsupported */ readonly gameServerIpProtocolSupported?: string; } } /** * Properties for defining a `CfnFleet` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html */ export interface CfnFleetProps { /** * Amazon GameLift Servers Anywhere configuration options. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-anywhereconfiguration */ readonly anywhereConfiguration?: CfnFleet.AnywhereConfigurationProperty | cdk.IResolvable; /** * Current resource capacity settings for managed EC2 fleets and managed container fleets. * * For multi-location fleets, location values might refer to a fleet's remote location or its home Region. * * *Returned by:* [DescribeFleetCapacity](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html) , [DescribeFleetLocationCapacity](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html) , [UpdateFleetCapacity](https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html) * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-applycapacity */ readonly applyCapacity?: string; /** * A unique identifier for a build to be deployed on the new fleet. * * If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a `READY` status. This fleet setting cannot be changed once the fleet is created. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-buildid */ readonly buildId?: string; /** * Prompts Amazon GameLift Servers to generate a TLS/SSL certificate for the fleet. * * Amazon GameLift Servers uses the certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift Servers. By default, the `CertificateConfiguration` is `DISABLED` . You can't change this property after you create the fleet. * * Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition. * * > ACM isn't available in all AWS regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see [Supported Regions](https://docs.aws.amazon.com/acm/latest/userguide/acm-regions.html) in the *Certificate Manager User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-certificateconfiguration */ readonly certificateConfiguration?: CfnFleet.CertificateConfigurationProperty | cdk.IResolvable; /** * The type of compute resource used to host your game servers. * * - `EC2` – The game server build is deployed to Amazon EC2 instances for cloud hosting. This is the default setting. * - `ANYWHERE` – Game servers and supporting software are deployed to compute resources that you provide and manage. With this compute type, you can also set the `AnywhereConfiguration` parameter. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-computetype */ readonly computeType?: string; /** * A description for the fleet. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-description */ readonly description?: string; /** * [DEPRECATED] The number of EC2 instances that you want this fleet to host. * * When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet. * * @deprecated this property has been deprecated * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-desiredec2instances */ readonly desiredEc2Instances?: number; /** * The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. * * Set this parameter for managed EC2 fleets. You can leave this parameter empty when creating the fleet, but you must call [](https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetPortSettings) to set it before players can connect to game sessions. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished. For Amazon GameLift Servers Realtime fleets, Amazon GameLift Servers automatically sets TCP and UDP ranges. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-ec2inboundpermissions */ readonly ec2InboundPermissions?: Array | cdk.IResolvable; /** * The Amazon GameLift Servers-supported Amazon EC2 instance type to use with managed EC2 fleets. * * Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See [Amazon Elastic Compute Cloud Instance Types](https://docs.aws.amazon.com/ec2/instance-types/) for detailed descriptions of Amazon EC2 instance types. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-ec2instancetype */ readonly ec2InstanceType?: string; /** * Indicates whether to use On-Demand or Spot instances for this fleet. * * By default, this property is set to `ON_DEMAND` . Learn more about when to use [On-Demand versus Spot Instances](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot) . This fleet property can't be changed after the fleet is created. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-fleettype */ readonly fleetType?: string; /** * A unique identifier for an IAM role that manages access to your AWS services. * * With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the [IAM dashboard](https://docs.aws.amazon.com/iam/) in the AWS Management Console . Learn more about using on-box credentials for your game servers at [Access external resources from a game server](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html) . This attribute is used with fleets where `ComputeType` is `EC2` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-instancerolearn */ readonly instanceRoleArn?: string; /** * Indicates that fleet instances maintain a shared credentials file for the IAM role defined in `InstanceRoleArn` . * * Shared credentials allow applications that are deployed with the game server executable to communicate with other AWS resources. This property is used only when the game server is integrated with the server SDK version 5.x. For more information about using shared credentials, see [Communicate with other AWS resources from your fleets](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html) . This attribute is used with fleets where `ComputeType` is `EC2` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-instancerolecredentialsprovider */ readonly instanceRoleCredentialsProvider?: string; /** * A set of remote locations to deploy additional instances to and manage as a multi-location fleet. * * Use this parameter when creating a fleet in AWS Regions that support multiple locations. You can add any AWS Region or Local Zone that's supported by Amazon GameLift Servers. Provide a list of one or more AWS Region codes, such as `us-west-2` , or Local Zone names. When using this parameter, Amazon GameLift Servers requires you to include your home location in the request. For a list of supported Regions and Local Zones, see [Amazon GameLift Servers service locations](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html) for managed hosting. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-locations */ readonly locations?: Array | cdk.IResolvable; /** * This parameter is no longer used. * * When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady() * * @deprecated this property has been deprecated * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-logpaths */ readonly logPaths?: Array; /** * [DEPRECATED] The maximum value that is allowed for the fleet's instance count. * * When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value. * * @deprecated this property has been deprecated * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-maxsize */ readonly maxSize?: number; /** * The name of an AWS CloudWatch metric group to add this fleet to. * * A metric group is used to aggregate the metrics for multiple fleets. You can specify an existing metric group name or set a new name to create a new metric group. A fleet can be included in only one metric group at a time. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-metricgroups */ readonly metricGroups?: Array; /** * [DEPRECATED] The minimum value allowed for the fleet's instance count. * * When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value. * * @deprecated this property has been deprecated * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-minsize */ readonly minSize?: number; /** * A descriptive label that is associated with a fleet. * * Fleet names do not need to be unique. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-name */ readonly name: string; /** * The status of termination protection for active game sessions on the fleet. * * By default, this property is set to `NoProtection` . * * - *NoProtection* - Game sessions can be terminated during active gameplay as a result of a scale-down event. * - *FullProtection* - Game sessions in `ACTIVE` status cannot be terminated during a scale-down event. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-newgamesessionprotectionpolicy */ readonly newGameSessionProtectionPolicy?: string; /** * Used when peering your Amazon GameLift Servers fleet with a VPC, the unique identifier for the AWS account that owns the VPC. * * You can find your account ID in the AWS Management Console under account settings. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-peervpcawsaccountid */ readonly peerVpcAwsAccountId?: string; /** * A unique identifier for a VPC with resources to be accessed by your Amazon GameLift Servers fleet. * * The VPC must be in the same Region as your fleet. To look up a VPC ID, use the [VPC Dashboard](https://docs.aws.amazon.com/vpc/) in the AWS Management Console . Learn more about VPC peering in [VPC Peering with Amazon GameLift Servers Fleets](https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html) . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-peervpcid */ readonly peerVpcId?: string; /** * Configuration for player gateway. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-playergatewayconfiguration */ readonly playerGatewayConfiguration?: cdk.IResolvable | CfnFleet.PlayerGatewayConfigurationProperty; /** * The player gateway mode for the fleet. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-playergatewaymode */ readonly playerGatewayMode?: string; /** * 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. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-resourcecreationlimitpolicy */ readonly resourceCreationLimitPolicy?: cdk.IResolvable | CfnFleet.ResourceCreationLimitPolicyProperty; /** * Instructions for how to launch and maintain server processes on instances in the fleet. * * The runtime configuration defines one or more server process configurations, each identifying a build executable or Realtime script file and the number of processes of that type to run concurrently. * * > The `RuntimeConfiguration` parameter is required unless the fleet is being configured using the older parameters `ServerLaunchPath` and `ServerLaunchParameters` , which are still supported for backward compatibility. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-runtimeconfiguration */ readonly runtimeConfiguration?: cdk.IResolvable | CfnFleet.RuntimeConfigurationProperty; /** * Rule that controls how a fleet is scaled. * * Scaling policies are uniquely identified by the combination of name and fleet ID. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-scalingpolicies */ readonly scalingPolicies?: Array | cdk.IResolvable; /** * The unique identifier for a Realtime configuration script to be deployed on fleet instances. * * You can use either the script ID or ARN. Scripts must be uploaded to Amazon GameLift Servers prior to creating the fleet. This fleet property cannot be changed later. * * > You can't use the `!Ref` command to reference a script created with a CloudFormation template for the fleet property `ScriptId` . Instead, use `Fn::GetAtt Script.Arn` or `Fn::GetAtt Script.Id` to retrieve either of these properties as input for `ScriptId` . Alternatively, enter a `ScriptId` string manually. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-scriptid */ readonly scriptId?: string; /** * This parameter is no longer used but is retained for backward compatibility. * * Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath. * * @deprecated this property has been deprecated * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-serverlaunchparameters */ readonly serverLaunchParameters?: string; /** * This parameter is no longer used. * * Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work. * * @deprecated this property has been deprecated * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-serverlaunchpath */ readonly serverLaunchPath?: string; /** * An array of key-value pairs to apply to this resource. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-tags */ readonly tags?: Array; } /** * *This operation is used with the Amazon GameLift FleetIQ solution and game server groups.*. * * Creates a GameLift FleetIQ game server group for managing game hosting on a collection of Amazon EC2 instances for game hosting. This operation creates the game server group, creates an Auto Scaling group in your AWS account , and establishes a link between the two groups. You can view the status of your game server groups in the GameLift console. Game server group metrics and events are emitted to Amazon CloudWatch. * * Before creating a new game server group, you must have the following: * * - An Amazon EC2 launch template that specifies how to launch Amazon EC2 instances with your game server build. For more information, see [Launching an Instance from a Launch Template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) in the *Amazon EC2 User Guide* . * - An IAM role that extends limited access to your AWS account to allow GameLift FleetIQ to create and interact with the Auto Scaling group. For more information, see [Create IAM roles for cross-service interaction](https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-iam-permissions-roles.html) in the *GameLift FleetIQ Developer Guide* . * * To create a new game server group, specify a unique group name, IAM role and Amazon EC2 launch template, and provide a list of instance types that can be used in the group. You must also set initial maximum and minimum limits on the group's instance count. You can optionally set an Auto Scaling policy with target tracking based on a GameLift FleetIQ metric. * * Once the game server group and corresponding Auto Scaling group are created, you have full access to change the Auto Scaling group's configuration as needed. Several properties that are set when creating a game server group, including maximum/minimum size and auto-scaling policy settings, must be updated directly in the Auto Scaling group. Keep in mind that some Auto Scaling group properties are periodically updated by GameLift FleetIQ as part of its balancing activities to optimize for availability and cost. * * *Learn more* * * [GameLift FleetIQ Guide](https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) * * @cloudformationResource AWS::GameLift::GameServerGroup * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html */ export declare class CfnGameServerGroup extends cdk.CfnResource implements cdk.IInspectable, IGameServerGroupRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnGameServerGroup from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnGameServerGroup; /** * Checks whether the given object is a CfnGameServerGroup */ static isCfnGameServerGroup(x: any): x is CfnGameServerGroup; static arnForGameServerGroup(resource: IGameServerGroupRef): string; /** * Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. */ private _autoScalingPolicy?; /** * Indicates how Amazon GameLift Servers FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. */ private _balancingStrategy?; /** * The type of delete to perform. */ private _deleteOption?; /** * A developer-defined identifier for the game server group. */ private _gameServerGroupName; /** * A flag that indicates whether instances in the game server group are protected from early termination. */ private _gameServerProtectionPolicy?; /** * The set of Amazon EC2 instance types that Amazon GameLift Servers FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group. */ private _instanceDefinitions; /** * The Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. */ private _launchTemplate?; /** * The maximum number of instances allowed in the Amazon EC2 Auto Scaling group. */ private _maxSize?; /** * The minimum number of instances allowed in the Amazon EC2 Auto Scaling group. */ private _minSize?; /** * The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) for an IAM role that allows Amazon GameLift Servers to access your Amazon EC2 Auto Scaling groups. */ private _roleArn; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * A list of labels to assign to the new game server group resource. */ private _tagsRaw?; /** * A list of virtual private cloud (VPC) subnets to use with instances in the game server group. */ private _vpcSubnets?; /** * Create a new `AWS::GameLift::GameServerGroup`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnGameServerGroupProps); get gameServerGroupRef(): GameServerGroupReference; /** * Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. */ get autoScalingPolicy(): CfnGameServerGroup.AutoScalingPolicyProperty | cdk.IResolvable | undefined; /** * Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. */ set autoScalingPolicy(value: CfnGameServerGroup.AutoScalingPolicyProperty | cdk.IResolvable | undefined); /** * Indicates how Amazon GameLift Servers FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. */ get balancingStrategy(): string | undefined; /** * Indicates how Amazon GameLift Servers FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. */ set balancingStrategy(value: string | undefined); /** * The type of delete to perform. */ get deleteOption(): string | undefined; /** * The type of delete to perform. */ set deleteOption(value: string | undefined); /** * A developer-defined identifier for the game server group. */ get gameServerGroupName(): string; /** * A developer-defined identifier for the game server group. */ set gameServerGroupName(value: string); /** * A flag that indicates whether instances in the game server group are protected from early termination. */ get gameServerProtectionPolicy(): string | undefined; /** * A flag that indicates whether instances in the game server group are protected from early termination. */ set gameServerProtectionPolicy(value: string | undefined); /** * The set of Amazon EC2 instance types that Amazon GameLift Servers FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group. */ get instanceDefinitions(): Array | cdk.IResolvable; /** * The set of Amazon EC2 instance types that Amazon GameLift Servers FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group. */ set instanceDefinitions(value: Array | cdk.IResolvable); /** * The Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. */ get launchTemplate(): cdk.IResolvable | CfnGameServerGroup.LaunchTemplateProperty | undefined; /** * The Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. */ set launchTemplate(value: cdk.IResolvable | CfnGameServerGroup.LaunchTemplateProperty | undefined); /** * The maximum number of instances allowed in the Amazon EC2 Auto Scaling group. */ get maxSize(): number | undefined; /** * The maximum number of instances allowed in the Amazon EC2 Auto Scaling group. */ set maxSize(value: number | undefined); /** * The minimum number of instances allowed in the Amazon EC2 Auto Scaling group. */ get minSize(): number | undefined; /** * The minimum number of instances allowed in the Amazon EC2 Auto Scaling group. */ set minSize(value: number | undefined); /** * The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) for an IAM role that allows Amazon GameLift Servers to access your Amazon EC2 Auto Scaling groups. */ get roleArn(): string; /** * The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) for an IAM role that allows Amazon GameLift Servers to access your Amazon EC2 Auto Scaling groups. */ set roleArn(value: string); /** * A list of labels to assign to the new game server group resource. */ get tagsRaw(): Array | undefined; /** * A list of labels to assign to the new game server group resource. */ set tagsRaw(value: Array | undefined); /** * A list of virtual private cloud (VPC) subnets to use with instances in the game server group. */ get vpcSubnets(): Array | undefined; /** * A list of virtual private cloud (VPC) subnets to use with instances in the game server group. */ set vpcSubnets(value: Array | undefined); /** * A unique identifier for the auto scaling group. * * @cloudformationAttribute AutoScalingGroupArn */ get attrAutoScalingGroupArn(): string; /** * A unique identifier for the game server group. * * @cloudformationAttribute GameServerGroupArn */ get attrGameServerGroupArn(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } export declare namespace CfnGameServerGroup { /** * *This data type is used with the GameLift FleetIQ and game server groups.*. * * Configuration settings for intelligent automatic scaling that uses target tracking. After the Auto Scaling group is created, all updates to Auto Scaling policies, including changing this policy and adding or removing other policies, is done directly on the Auto Scaling group. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-autoscalingpolicy.html */ interface AutoScalingPolicyProperty { /** * Length of time, in seconds, it takes for a new instance to start new game server processes and register with Amazon GameLift Servers FleetIQ. * * Specifying a warm-up time can be useful, particularly with game servers that take a long time to start up, because it avoids prematurely starting new instances. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-autoscalingpolicy.html#cfn-gamelift-gameservergroup-autoscalingpolicy-estimatedinstancewarmup */ readonly estimatedInstanceWarmup?: number; /** * Settings for a target-based scaling policy applied to Auto Scaling group. * * These settings are used to create a target-based policy that tracks the GameLift FleetIQ metric `PercentUtilizedGameServers` and specifies a target value for the metric. As player usage changes, the policy triggers to adjust the game server group capacity so that the metric returns to the target value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-autoscalingpolicy.html#cfn-gamelift-gameservergroup-autoscalingpolicy-targettrackingconfiguration */ readonly targetTrackingConfiguration: cdk.IResolvable | CfnGameServerGroup.TargetTrackingConfigurationProperty; } /** * *This data type is used with the Amazon GameLift FleetIQ and game server groups.*. * * Settings for a target-based scaling policy as part of a `GameServerGroupAutoScalingPolicy` . These settings are used to create a target-based policy that tracks the GameLift FleetIQ metric `"PercentUtilizedGameServers"` and specifies a target value for the metric. As player usage changes, the policy triggers to adjust the game server group capacity so that the metric returns to the target value. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-targettrackingconfiguration.html */ interface TargetTrackingConfigurationProperty { /** * Desired value to use with a game server group target-based scaling policy. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-targettrackingconfiguration.html#cfn-gamelift-gameservergroup-targettrackingconfiguration-targetvalue */ readonly targetValue: number; } /** * *This data type is used with the GameLift FleetIQ and game server groups.*. * * An Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in a game server group. The launch template is specified when creating a new game server group with `GameServerGroup` . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-launchtemplate.html */ interface LaunchTemplateProperty { /** * A unique identifier for an existing Amazon EC2 launch template. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-launchtemplate.html#cfn-gamelift-gameservergroup-launchtemplate-launchtemplateid */ readonly launchTemplateId?: string; /** * A readable identifier for an existing Amazon EC2 launch template. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-launchtemplate.html#cfn-gamelift-gameservergroup-launchtemplate-launchtemplatename */ readonly launchTemplateName?: string; /** * The version of the Amazon EC2 launch template to use. * * If no version is specified, the default version will be used. With Amazon EC2, you can specify a default version for a launch template. If none is set, the default is the first version created. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-launchtemplate.html#cfn-gamelift-gameservergroup-launchtemplate-version */ readonly version?: string; } /** * *This data type is used with the Amazon GameLift FleetIQ and game server groups.*. * * An allowed instance type for a `GameServerGroup` . All game server groups must have at least two instance types defined for it. GameLift FleetIQ periodically evaluates each defined instance type for viability. It then updates the Auto Scaling group with the list of viable instance types. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-instancedefinition.html */ interface InstanceDefinitionProperty { /** * An Amazon EC2 instance type designation. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-instancedefinition.html#cfn-gamelift-gameservergroup-instancedefinition-instancetype */ readonly instanceType: string; /** * Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group. * * Instance weights are used by Amazon GameLift Servers FleetIQ to calculate the instance type's cost per unit hour and better identify the most cost-effective options. For detailed information on weighting instance capacity, see [Instance Weighting](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html) in the *Amazon Elastic Compute Cloud Auto Scaling User Guide* . Default value is "1". * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-instancedefinition.html#cfn-gamelift-gameservergroup-instancedefinition-weightedcapacity */ readonly weightedCapacity?: string; } } /** * Properties for defining a `CfnGameServerGroup` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html */ export interface CfnGameServerGroupProps { /** * Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. * * The scaling policy uses the metric `"PercentUtilizedGameServers"` to maintain a buffer of idle game servers that can immediately accommodate new games and players. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-autoscalingpolicy */ readonly autoScalingPolicy?: CfnGameServerGroup.AutoScalingPolicyProperty | cdk.IResolvable; /** * Indicates how Amazon GameLift Servers FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. * * Method options include the following: * * - `SPOT_ONLY` - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced. * - `SPOT_PREFERRED` - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances. * - `ON_DEMAND_ONLY` - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-balancingstrategy */ readonly balancingStrategy?: string; /** * The type of delete to perform. * * To delete a game server group, specify the `DeleteOption` . Options include the following: * * - `SAFE_DELETE` – (default) Terminates the game server group and Amazon EC2 Auto Scaling group only when it has no game servers that are in `UTILIZED` status. * - `FORCE_DELETE` – Terminates the game server group, including all active game servers regardless of their utilization status, and the Amazon EC2 Auto Scaling group. * - `RETAIN` – Does a safe delete of the game server group but retains the Amazon EC2 Auto Scaling group as is. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-deleteoption */ readonly deleteOption?: string; /** * A developer-defined identifier for the game server group. * * The name is unique for each Region in each AWS account. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-gameservergroupname */ readonly gameServerGroupName: string; /** * A flag that indicates whether instances in the game server group are protected from early termination. * * Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-gameserverprotectionpolicy */ readonly gameServerProtectionPolicy?: string; /** * The set of Amazon EC2 instance types that Amazon GameLift Servers FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-instancedefinitions */ readonly instanceDefinitions: Array | cdk.IResolvable; /** * The Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. * * You can specify the template using either the template name or ID. For help with creating a launch template, see [Creating a Launch Template for an Auto Scaling Group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon Elastic Compute Cloud Auto Scaling User Guide* . After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs. * * > If you specify network interfaces in your launch template, you must explicitly set the property `AssociatePublicIpAddress` to "true". If no network interface is specified in the launch template, Amazon GameLift Servers FleetIQ uses your account's default VPC. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-launchtemplate */ readonly launchTemplate?: cdk.IResolvable | CfnGameServerGroup.LaunchTemplateProperty; /** * The maximum number of instances allowed in the Amazon EC2 Auto Scaling group. * * During automatic scaling events, Amazon GameLift Servers FleetIQ and EC2 do not scale up the group above this maximum. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-maxsize */ readonly maxSize?: number; /** * The minimum number of instances allowed in the Amazon EC2 Auto Scaling group. * * During automatic scaling events, Amazon GameLift Servers FleetIQ and Amazon EC2 do not scale down the group below this minimum. In production, this value should be set to at least 1. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-minsize */ readonly minSize?: number; /** * The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) for an IAM role that allows Amazon GameLift Servers to access your Amazon EC2 Auto Scaling groups. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-rolearn */ readonly roleArn: string; /** * A list of labels to assign to the new game server group resource. * * Tags are developer-defined key-value pairs. Tagging AWS resources is useful for resource management, access management, and cost allocation. For more information, see [Tagging AWS Resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *AWS General Reference* . Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags, respectively. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-tags */ readonly tags?: Array; /** * A list of virtual private cloud (VPC) subnets to use with instances in the game server group. * * By default, all Amazon GameLift Servers FleetIQ-supported Availability Zones are used. You can use this parameter to specify VPCs that you've set up. This property cannot be updated after the game server group is created, and the corresponding Auto Scaling group will always use the property value that is set with this request, even if the Auto Scaling group is updated directly. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-vpcsubnets */ readonly vpcSubnets?: Array; } /** * The `AWS::GameLift::GameSessionQueue` resource creates a placement queue that processes requests for new game sessions. * * A queue uses FleetIQ algorithms to determine the best placement locations and find an available game server, then prompts the game server to start a new game session. Queues can have destinations (GameLift fleets or aliases), which determine where the queue can place new game sessions. A queue can have destinations with varied fleet type (Spot and On-Demand), instance type, and AWS Region . * * @cloudformationResource AWS::GameLift::GameSessionQueue * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html */ export declare class CfnGameSessionQueue extends cdk.CfnResource implements cdk.IInspectable, IGameSessionQueueRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnGameSessionQueue from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnGameSessionQueue; /** * Checks whether the given object is a CfnGameSessionQueue */ static isCfnGameSessionQueue(x: any): x is CfnGameSessionQueue; /** * Creates a new IGameSessionQueueRef from an ARN */ static fromGameSessionQueueArn(scope: constructs.Construct, id: string, arn: string): IGameSessionQueueRef; /** * Creates a new IGameSessionQueueRef from a gameSessionQueueName */ static fromGameSessionQueueName(scope: constructs.Construct, id: string, gameSessionQueueName: string): IGameSessionQueueRef; static arnForGameSessionQueue(resource: IGameSessionQueueRef): string; /** * Information to be added to all events that are related to this game session queue. */ private _customEventData?; /** * A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. */ private _destinations?; /** * A list of locations where a queue is allowed to place new game sessions. */ private _filterConfiguration?; /** * A descriptive label that is associated with game session queue. */ private _name; /** * An SNS topic ARN that is set up to receive game session placement notifications. */ private _notificationTarget?; /** * A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests. */ private _playerLatencyPolicies?; /** * Custom settings to use when prioritizing destinations and locations for game session placements. */ private _priorityConfiguration?; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * A list of labels to assign to the new game session queue resource. */ private _tagsRaw?; /** * The maximum time, in seconds, that a new game session placement request remains in the queue. */ private _timeoutInSeconds?; /** * Create a new `AWS::GameLift::GameSessionQueue`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnGameSessionQueueProps); get gameSessionQueueRef(): GameSessionQueueReference; /** * Information to be added to all events that are related to this game session queue. */ get customEventData(): string | undefined; /** * Information to be added to all events that are related to this game session queue. */ set customEventData(value: string | undefined); /** * A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. */ get destinations(): Array | cdk.IResolvable | undefined; /** * A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. */ set destinations(value: Array | cdk.IResolvable | undefined); /** * A list of locations where a queue is allowed to place new game sessions. */ get filterConfiguration(): CfnGameSessionQueue.FilterConfigurationProperty | cdk.IResolvable | undefined; /** * A list of locations where a queue is allowed to place new game sessions. */ set filterConfiguration(value: CfnGameSessionQueue.FilterConfigurationProperty | cdk.IResolvable | undefined); /** * A descriptive label that is associated with game session queue. */ get name(): string; /** * A descriptive label that is associated with game session queue. */ set name(value: string); /** * An SNS topic ARN that is set up to receive game session placement notifications. */ get notificationTarget(): string | undefined; /** * An SNS topic ARN that is set up to receive game session placement notifications. */ set notificationTarget(value: string | undefined); /** * A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests. */ get playerLatencyPolicies(): Array | cdk.IResolvable | undefined; /** * A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests. */ set playerLatencyPolicies(value: Array | cdk.IResolvable | undefined); /** * Custom settings to use when prioritizing destinations and locations for game session placements. */ get priorityConfiguration(): cdk.IResolvable | CfnGameSessionQueue.PriorityConfigurationProperty | undefined; /** * Custom settings to use when prioritizing destinations and locations for game session placements. */ set priorityConfiguration(value: cdk.IResolvable | CfnGameSessionQueue.PriorityConfigurationProperty | undefined); /** * A list of labels to assign to the new game session queue resource. */ get tagsRaw(): Array | undefined; /** * A list of labels to assign to the new game session queue resource. */ set tagsRaw(value: Array | undefined); /** * The maximum time, in seconds, that a new game session placement request remains in the queue. */ get timeoutInSeconds(): number | undefined; /** * The maximum time, in seconds, that a new game session placement request remains in the queue. */ set timeoutInSeconds(value: number | undefined); /** * The unique Amazon Resource Name (ARN) for the `GameSessionQueue` . * * @cloudformationAttribute Arn */ get attrArn(): string; /** * A descriptive label that is associated with a game session queue. Names are unique within each Region. * * @cloudformationAttribute Name */ get attrName(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } export declare namespace CfnGameSessionQueue { /** * The queue setting that determines the highest latency allowed for individual players when placing a game session. * * When a latency policy is in force, a game session cannot be placed with any fleet in a Region where a player reports latency higher than the cap. Latency policies are only enforced when the placement request contains player latency information. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-playerlatencypolicy.html */ interface PlayerLatencyPolicyProperty { /** * The maximum latency value that is allowed for any player, in milliseconds. * * All policies must have a value set for this property. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-playerlatencypolicy.html#cfn-gamelift-gamesessionqueue-playerlatencypolicy-maximumindividualplayerlatencymilliseconds */ readonly maximumIndividualPlayerLatencyMilliseconds?: number; /** * The length of time, in seconds, that the policy is enforced while placing a new game session. * * A null value for this property means that the policy is enforced until the queue times out. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-playerlatencypolicy.html#cfn-gamelift-gamesessionqueue-playerlatencypolicy-policydurationseconds */ readonly policyDurationSeconds?: number; } /** * A fleet or alias designated in a game session queue. * * Queues fulfill requests for new game sessions by placing a new game session on any of the queue's destinations. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-gamesessionqueuedestination.html */ interface GameSessionQueueDestinationProperty { /** * The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias. * * ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-gamesessionqueuedestination.html#cfn-gamelift-gamesessionqueue-gamesessionqueuedestination-destinationarn */ readonly destinationArn?: string; } /** * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-destination.html */ interface DestinationProperty { /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-destination.html#cfn-gamelift-gamesessionqueue-destination-destinationarn */ readonly destinationArn?: string; } /** * A list of fleet locations where a game session queue can place new game sessions. * * You can use a filter to temporarily turn off placements for specific locations. For queues that have multi-location fleets, you can use a filter configuration allow placement with some, but not all of these locations. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-filterconfiguration.html */ interface FilterConfigurationProperty { /** * A list of locations to allow game session placement in, in the form of AWS Region codes such as `us-west-2` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-filterconfiguration.html#cfn-gamelift-gamesessionqueue-filterconfiguration-allowedlocations */ readonly allowedLocations?: Array; } /** * Custom prioritization settings for use by a game session queue when placing new game sessions with available game servers. * * When defined, this configuration replaces the default FleetIQ prioritization process, which is as follows: * * - If player latency data is included in a game session request, destinations and locations are prioritized first based on lowest average latency (1), then on lowest hosting cost (2), then on destination list order (3), and finally on location (alphabetical) (4). This approach ensures that the queue's top priority is to place game sessions where average player latency is lowest, and--if latency is the same--where the hosting cost is less, etc. * - If player latency data is not included, destinations and locations are prioritized first on destination list order (1), and then on location (alphabetical) (2). This approach ensures that the queue's top priority is to place game sessions on the first destination fleet listed. If that fleet has multiple locations, the game session is placed on the first location (when listed alphabetically). * * Changing the priority order will affect how game sessions are placed. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-priorityconfiguration.html */ interface PriorityConfigurationProperty { /** * The prioritization order to use for fleet locations, when the `PriorityOrder` property includes `LOCATION` . * * Locations can include AWS Region codes (such as `us-west-2` ), local zones, and custom locations (for Anywhere fleets). Each location must be listed only once. For details, see [Amazon GameLift Servers service locations.](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html) * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-priorityconfiguration.html#cfn-gamelift-gamesessionqueue-priorityconfiguration-locationorder */ readonly locationOrder?: Array; /** * A custom sequence to use when prioritizing where to place new game sessions. Each priority type is listed once. * * - `LATENCY` -- Amazon GameLift Servers prioritizes locations where the average player latency is lowest. Player latency data is provided in each game session placement request. * - `COST` -- Amazon GameLift Servers prioritizes queue destinations with the lowest current hosting costs. Cost is evaluated based on the destination's location, instance type, and fleet type (Spot or On-Demand). * - `DESTINATION` -- Amazon GameLift Servers prioritizes based on the list order of destinations in the queue configuration. * - `LOCATION` -- Amazon GameLift Servers prioritizes based on the provided order of locations, as defined in `LocationOrder` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-priorityconfiguration.html#cfn-gamelift-gamesessionqueue-priorityconfiguration-priorityorder */ readonly priorityOrder?: Array; } } /** * Properties for defining a `CfnGameSessionQueue` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html */ export interface CfnGameSessionQueueProps { /** * Information to be added to all events that are related to this game session queue. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-customeventdata */ readonly customEventData?: string; /** * A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. * * Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-destinations */ readonly destinations?: Array | cdk.IResolvable; /** * A list of locations where a queue is allowed to place new game sessions. * * Locations are specified in the form of AWS Region codes, such as `us-west-2` . If this parameter is not set, game sessions can be placed in any queue location. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-filterconfiguration */ readonly filterConfiguration?: CfnGameSessionQueue.FilterConfigurationProperty | cdk.IResolvable; /** * A descriptive label that is associated with game session queue. * * Queue names must be unique within each Region. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-name */ readonly name: string; /** * An SNS topic ARN that is set up to receive game session placement notifications. * * See [Setting up notifications for game session placement](https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html) . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-notificationtarget */ readonly notificationTarget?: string; /** * A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests. * * Use multiple policies to gradually relax the cap over time if Amazon GameLift Servers can't make a placement. Policies are evaluated in order starting with the lowest maximum latency value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-playerlatencypolicies */ readonly playerLatencyPolicies?: Array | cdk.IResolvable; /** * Custom settings to use when prioritizing destinations and locations for game session placements. * * This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-priorityconfiguration */ readonly priorityConfiguration?: cdk.IResolvable | CfnGameSessionQueue.PriorityConfigurationProperty; /** * A list of labels to assign to the new game session queue resource. * * Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see [Tagging AWS Resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *AWS General Reference* . Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-tags */ readonly tags?: Array; /** * The maximum time, in seconds, that a new game session placement request remains in the queue. * * When a request exceeds this time, the game session placement changes to a `TIMED_OUT` status. If you don't specify a request timeout, the queue uses a default value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-timeoutinseconds */ readonly timeoutInSeconds?: number; } /** * The AWS::GameLift::Location resource creates a custom location for use in an Anywhere fleet. * * @cloudformationResource AWS::GameLift::Location * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-location.html */ export declare class CfnLocation extends cdk.CfnResource implements cdk.IInspectable, ILocationRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnLocation from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnLocation; /** * Checks whether the given object is a CfnLocation */ static isCfnLocation(x: any): x is CfnLocation; static arnForLocation(resource: ILocationRef): string; /** * A descriptive name for the custom location. */ private _locationName; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * A list of labels to assign to the new resource. */ private _tagsRaw?; /** * Create a new `AWS::GameLift::Location`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnLocationProps); get locationRef(): LocationReference; /** * A descriptive name for the custom location. */ get locationName(): string; /** * A descriptive name for the custom location. */ set locationName(value: string); /** * A list of labels to assign to the new resource. */ get tagsRaw(): Array | undefined; /** * A list of labels to assign to the new resource. */ set tagsRaw(value: Array | undefined); /** * A unique identifier for the custom location. For example, `arn:aws:gamelift:[region]::location/location-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912` . * * @cloudformationAttribute LocationArn */ get attrLocationArn(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } /** * Properties for defining a `CfnLocation` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-location.html */ export interface CfnLocationProps { /** * A descriptive name for the custom location. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-location.html#cfn-gamelift-location-locationname */ readonly locationName: string; /** * A list of labels to assign to the new resource. * * Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management, and cost allocation. For more information, see [Tagging AWS Resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *AWS General Rareference* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-location.html#cfn-gamelift-location-tags */ readonly tags?: Array; } /** * The `AWS::GameLift::MatchmakingConfiguration` resource defines a new matchmaking configuration for use with FlexMatch. * * Whether you're using FlexMatch with GameLift hosting or as a standalone matchmaking service, the matchmaking configuration sets out rules for matching players and forming teams. If you're using GameLift hosting, it also defines how to start game sessions for each match. Your matchmaking system can use multiple configurations to handle different game scenarios. All matchmaking requests identify the matchmaking configuration to use and provide player attributes that are consistent with that configuration. * * @cloudformationResource AWS::GameLift::MatchmakingConfiguration * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html */ export declare class CfnMatchmakingConfiguration extends cdk.CfnResource implements cdk.IInspectable, IMatchmakingConfigurationRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnMatchmakingConfiguration from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnMatchmakingConfiguration; /** * Checks whether the given object is a CfnMatchmakingConfiguration */ static isCfnMatchmakingConfiguration(x: any): x is CfnMatchmakingConfiguration; /** * Creates a new IMatchmakingConfigurationRef from an ARN */ static fromMatchmakingConfigurationArn(scope: constructs.Construct, id: string, arn: string): IMatchmakingConfigurationRef; /** * Creates a new IMatchmakingConfigurationRef from a matchmakingConfigurationName */ static fromMatchmakingConfigurationName(scope: constructs.Construct, id: string, matchmakingConfigurationName: string): IMatchmakingConfigurationRef; static arnForMatchmakingConfiguration(resource: IMatchmakingConfigurationRef): string; /** * A flag that determines whether a match that was created with this configuration must be accepted by the matched players. */ private _acceptanceRequired; /** * The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required. */ private _acceptanceTimeoutSeconds?; /** * The number of player slots in a match to keep open for future players. */ private _additionalPlayerCount?; /** * The method used to backfill game sessions that are created with this matchmaking configuration. */ private _backfillMode?; /** * A time stamp indicating when this data object was created. */ private _creationTime?; /** * Information to add to all events related to the matchmaking configuration. */ private _customEventData?; /** * A description for the matchmaking configuration. */ private _description?; /** * Indicates whether this matchmaking configuration is being used with Amazon GameLift Servers hosting or as a standalone matchmaking solution. */ private _flexMatchMode?; /** * A set of custom properties for a game session, formatted as key-value pairs. */ private _gameProperties?; /** * A set of custom game session properties, formatted as a single string value. */ private _gameSessionData?; /** * The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) that is assigned to a Amazon GameLift Servers game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is `arn:aws:gamelift:::gamesessionqueue/` . Queues can be located in any Region. Queues are used to start new Amazon GameLift Servers-hosted game sessions for matches that are created with this matchmaking configuration. If `FlexMatchMode` is set to `STANDALONE` , do not set this parameter. */ private _gameSessionQueueArns?; /** * A unique identifier for the matchmaking configuration. */ private _name; /** * An SNS topic ARN that is set up to receive matchmaking notifications. */ private _notificationTarget?; /** * The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. */ private _requestTimeoutSeconds; /** * The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) associated with the GameLift matchmaking rule set resource that this configuration uses. */ private _ruleSetArn?; /** * A unique identifier for the matchmaking rule set to use with this configuration. */ private _ruleSetName; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * A list of labels to assign to the new matchmaking configuration resource. */ private _tagsRaw?; /** * Create a new `AWS::GameLift::MatchmakingConfiguration`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnMatchmakingConfigurationProps); get matchmakingConfigurationRef(): MatchmakingConfigurationReference; /** * A flag that determines whether a match that was created with this configuration must be accepted by the matched players. */ get acceptanceRequired(): boolean | cdk.IResolvable; /** * A flag that determines whether a match that was created with this configuration must be accepted by the matched players. */ set acceptanceRequired(value: boolean | cdk.IResolvable); /** * The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required. */ get acceptanceTimeoutSeconds(): number | undefined; /** * The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required. */ set acceptanceTimeoutSeconds(value: number | undefined); /** * The number of player slots in a match to keep open for future players. */ get additionalPlayerCount(): number | undefined; /** * The number of player slots in a match to keep open for future players. */ set additionalPlayerCount(value: number | undefined); /** * The method used to backfill game sessions that are created with this matchmaking configuration. */ get backfillMode(): string | undefined; /** * The method used to backfill game sessions that are created with this matchmaking configuration. */ set backfillMode(value: string | undefined); /** * A time stamp indicating when this data object was created. */ get creationTime(): string | undefined; /** * A time stamp indicating when this data object was created. */ set creationTime(value: string | undefined); /** * Information to add to all events related to the matchmaking configuration. */ get customEventData(): string | undefined; /** * Information to add to all events related to the matchmaking configuration. */ set customEventData(value: string | undefined); /** * A description for the matchmaking configuration. */ get description(): string | undefined; /** * A description for the matchmaking configuration. */ set description(value: string | undefined); /** * Indicates whether this matchmaking configuration is being used with Amazon GameLift Servers hosting or as a standalone matchmaking solution. */ get flexMatchMode(): string | undefined; /** * Indicates whether this matchmaking configuration is being used with Amazon GameLift Servers hosting or as a standalone matchmaking solution. */ set flexMatchMode(value: string | undefined); /** * A set of custom properties for a game session, formatted as key-value pairs. */ get gameProperties(): Array | cdk.IResolvable | undefined; /** * A set of custom properties for a game session, formatted as key-value pairs. */ set gameProperties(value: Array | cdk.IResolvable | undefined); /** * A set of custom game session properties, formatted as a single string value. */ get gameSessionData(): string | undefined; /** * A set of custom game session properties, formatted as a single string value. */ set gameSessionData(value: string | undefined); /** * The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) that is assigned to a Amazon GameLift Servers game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is `arn:aws:gamelift:::gamesessionqueue/` . Queues can be located in any Region. Queues are used to start new Amazon GameLift Servers-hosted game sessions for matches that are created with this matchmaking configuration. If `FlexMatchMode` is set to `STANDALONE` , do not set this parameter. */ get gameSessionQueueArns(): Array | undefined; /** * The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) that is assigned to a Amazon GameLift Servers game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is `arn:aws:gamelift:::gamesessionqueue/` . Queues can be located in any Region. Queues are used to start new Amazon GameLift Servers-hosted game sessions for matches that are created with this matchmaking configuration. If `FlexMatchMode` is set to `STANDALONE` , do not set this parameter. */ set gameSessionQueueArns(value: Array | undefined); /** * A unique identifier for the matchmaking configuration. */ get name(): string; /** * A unique identifier for the matchmaking configuration. */ set name(value: string); /** * An SNS topic ARN that is set up to receive matchmaking notifications. */ get notificationTarget(): string | undefined; /** * An SNS topic ARN that is set up to receive matchmaking notifications. */ set notificationTarget(value: string | undefined); /** * The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. */ get requestTimeoutSeconds(): number; /** * The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. */ set requestTimeoutSeconds(value: number); /** * The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) associated with the GameLift matchmaking rule set resource that this configuration uses. */ get ruleSetArn(): string | undefined; /** * The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) associated with the GameLift matchmaking rule set resource that this configuration uses. */ set ruleSetArn(value: string | undefined); /** * A unique identifier for the matchmaking rule set to use with this configuration. */ get ruleSetName(): string; /** * A unique identifier for the matchmaking rule set to use with this configuration. */ set ruleSetName(value: string); /** * A list of labels to assign to the new matchmaking configuration resource. */ get tagsRaw(): Array | undefined; /** * A list of labels to assign to the new matchmaking configuration resource. */ set tagsRaw(value: Array | undefined); /** * The unique Amazon Resource Name (ARN) for the `MatchmakingConfiguration` . * * @cloudformationAttribute Arn */ get attrArn(): string; /** * The `MatchmakingConfiguration` name, which is unique. * * @cloudformationAttribute Name */ get attrName(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } export declare namespace CfnMatchmakingConfiguration { /** * This key-value pair can store custom data about a game session. * * For example, you might use a `GameProperty` to track a game session's map, level of difficulty, or remaining time. The difficulty level could be specified like this: `{"Key": "difficulty", "Value":"Novice"}` . * * You can set game properties when creating a game session. You can also modify game properties of an active game session. When searching for game sessions, you can filter on game property keys and values. You can't delete game properties from a game session. * * For examples of working with game properties, see [Create a game session with properties](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#game-properties) . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-matchmakingconfiguration-gameproperty.html */ interface GamePropertyProperty { /** * The game property identifier. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-matchmakingconfiguration-gameproperty.html#cfn-gamelift-matchmakingconfiguration-gameproperty-key */ readonly key: string; /** * The game property value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-matchmakingconfiguration-gameproperty.html#cfn-gamelift-matchmakingconfiguration-gameproperty-value */ readonly value: string; } } /** * Properties for defining a `CfnMatchmakingConfiguration` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html */ export interface CfnMatchmakingConfigurationProps { /** * A flag that determines whether a match that was created with this configuration must be accepted by the matched players. * * To require acceptance, set to `TRUE` . With this option enabled, matchmaking tickets use the status `REQUIRES_ACCEPTANCE` to indicate when a completed potential match is waiting for player acceptance. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-acceptancerequired */ readonly acceptanceRequired: boolean | cdk.IResolvable; /** * The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-acceptancetimeoutseconds */ readonly acceptanceTimeoutSeconds?: number; /** * The number of player slots in a match to keep open for future players. * * For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. This parameter is not used if `FlexMatchMode` is set to `STANDALONE` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-additionalplayercount */ readonly additionalPlayerCount?: number; /** * The method used to backfill game sessions that are created with this matchmaking configuration. * * Specify `MANUAL` when your game manages backfill requests manually or does not use the match backfill feature. Specify `AUTOMATIC` to have GameLift create a `StartMatchBackfill` request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in [Backfill Existing Games with FlexMatch](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html) . Automatic backfill is not available when `FlexMatchMode` is set to `STANDALONE` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-backfillmode */ readonly backfillMode?: string; /** * A time stamp indicating when this data object was created. * * Format is a number expressed in Unix time as milliseconds (for example `"1469498468.057"` ). * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-creationtime */ readonly creationTime?: string; /** * Information to add to all events related to the matchmaking configuration. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-customeventdata */ readonly customEventData?: string; /** * A description for the matchmaking configuration. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-description */ readonly description?: string; /** * Indicates whether this matchmaking configuration is being used with Amazon GameLift Servers hosting or as a standalone matchmaking solution. * * - *STANDALONE* - FlexMatch forms matches and returns match information, including players and team assignments, in a [MatchmakingSucceeded](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded) event. * - *WITH_QUEUE* - FlexMatch forms matches and uses the specified Amazon GameLift Servers queue to start a game session for the match. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-flexmatchmode */ readonly flexMatchMode?: string; /** * A set of custom properties for a game session, formatted as key-value pairs. * * These properties are passed to a game server process with a request to start a new game session. See [Start a Game Session](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession) . This parameter is not used if `FlexMatchMode` is set to `STANDALONE` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-gameproperties */ readonly gameProperties?: Array | cdk.IResolvable; /** * A set of custom game session properties, formatted as a single string value. * * This data is passed to a game server process with a request to start a new game session. See [Start a Game Session](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession) . This parameter is not used if `FlexMatchMode` is set to `STANDALONE` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-gamesessiondata */ readonly gameSessionData?: string; /** * The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) that is assigned to a Amazon GameLift Servers game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is `arn:aws:gamelift:::gamesessionqueue/` . Queues can be located in any Region. Queues are used to start new Amazon GameLift Servers-hosted game sessions for matches that are created with this matchmaking configuration. If `FlexMatchMode` is set to `STANDALONE` , do not set this parameter. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-gamesessionqueuearns */ readonly gameSessionQueueArns?: Array; /** * A unique identifier for the matchmaking configuration. * * This name is used to identify the configuration associated with a matchmaking request or ticket. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-name */ readonly name: string; /** * An SNS topic ARN that is set up to receive matchmaking notifications. * * See [Setting up notifications for matchmaking](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html) for more information. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-notificationtarget */ readonly notificationTarget?: string; /** * The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. * * Requests that fail due to timing out can be resubmitted as needed. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-requesttimeoutseconds */ readonly requestTimeoutSeconds: number; /** * The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) associated with the GameLift matchmaking rule set resource that this configuration uses. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-rulesetarn */ readonly ruleSetArn?: string; /** * A unique identifier for the matchmaking rule set to use with this configuration. * * You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-rulesetname */ readonly ruleSetName: string; /** * A list of labels to assign to the new matchmaking configuration resource. * * Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see [Tagging AWS Resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *AWS General Reference* . Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-tags */ readonly tags?: Array; } /** * Creates a new rule set for FlexMatch matchmaking. * * A rule set describes the type of match to create, such as the number and size of teams. It also sets the parameters for acceptable player matches, such as minimum skill level or character type. * * To create a matchmaking rule set, provide unique rule set name and the rule set body in JSON format. Rule sets must be defined in the same Region as the matchmaking configuration they are used with. * * Since matchmaking rule sets cannot be edited, it is a good idea to check the rule set syntax. * * *Learn more* * * - [Build a rule set](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html) * - [Design a matchmaker](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html) * - [Matchmaking with FlexMatch](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-intro.html) * * @cloudformationResource AWS::GameLift::MatchmakingRuleSet * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingruleset.html */ export declare class CfnMatchmakingRuleSet extends cdk.CfnResource implements cdk.IInspectable, IMatchmakingRuleSetRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnMatchmakingRuleSet from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnMatchmakingRuleSet; /** * Checks whether the given object is a CfnMatchmakingRuleSet */ static isCfnMatchmakingRuleSet(x: any): x is CfnMatchmakingRuleSet; /** * Creates a new IMatchmakingRuleSetRef from an ARN */ static fromMatchmakingRuleSetArn(scope: constructs.Construct, id: string, arn: string): IMatchmakingRuleSetRef; /** * Creates a new IMatchmakingRuleSetRef from a matchmakingRuleSetName */ static fromMatchmakingRuleSetName(scope: constructs.Construct, id: string, matchmakingRuleSetName: string): IMatchmakingRuleSetRef; static arnForMatchmakingRuleSet(resource: IMatchmakingRuleSetRef): string; /** * A unique identifier for the matchmaking rule set. */ private _name; /** * A collection of matchmaking rules, formatted as a JSON string. */ private _ruleSetBody; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * A list of labels to assign to the new matchmaking rule set resource. */ private _tagsRaw?; /** * Create a new `AWS::GameLift::MatchmakingRuleSet`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnMatchmakingRuleSetProps); get matchmakingRuleSetRef(): MatchmakingRuleSetReference; /** * A unique identifier for the matchmaking rule set. */ get name(): string; /** * A unique identifier for the matchmaking rule set. */ set name(value: string); /** * A collection of matchmaking rules, formatted as a JSON string. */ get ruleSetBody(): string; /** * A collection of matchmaking rules, formatted as a JSON string. */ set ruleSetBody(value: string); /** * A list of labels to assign to the new matchmaking rule set resource. */ get tagsRaw(): Array | undefined; /** * A list of labels to assign to the new matchmaking rule set resource. */ set tagsRaw(value: Array | undefined); /** * The unique Amazon Resource Name (ARN) assigned to the rule set. * * @cloudformationAttribute Arn */ get attrArn(): string; /** * A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example `"1469498468.057"` ). * * @cloudformationAttribute CreationTime */ get attrCreationTime(): string; /** * The unique name of the rule set. * * @cloudformationAttribute Name */ get attrName(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } /** * Properties for defining a `CfnMatchmakingRuleSet` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingruleset.html */ export interface CfnMatchmakingRuleSetProps { /** * A unique identifier for the matchmaking rule set. * * A matchmaking configuration identifies the rule set it uses by this name value. Note that the rule set name is different from the optional `name` field in the rule set body. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingruleset.html#cfn-gamelift-matchmakingruleset-name */ readonly name: string; /** * A collection of matchmaking rules, formatted as a JSON string. * * Comments are not allowed in JSON, but most elements support a description field. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingruleset.html#cfn-gamelift-matchmakingruleset-rulesetbody */ readonly ruleSetBody: string; /** * A list of labels to assign to the new matchmaking rule set resource. * * Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see [Tagging AWS Resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *AWS General Reference* . Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingruleset.html#cfn-gamelift-matchmakingruleset-tags */ readonly tags?: Array; } /** * The `AWS::GameLift::Script` resource creates a new script record for your Realtime Servers script. * * Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session. * * @cloudformationResource AWS::GameLift::Script * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html */ export declare class CfnScript extends cdk.CfnResource implements cdk.IInspectable, IScriptRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnScript from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnScript; /** * Checks whether the given object is a CfnScript */ static isCfnScript(x: any): x is CfnScript; /** * Creates a new IScriptRef from an ARN */ static fromScriptArn(scope: constructs.Construct, id: string, arn: string): IScriptRef; /** * Creates a new IScriptRef from a scriptId */ static fromScriptId(scope: constructs.Construct, id: string, scriptId: string): IScriptRef; static arnForScript(resource: IScriptRef): string; /** * A descriptive label that is associated with a script. */ private _name?; /** * The Node.js version used for execution of the Realtime script. */ private _nodeJsVersion?; /** * The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. */ private _storageLocation; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * A list of labels to assign to the new script resource. */ private _tagsRaw?; /** * The version that is associated with a build or script. */ private _version?; /** * Create a new `AWS::GameLift::Script`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnScriptProps); get scriptRef(): ScriptReference; /** * A descriptive label that is associated with a script. */ get name(): string | undefined; /** * A descriptive label that is associated with a script. */ set name(value: string | undefined); /** * The Node.js version used for execution of the Realtime script. */ get nodeJsVersion(): string | undefined; /** * The Node.js version used for execution of the Realtime script. */ set nodeJsVersion(value: string | undefined); /** * The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. */ get storageLocation(): cdk.IResolvable | CfnScript.S3LocationProperty; /** * The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. */ set storageLocation(value: cdk.IResolvable | CfnScript.S3LocationProperty); /** * A list of labels to assign to the new script resource. */ get tagsRaw(): Array | undefined; /** * A list of labels to assign to the new script resource. */ set tagsRaw(value: Array | undefined); /** * The version that is associated with a build or script. */ get version(): string | undefined; /** * The version that is associated with a build or script. */ set version(value: string | undefined); /** * The unique Amazon Resource Name (ARN) for the script. * * @cloudformationAttribute Arn */ get attrArn(): string; /** * A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example `"1469498468.057"` ). * * @cloudformationAttribute CreationTime */ get attrCreationTime(): string; /** * A unique identifier for a Realtime script. * * @cloudformationAttribute Id */ get attrId(): string; /** * The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0". * * @cloudformationAttribute SizeOnDisk */ get attrSizeOnDisk(): number; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } export declare namespace CfnScript { /** * The location in Amazon S3 where build or script files can be stored for access by Amazon GameLift. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html */ interface S3LocationProperty { /** * An Amazon S3 bucket identifier. Thename of the S3 bucket. * * > Amazon GameLift Servers doesn't support uploading from Amazon S3 buckets with names that contain a dot (.). * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html#cfn-gamelift-script-s3location-bucket */ readonly bucket: string; /** * The name of the zip file that contains the build files or script files. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html#cfn-gamelift-script-s3location-key */ readonly key: string; /** * The version of the file, if object versioning is turned on for the bucket. * * Amazon GameLift Servers uses this information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the file. If not set, the latest version of the file is retrieved. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html#cfn-gamelift-script-s3location-objectversion */ readonly objectVersion?: string; /** * The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) for an IAM role that allows Amazon GameLift Servers to access the S3 bucket. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html#cfn-gamelift-script-s3location-rolearn */ readonly roleArn: string; } } /** * Properties for defining a `CfnScript` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html */ export interface CfnScriptProps { /** * A descriptive label that is associated with a script. * * Script names do not need to be unique. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html#cfn-gamelift-script-name */ readonly name?: string; /** * The Node.js version used for execution of the Realtime script. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html#cfn-gamelift-script-nodejsversion */ readonly nodeJsVersion?: string; /** * The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. * * The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift Servers to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift Servers uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the `ObjectVersion` parameter to specify an earlier version. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html#cfn-gamelift-script-storagelocation */ readonly storageLocation: cdk.IResolvable | CfnScript.S3LocationProperty; /** * A list of labels to assign to the new script resource. * * Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see [Tagging AWS Resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *AWS General Reference* . Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html#cfn-gamelift-script-tags */ readonly tags?: Array; /** * The version that is associated with a build or script. * * Version strings do not need to be unique. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html#cfn-gamelift-script-version */ readonly version?: string; } /** * Describes an Amazon GameLift Servers managed container fleet. * * @cloudformationResource AWS::GameLift::ContainerFleet * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html */ export declare class CfnContainerFleet extends cdk.CfnResource implements cdk.IInspectable, IContainerFleetRef, cdk.ITaggableV2 { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnContainerFleet from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnContainerFleet; /** * Checks whether the given object is a CfnContainerFleet */ static isCfnContainerFleet(x: any): x is CfnContainerFleet; /** * Creates a new IContainerFleetRef from an ARN */ static fromContainerFleetArn(scope: constructs.Construct, id: string, arn: string): IContainerFleetRef; /** * Creates a new IContainerFleetRef from a fleetId */ static fromFleetId(scope: constructs.Construct, id: string, fleetId: string): IContainerFleetRef; static arnForContainerFleet(resource: IContainerFleetRef): string; /** * Indicates whether the fleet uses On-Demand or Spot instances for this fleet. */ private _billingType?; /** * Tag Manager which manages the tags for this resource */ readonly cdkTagManager: cdk.TagManager; /** * Set of rules for processing a deployment for a container fleet update. */ private _deploymentConfiguration?; /** * A meaningful description of the container fleet. */ private _description?; /** * 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. */ private _fleetRoleArn; /** * 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. */ private _gameServerContainerGroupDefinitionName?; /** * The number of times to replicate the game server container group on each fleet instance. */ private _gameServerContainerGroupsPerInstance?; /** * A policy that limits the number of game sessions that each individual player can create on instances in this fleet. */ private _gameSessionCreationLimitPolicy?; /** * The set of port numbers to open on each instance in a container fleet. */ private _instanceConnectionPortRange?; /** * The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. */ private _instanceInboundPermissions?; /** * The Amazon EC2 instance type to use for all instances in the fleet. */ private _instanceType?; private _locations?; /** * The method that is used to collect container logs for the fleet. */ private _logConfiguration?; /** * The name of an AWS CloudWatch metric group to add this fleet to. */ private _metricGroups?; /** * Determines whether Amazon GameLift Servers can shut down game sessions on the fleet that are actively running and hosting players. */ private _newGameSessionProtectionPolicy?; /** * The name of the fleet's per-instance container group definition. */ private _perInstanceContainerGroupDefinitionName?; /** * The player gateway mode for the container fleet. */ private _playerGatewayMode?; /** * A list of rules that control how a fleet is scaled. */ private _scalingPolicies?; /** * An array of key-value pairs to apply to this resource. */ private _tags?; /** * Create a new `AWS::GameLift::ContainerFleet`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnContainerFleetProps); get containerFleetRef(): ContainerFleetReference; /** * Indicates whether the fleet uses On-Demand or Spot instances for this fleet. */ get billingType(): string | undefined; /** * Indicates whether the fleet uses On-Demand or Spot instances for this fleet. */ set billingType(value: string | undefined); /** * Set of rules for processing a deployment for a container fleet update. */ get deploymentConfiguration(): CfnContainerFleet.DeploymentConfigurationProperty | cdk.IResolvable | undefined; /** * Set of rules for processing a deployment for a container fleet update. */ set deploymentConfiguration(value: CfnContainerFleet.DeploymentConfigurationProperty | cdk.IResolvable | undefined); /** * A meaningful description of the container fleet. */ get description(): string | undefined; /** * A meaningful description of the container fleet. */ set description(value: string | undefined); /** * 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. */ get fleetRoleArn(): 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 Servers. */ set fleetRoleArn(value: 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. */ get gameServerContainerGroupDefinitionName(): string | undefined; /** * 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. */ set gameServerContainerGroupDefinitionName(value: string | undefined); /** * The number of times to replicate the game server container group on each fleet instance. */ get gameServerContainerGroupsPerInstance(): number | undefined; /** * The number of times to replicate the game server container group on each fleet instance. */ set gameServerContainerGroupsPerInstance(value: number | undefined); /** * A policy that limits the number of game sessions that each individual player can create on instances in this fleet. */ get gameSessionCreationLimitPolicy(): CfnContainerFleet.GameSessionCreationLimitPolicyProperty | cdk.IResolvable | undefined; /** * A policy that limits the number of game sessions that each individual player can create on instances in this fleet. */ set gameSessionCreationLimitPolicy(value: CfnContainerFleet.GameSessionCreationLimitPolicyProperty | cdk.IResolvable | undefined); /** * The set of port numbers to open on each instance in a container fleet. */ get instanceConnectionPortRange(): CfnContainerFleet.ConnectionPortRangeProperty | cdk.IResolvable | undefined; /** * The set of port numbers to open on each instance in a container fleet. */ set instanceConnectionPortRange(value: CfnContainerFleet.ConnectionPortRangeProperty | cdk.IResolvable | undefined); /** * The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. */ get instanceInboundPermissions(): Array | cdk.IResolvable | undefined; /** * The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. */ set instanceInboundPermissions(value: Array | cdk.IResolvable | undefined); /** * The Amazon EC2 instance type to use for all instances in the fleet. */ get instanceType(): string | undefined; /** * The Amazon EC2 instance type to use for all instances in the fleet. */ set instanceType(value: string | undefined); get locations(): Array | cdk.IResolvable | undefined; set locations(value: Array | cdk.IResolvable | undefined); /** * The method that is used to collect container logs for the fleet. */ get logConfiguration(): cdk.IResolvable | CfnContainerFleet.LogConfigurationProperty | undefined; /** * The method that is used to collect container logs for the fleet. */ set logConfiguration(value: cdk.IResolvable | CfnContainerFleet.LogConfigurationProperty | undefined); /** * The name of an AWS CloudWatch metric group to add this fleet to. */ get metricGroups(): Array | undefined; /** * The name of an AWS CloudWatch metric group to add this fleet to. */ set metricGroups(value: Array | undefined); /** * Determines whether Amazon GameLift Servers can shut down game sessions on the fleet that are actively running and hosting players. */ get newGameSessionProtectionPolicy(): string | undefined; /** * Determines whether Amazon GameLift Servers can shut down game sessions on the fleet that are actively running and hosting players. */ set newGameSessionProtectionPolicy(value: string | undefined); /** * The name of the fleet's per-instance container group definition. */ get perInstanceContainerGroupDefinitionName(): string | undefined; /** * The name of the fleet's per-instance container group definition. */ set perInstanceContainerGroupDefinitionName(value: string | undefined); /** * The player gateway mode for the container fleet. */ get playerGatewayMode(): string | undefined; /** * The player gateway mode for the container fleet. */ set playerGatewayMode(value: string | undefined); /** * A list of rules that control how a fleet is scaled. */ get scalingPolicies(): Array | cdk.IResolvable | undefined; /** * A list of rules that control how a fleet is scaled. */ set scalingPolicies(value: Array | cdk.IResolvable | undefined); /** * An array of key-value pairs to apply to this resource. */ get tags(): Array | undefined; /** * An array of key-value pairs to apply to this resource. */ set tags(value: Array | undefined); /** * A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example `"1469498468.057"` ). * * @cloudformationAttribute CreationTime */ get attrCreationTime(): string; /** * Provides information about the last deployment ID and its status. * * @cloudformationAttribute DeploymentDetails */ get attrDeploymentDetails(): cdk.IResolvable; /** * The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) 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:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912` . In a GameLift fleet ARN, the resource ID matches the `FleetId` value. * * @cloudformationAttribute FleetArn */ get attrFleetArn(): string; /** * A unique identifier for the container fleet to retrieve. * * @cloudformationAttribute FleetId */ get attrFleetId(): string; /** * The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) that is assigned to the fleet's game server container group. The ARN value also identifies the specific container group definition version in use. * * @cloudformationAttribute GameServerContainerGroupDefinitionArn */ get attrGameServerContainerGroupDefinitionArn(): string; /** * The calculated maximum number of game server container group that can be deployed on each fleet instance. The calculation depends on the resource needs of the container group and the CPU and memory resources of the fleet's instance type. * * @cloudformationAttribute MaximumGameServerContainerGroupsPerInstance */ get attrMaximumGameServerContainerGroupsPerInstance(): number; /** * The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) that is assigned to the fleet's per-instance container group. The ARN value also identifies the specific container group definition version in use. * * @cloudformationAttribute PerInstanceContainerGroupDefinitionArn */ get attrPerInstanceContainerGroupDefinitionArn(): string; /** * The current status of the container fleet. * * - `PENDING` -- A new container fleet has been requested. * - `CREATING` -- A new container fleet resource is being created. * - `CREATED` -- A new container fleet resource has been created. No fleet instances have been deployed. * - `ACTIVATING` -- New container fleet instances are being deployed. * - `ACTIVE` -- The container fleet has been deployed and is ready to host game sessions. * - `UPDATING` -- Updates to the container fleet is being updated. A deployment is in progress. * * @cloudformationAttribute Status */ get attrStatus(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } export declare namespace CfnContainerFleet { /** * 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. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-connectionportrange.html */ interface ConnectionPortRangeProperty { /** * Starting value for the port range. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-connectionportrange.html#cfn-gamelift-containerfleet-connectionportrange-fromport */ readonly fromPort: number; /** * Ending value for the port. * * Port numbers are end-inclusive. This value must be equal to or greater than `FromPort` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-connectionportrange.html#cfn-gamelift-containerfleet-connectionportrange-toport */ readonly toPort: number; } /** * A range of IP addresses and port settings that allow inbound traffic to connect to processes on an instance in a fleet. * * Processes are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges. * * For Amazon GameLift Servers Realtime fleets, Amazon GameLift Servers automatically opens two port ranges, one for TCP messaging and one for UDP. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-ippermission.html */ interface IpPermissionProperty { /** * A starting value for a range of allowed port numbers. * * For fleets using Linux builds, only ports `22` and `1026-60000` are valid. * * For fleets using Windows builds, only ports `1026-60000` are valid. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-ippermission.html#cfn-gamelift-containerfleet-ippermission-fromport */ readonly fromPort: number; /** * A range of allowed IP addresses. * * This value must be expressed in CIDR notation. Example: " `000.000.000.000/[subnet mask]` " or optionally the shortened version " `0.0.0.0/[subnet mask]` ". * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-ippermission.html#cfn-gamelift-containerfleet-ippermission-iprange */ readonly ipRange: string; /** * The network communication protocol used by the fleet. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-ippermission.html#cfn-gamelift-containerfleet-ippermission-protocol */ readonly protocol: string; /** * An ending value for a range of allowed port numbers. * * Port numbers are end-inclusive. This value must be equal to or greater than `FromPort` . * * For fleets using Linux builds, only ports `22` and `1026-60000` are valid. * * For fleets using Windows builds, only ports `1026-60000` are valid. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-ippermission.html#cfn-gamelift-containerfleet-ippermission-toport */ readonly toPort: number; } /** * Set of rules for processing a deployment for a container fleet update. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-deploymentconfiguration.html */ interface DeploymentConfigurationProperty { /** * Determines what actions to take if a deployment fails. * * If the fleet is multi-location, this strategy applies across all fleet locations. With a rollback strategy, updated fleet instances are rolled back to the last successful deployment. Alternatively, you can maintain a few impaired containers for the purpose of debugging, while all other tasks return to the last successful deployment. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-deploymentconfiguration.html#cfn-gamelift-containerfleet-deploymentconfiguration-impairmentstrategy */ readonly impairmentStrategy?: string; /** * Sets a minimum level of healthy tasks to maintain during deployment activity. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-deploymentconfiguration.html#cfn-gamelift-containerfleet-deploymentconfiguration-minimumhealthypercentage */ readonly minimumHealthyPercentage?: number; /** * Determines how fleet deployment activity affects active game sessions on the fleet. * * With protection, a deployment honors game session protection, and delays actions that would interrupt a protected active game session until the game session ends. Without protection, deployment activity can shut down all running tasks, including active game sessions, regardless of game session protection. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-deploymentconfiguration.html#cfn-gamelift-containerfleet-deploymentconfiguration-protectionstrategy */ readonly protectionStrategy?: string; } /** * A remote location where a multi-location fleet can deploy game servers for game hosting. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-locationconfiguration.html */ interface LocationConfigurationProperty { /** * An AWS Region code, such as `us-west-2` . * * For a list of supported Regions and Local Zones, see [Amazon GameLift Servers service locations](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html) for managed hosting. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-locationconfiguration.html#cfn-gamelift-containerfleet-locationconfiguration-location */ readonly location: string; /** * Current resource capacity settings in a specified fleet or location. * * The location value might refer to a fleet's remote location or its home Region. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-locationconfiguration.html#cfn-gamelift-containerfleet-locationconfiguration-locationcapacity */ readonly locationCapacity?: cdk.IResolvable | CfnContainerFleet.LocationCapacityProperty; /** * The player gateway status for the location. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-locationconfiguration.html#cfn-gamelift-containerfleet-locationconfiguration-playergatewaystatus */ readonly playerGatewayStatus?: string; /** * A list of fleet actions that have been suspended in the fleet location. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-locationconfiguration.html#cfn-gamelift-containerfleet-locationconfiguration-stoppedactions */ readonly stoppedActions?: Array; } /** * Current resource capacity settings in a specified fleet or location. * * The location value might refer to a fleet's remote location or its home Region. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-locationcapacity.html */ interface LocationCapacityProperty { /** * Defaults to MinSize if not defined. * * The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits. If any auto-scaling policy is defined for the container fleet, the desired instance will only be applied once during fleet creation and will be ignored in updates to avoid conflicts with auto-scaling. During updates with any auto-scaling policy defined, if current desired instance is lower than the new MinSize, it will be increased to the new MinSize; if current desired instance is larger than the new MaxSize, it will be decreased to the new MaxSize. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-locationcapacity.html#cfn-gamelift-containerfleet-locationcapacity-desiredec2instances */ readonly desiredEc2Instances?: number; /** * Configuration options for Amazon GameLift Servers managed capacity behavior. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-locationcapacity.html#cfn-gamelift-containerfleet-locationcapacity-managedcapacityconfiguration */ readonly managedCapacityConfiguration?: cdk.IResolvable | CfnContainerFleet.ManagedCapacityConfigurationProperty; /** * The maximum value that is allowed for the fleet's instance count for a location. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-locationcapacity.html#cfn-gamelift-containerfleet-locationcapacity-maxsize */ readonly maxSize: number; /** * The minimum value allowed for the fleet's instance count for a location. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-locationcapacity.html#cfn-gamelift-containerfleet-locationcapacity-minsize */ readonly minSize?: number; } /** * Configuration options for Amazon GameLift Servers managed capacity behavior. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-managedcapacityconfiguration.html */ interface ManagedCapacityConfigurationProperty { /** * Length of time, in minutes, that Amazon GameLift Servers will wait before scaling in your MinSize and DesiredInstances to 0 after a period with no game session activity. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-managedcapacityconfiguration.html#cfn-gamelift-containerfleet-managedcapacityconfiguration-scaleinafterinactivityminutes */ readonly scaleInAfterInactivityMinutes?: number; /** * The strategy Amazon GameLift Servers will use to automatically scale your capacity to and from zero in response to game session activity. * * Game session activity refers to any active running sessions or game session requests. When set to SCALE_TO_AND_FROM_ZERO, MinSize must not be specified and will be managed automatically. When set to MANUAL, MinSize is required. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-managedcapacityconfiguration.html#cfn-gamelift-containerfleet-managedcapacityconfiguration-zerocapacitystrategy */ readonly zeroCapacityStrategy: string; } /** * Rule that controls how a fleet is scaled. * * Scaling policies are uniquely identified by the combination of name and fleet ID. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-scalingpolicy.html */ interface ScalingPolicyProperty { /** * Comparison operator to use when measuring a metric against the threshold value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-scalingpolicy.html#cfn-gamelift-containerfleet-scalingpolicy-comparisonoperator */ readonly comparisonOperator?: string; /** * Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-scalingpolicy.html#cfn-gamelift-containerfleet-scalingpolicy-evaluationperiods */ readonly evaluationPeriods?: number; /** * Name of the Amazon GameLift Servers-defined metric that is used to trigger a scaling adjustment. * * For detailed descriptions of fleet metrics, see [Monitor Amazon GameLift Servers with Amazon CloudWatch](https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html) . * * - *ActivatingGameSessions* -- Game sessions in the process of being created. * - *ActiveGameSessions* -- Game sessions that are currently running. * - *ActiveInstances* -- Fleet instances that are currently running at least one game session. * - *AvailableGameSessions* -- Additional game sessions that fleet could host simultaneously, given current capacity. * - *AvailablePlayerSessions* -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included. * - *CurrentPlayerSessions* -- Player slots in active game sessions that are being used by a player or are reserved for a player. * - *IdleInstances* -- Active instances that are currently hosting zero game sessions. * - *PercentAvailableGameSessions* -- Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy. * - *PercentIdleInstances* -- Percentage of the total number of active instances that are hosting zero game sessions. * - *QueueDepth* -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination. * - *WaitTime* -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-scalingpolicy.html#cfn-gamelift-containerfleet-scalingpolicy-metricname */ readonly metricName: string; /** * A descriptive label that is associated with a fleet's scaling policy. * * Policy names do not need to be unique. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-scalingpolicy.html#cfn-gamelift-containerfleet-scalingpolicy-name */ readonly name: string; /** * The type of scaling policy to create. * * For a target-based policy, set the parameter *MetricName* to 'PercentAvailableGameSessions' and specify a *TargetConfiguration* . For a rule-based policy set the following parameters: *MetricName* , *ComparisonOperator* , *Threshold* , *EvaluationPeriods* , *ScalingAdjustmentType* , and *ScalingAdjustment* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-scalingpolicy.html#cfn-gamelift-containerfleet-scalingpolicy-policytype */ readonly policyType?: string; /** * Amount of adjustment to make, based on the scaling adjustment type. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-scalingpolicy.html#cfn-gamelift-containerfleet-scalingpolicy-scalingadjustment */ readonly scalingAdjustment?: number; /** * The type of adjustment to make to a fleet's instance count. * * - *ChangeInCapacity* -- add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down. * - *ExactCapacity* -- set the instance count to the scaling adjustment value. * - *PercentChangeInCapacity* -- increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-scalingpolicy.html#cfn-gamelift-containerfleet-scalingpolicy-scalingadjustmenttype */ readonly scalingAdjustmentType?: string; /** * An object that contains settings for a target-based scaling policy. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-scalingpolicy.html#cfn-gamelift-containerfleet-scalingpolicy-targetconfiguration */ readonly targetConfiguration?: cdk.IResolvable | CfnContainerFleet.TargetConfigurationProperty; /** * Metric value used to trigger a scaling event. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-scalingpolicy.html#cfn-gamelift-containerfleet-scalingpolicy-threshold */ readonly threshold?: number; } /** * Settings for a target-based scaling policy. * * A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon GameLift Servers to adjust capacity so that the metric returns to the target value. The target configuration specifies settings as needed for the target based policy, including the target value. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-targetconfiguration.html */ interface TargetConfigurationProperty { /** * Desired value to use with a target-based scaling policy. * * The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions). * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-targetconfiguration.html#cfn-gamelift-containerfleet-targetconfiguration-targetvalue */ readonly targetValue: number; } /** * A policy that puts limits on the number of game sessions that a player can create within a specified span of time. * * With this policy, you can control players' ability to consume available resources. * * The policy is evaluated when a player tries to create a new game session. On receiving a `CreateGameSession` request, Amazon GameLift Servers checks that the player (identified by `CreatorId` ) has created fewer than game session limit in the specified time period. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-gamesessioncreationlimitpolicy.html */ interface GameSessionCreationLimitPolicyProperty { /** * A policy that puts limits on the number of game sessions that a player can create within a specified span of time. * * With this policy, you can control players' ability to consume available resources. * * The policy evaluates when a player tries to create a new game session. On receiving a `CreateGameSession` request, Amazon GameLift Servers checks that the player (identified by `CreatorId` ) has created fewer than game session limit in the specified time period. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-gamesessioncreationlimitpolicy.html#cfn-gamelift-containerfleet-gamesessioncreationlimitpolicy-newgamesessionspercreator */ readonly newGameSessionsPerCreator?: number; /** * The time span used in evaluating the resource creation limit policy. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-gamesessioncreationlimitpolicy.html#cfn-gamelift-containerfleet-gamesessioncreationlimitpolicy-policyperiodinminutes */ readonly policyPeriodInMinutes?: number; } /** * A method for collecting container logs for the fleet. * * Amazon GameLift Servers saves all standard output for each container in logs, including game session logs. You can select from the following methods: * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-logconfiguration.html */ interface LogConfigurationProperty { /** * The type of log collection to use for a fleet. * * - `CLOUDWATCH` -- (default value) 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. This bucket must reside in the fleet's home AWS Region. * - `NONE` -- Don't collect container logs. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-logconfiguration.html#cfn-gamelift-containerfleet-logconfiguration-logdestination */ readonly logDestination?: string; /** * If log destination is `CLOUDWATCH` , logs are sent to the specified log group in Amazon CloudWatch. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-logconfiguration.html#cfn-gamelift-containerfleet-logconfiguration-loggrouparn */ readonly logGroupArn?: string; /** * If log destination is `S3` , logs are sent to the specified Amazon S3 bucket name. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-logconfiguration.html#cfn-gamelift-containerfleet-logconfiguration-s3bucketname */ readonly s3BucketName?: string; } /** * Information about the most recent deployment for the container fleet. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-deploymentdetails.html */ interface DeploymentDetailsProperty { /** * A unique identifier for a fleet deployment. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-deploymentdetails.html#cfn-gamelift-containerfleet-deploymentdetails-latestdeploymentid */ readonly latestDeploymentId?: string; } } /** * Properties for defining a `CfnContainerFleet` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html */ export interface CfnContainerFleetProps { /** * Indicates whether the fleet uses On-Demand or Spot instances for this fleet. * * Learn more about when to use [On-Demand versus Spot Instances](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot) . 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 */ readonly billingType?: string; /** * Set of rules for processing a deployment for a container fleet update. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-deploymentconfiguration */ readonly deploymentConfiguration?: CfnContainerFleet.DeploymentConfigurationProperty | cdk.IResolvable; /** * A meaningful description of the container fleet. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-description */ readonly description?: 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 Servers. * * See [Set up an IAM service role](https://docs.aws.amazon.com/gamelift/latest/developerguide/setting-up-role.html) . 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 */ readonly fleetRoleArn: 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. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-gameservercontainergroupdefinitionname */ readonly gameServerContainerGroupDefinitionName?: string; /** * The number of times to replicate the game server container group on each fleet instance. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-gameservercontainergroupsperinstance */ readonly gameServerContainerGroupsPerInstance?: number; /** * 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. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-gamesessioncreationlimitpolicy */ readonly gameSessionCreationLimitPolicy?: CfnContainerFleet.GameSessionCreationLimitPolicyProperty | cdk.IResolvable; /** * 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. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-instanceconnectionportrange */ readonly instanceConnectionPortRange?: CfnContainerFleet.ConnectionPortRangeProperty | cdk.IResolvable; /** * The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-instanceinboundpermissions */ readonly instanceInboundPermissions?: Array | cdk.IResolvable; /** * 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. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-instancetype */ readonly instanceType?: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-locations */ readonly locations?: Array | cdk.IResolvable; /** * The method that is used to collect container logs for the fleet. * * Amazon GameLift Servers 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. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-logconfiguration */ readonly logConfiguration?: cdk.IResolvable | CfnContainerFleet.LogConfigurationProperty; /** * The name of an AWS CloudWatch metric group to add this fleet to. * * 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 */ readonly metricGroups?: Array; /** * Determines whether Amazon GameLift Servers can shut down game sessions on the fleet that are actively running and hosting players. * * 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](https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html) . * * - *NoProtection* -- Game sessions can be shut down during active gameplay. * - *FullProtection* -- Game sessions in `ACTIVE` status can't be shut down. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-newgamesessionprotectionpolicy */ readonly newGameSessionProtectionPolicy?: string; /** * The name of the fleet's per-instance container group definition. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-perinstancecontainergroupdefinitionname */ readonly perInstanceContainerGroupDefinitionName?: string; /** * The player gateway mode for the container fleet. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-playergatewaymode */ readonly playerGatewayMode?: string; /** * A list of rules that control how a fleet is scaled. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-scalingpolicies */ readonly scalingPolicies?: Array | cdk.IResolvable; /** * An array of key-value pairs to apply to this resource. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-tags */ readonly tags?: Array; } /** * The properties that describe a container group resource. * * You can update all properties of a container group definition properties. Updates to a container group definition are saved as new versions. * * *Used with:* [CreateContainerGroupDefinition](https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateContainerGroupDefinition.html) * * *Returned by:* [DescribeContainerGroupDefinition](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeContainerGroupDefinition.html) , [ListContainerGroupDefinitions](https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListContainerGroupDefinitions.html) , [UpdateContainerGroupDefinition](https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateContainerGroupDefinition.html) * * @cloudformationResource AWS::GameLift::ContainerGroupDefinition * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html */ export declare class CfnContainerGroupDefinition extends cdk.CfnResource implements cdk.IInspectable, IContainerGroupDefinitionRef, cdk.ITaggableV2 { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnContainerGroupDefinition from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnContainerGroupDefinition; /** * Checks whether the given object is a CfnContainerGroupDefinition */ static isCfnContainerGroupDefinition(x: any): x is CfnContainerGroupDefinition; static arnForContainerGroupDefinition(resource: IContainerGroupDefinitionRef): string; /** * Tag Manager which manages the tags for this resource */ readonly cdkTagManager: cdk.TagManager; /** * The type of container group. */ private _containerGroupType?; /** * The definition for the game server container in this group. */ private _gameServerContainerDefinition?; /** * A descriptive identifier for the container group definition. */ private _name; /** * The platform that all containers in the container group definition run on. */ private _operatingSystem; /** * A specific ContainerGroupDefinition version to be updated. */ private _sourceVersionNumber?; /** * The set of definitions for support containers in this group. */ private _supportContainerDefinitions?; /** * An array of key-value pairs to apply to this resource. */ private _tags?; /** * The amount of memory (in MiB) on a fleet instance to allocate for the container group. */ private _totalMemoryLimitMebibytes; /** * The amount of vCPU units on a fleet instance to allocate for the container group (1 vCPU is equal to 1024 CPU units). */ private _totalVcpuLimit; /** * An optional description that was provided for a container group definition update. */ private _versionDescription?; /** * Create a new `AWS::GameLift::ContainerGroupDefinition`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnContainerGroupDefinitionProps); get containerGroupDefinitionRef(): ContainerGroupDefinitionReference; /** * The type of container group. */ get containerGroupType(): string | undefined; /** * The type of container group. */ set containerGroupType(value: string | undefined); /** * The definition for the game server container in this group. */ get gameServerContainerDefinition(): CfnContainerGroupDefinition.GameServerContainerDefinitionProperty | cdk.IResolvable | undefined; /** * The definition for the game server container in this group. */ set gameServerContainerDefinition(value: CfnContainerGroupDefinition.GameServerContainerDefinitionProperty | cdk.IResolvable | undefined); /** * A descriptive identifier for the container group definition. */ get name(): string; /** * A descriptive identifier for the container group definition. */ set name(value: string); /** * The platform that all containers in the container group definition run on. */ get operatingSystem(): string; /** * The platform that all containers in the container group definition run on. */ set operatingSystem(value: string); /** * A specific ContainerGroupDefinition version to be updated. */ get sourceVersionNumber(): number | undefined; /** * A specific ContainerGroupDefinition version to be updated. */ set sourceVersionNumber(value: number | undefined); /** * The set of definitions for support containers in this group. */ get supportContainerDefinitions(): Array | cdk.IResolvable | undefined; /** * The set of definitions for support containers in this group. */ set supportContainerDefinitions(value: Array | cdk.IResolvable | undefined); /** * An array of key-value pairs to apply to this resource. */ get tags(): Array | undefined; /** * An array of key-value pairs to apply to this resource. */ set tags(value: Array | undefined); /** * The amount of memory (in MiB) on a fleet instance to allocate for the container group. */ get totalMemoryLimitMebibytes(): number; /** * The amount of memory (in MiB) on a fleet instance to allocate for the container group. */ set totalMemoryLimitMebibytes(value: number); /** * The amount of vCPU units on a fleet instance to allocate for the container group (1 vCPU is equal to 1024 CPU units). */ get totalVcpuLimit(): number; /** * The amount of vCPU units on a fleet instance to allocate for the container group (1 vCPU is equal to 1024 CPU units). */ set totalVcpuLimit(value: number); /** * An optional description that was provided for a container group definition update. */ get versionDescription(): string | undefined; /** * An optional description that was provided for a container group definition update. */ set versionDescription(value: string | undefined); /** * The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) that is assigned to an Amazon GameLift Servers `ContainerGroupDefinition` resource. It uniquely identifies the resource across all AWS Regions. Format is `arn:aws:gamelift:[region]::containergroupdefinition/[container group definition name]:[version]` . * * @cloudformationAttribute ContainerGroupDefinitionArn */ get attrContainerGroupDefinitionArn(): string; /** * A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example `"1469498468.057"` ). * * @cloudformationAttribute CreationTime */ get attrCreationTime(): string; /** * Current status of the container group definition resource. Values include: * * - `COPYING` -- Amazon GameLift Servers is in the process of making copies of all container images that are defined in the group. While in this state, the resource can't be used to create a container fleet. * - `READY` -- Amazon GameLift Servers has copied the registry images for all containers that are defined in the group. You can use a container group definition in this status to create a container fleet. * - `FAILED` -- Amazon GameLift Servers failed to create a valid container group definition resource. For more details on the cause of the failure, see `StatusReason` . A container group definition resource in failed status will be deleted within a few minutes. * * @cloudformationAttribute Status */ get attrStatus(): string; /** * Additional information about a container group definition that's in `FAILED` status. Possible reasons include: * * - An internal issue prevented Amazon GameLift Servers from creating the container group definition resource. Delete the failed resource and call [CreateContainerGroupDefinition](https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateContainerGroupDefinition.html) again. * - An access-denied message means that you don't have permissions to access the container image on ECR. See [IAM permission examples](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-iam-policy-examples.html.html) for help setting up required IAM permissions for Amazon GameLift Servers. * - The `ImageUri` value for at least one of the containers in the container group definition was invalid or not found in the current AWS account. * - At least one of the container images referenced in the container group definition exceeds the allowed size. For size limits, see [Amazon GameLift Servers endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/gamelift.html) . * - At least one of the container images referenced in the container group definition uses a different operating system than the one defined for the container group. * * @cloudformationAttribute StatusReason */ get attrStatusReason(): string; /** * Indicates the version of a particular container group definition. This number is incremented automatically when you update a container group definition. You can view, update, or delete individual versions or the entire container group definition. * * @cloudformationAttribute VersionNumber */ get attrVersionNumber(): number; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } export declare namespace CfnContainerGroupDefinition { /** * Describes the game server container in an existing game server container group. * * A game server container identifies a container image with your game server build. A game server container is automatically considered essential; if an essential container fails, the entire container group restarts. * * You can update a container definition and deploy the updates to an existing fleet. When creating or updating a game server container group definition, use the property [](https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinitionInput) . * * *Part of:* [ContainerGroupDefinition](https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html) * * *Returned by:* [DescribeContainerGroupDefinition](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeContainerGroupDefinition.html) , [ListContainerGroupDefinitions](https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListContainerGroupDefinitions.html) , [UpdateContainerGroupDefinition](https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateContainerGroupDefinition.html) * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-gameservercontainerdefinition.html */ interface GameServerContainerDefinitionProperty { /** * The container definition identifier. * * Container names are unique within a container group definition. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-gameservercontainerdefinition.html#cfn-gamelift-containergroupdefinition-gameservercontainerdefinition-containername */ readonly containerName: string; /** * Indicates that the container relies on the status of other containers in the same container group during startup and shutdown sequences. * * A container might have dependencies on multiple containers. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-gameservercontainerdefinition.html#cfn-gamelift-containergroupdefinition-gameservercontainerdefinition-dependson */ readonly dependsOn?: Array | cdk.IResolvable; /** * A set of environment variables that's passed to the container on startup. * * See the [ContainerDefinition::environment](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-environment) parameter in the *Amazon Elastic Container Service API Reference* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-gameservercontainerdefinition.html#cfn-gamelift-containergroupdefinition-gameservercontainerdefinition-environmentoverride */ readonly environmentOverride?: Array | cdk.IResolvable; /** * The URI to the image that Amazon GameLift Servers uses when deploying this container to a container fleet. * * For a more specific identifier, see `ResolvedImageDigest` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-gameservercontainerdefinition.html#cfn-gamelift-containergroupdefinition-gameservercontainerdefinition-imageuri */ readonly imageUri: string; /** * A mount point that binds a path inside the container to a file or directory on the host system and lets it access the file or directory. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-gameservercontainerdefinition.html#cfn-gamelift-containergroupdefinition-gameservercontainerdefinition-mountpoints */ readonly mountPoints?: Array | cdk.IResolvable; /** * The set of ports that are available to bind to processes in the container. * * For example, a game server process requires a container port to allow game clients to connect to it. Container ports aren't directly accessed by inbound traffic. Amazon GameLift Servers maps these container ports to externally accessible connection ports, which are assigned as needed from the container fleet's `ConnectionPortRange` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-gameservercontainerdefinition.html#cfn-gamelift-containergroupdefinition-gameservercontainerdefinition-portconfiguration */ readonly portConfiguration?: cdk.IResolvable | CfnContainerGroupDefinition.PortConfigurationProperty; /** * A unique and immutable identifier for the container image. * * The digest is a SHA 256 hash of the container image manifest. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-gameservercontainerdefinition.html#cfn-gamelift-containergroupdefinition-gameservercontainerdefinition-resolvedimagedigest */ readonly resolvedImageDigest?: string; /** * The Amazon GameLift Servers server SDK version that the game server is integrated with. * * Only game servers using 5.2.0 or higher are compatible with container fleets. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-gameservercontainerdefinition.html#cfn-gamelift-containergroupdefinition-gameservercontainerdefinition-serversdkversion */ readonly serverSdkVersion: string; } /** * A container's dependency on another container in the same container group. * * The dependency impacts how the dependent container is able to start or shut down based the status of the other container. * * For example, *ContainerA* is configured with the following dependency: a `START` dependency on *ContainerB* . This means that *ContainerA* can't start until *ContainerB* has started. It also means that *ContainerA* must shut down before *ContainerB* . * * *Part of:* [GameServerContainerDefinition](https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinition.html) , [GameServerContainerDefinitionInput](https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinitionInput.html) , [SupportContainerDefinition](https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinition.html) , [SupportContainerDefinitionInput](https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinitionInput.html) * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdependency.html */ interface ContainerDependencyProperty { /** * The condition that the dependency container must reach before the dependent container can start. Valid conditions include:. * * - START - The dependency container must have started. * - COMPLETE - The dependency container has run to completion (exits). Use this condition with nonessential containers, such as those that run a script and then exit. The dependency container can't be an essential container. * - SUCCESS - The dependency container has run to completion and exited with a zero status. The dependency container can't be an essential container. * - HEALTHY - The dependency container has passed its Docker health check. Use this condition with dependency containers that have health checks configured. This condition is confirmed at container group startup only. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdependency.html#cfn-gamelift-containergroupdefinition-containerdependency-condition */ readonly condition: string; /** * A descriptive label for the container definition that this container depends on. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdependency.html#cfn-gamelift-containergroupdefinition-containerdependency-containername */ readonly containerName: string; } /** * An environment variable to set inside a container, in the form of a key-value pair. * * *Part of:* [GameServerContainerDefinition](https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinition.html) , [GameServerContainerDefinitionInput](https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinitionInput.html) , [SupportContainerDefinition](https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinition.html) , [SupportContainerDefinitionInput](https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinitionInput.html) * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerenvironment.html */ interface ContainerEnvironmentProperty { /** * The environment variable name. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerenvironment.html#cfn-gamelift-containergroupdefinition-containerenvironment-name */ readonly name: string; /** * The environment variable value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerenvironment.html#cfn-gamelift-containergroupdefinition-containerenvironment-value */ readonly value: string; } /** * Defines the ports on a container. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-portconfiguration.html */ interface PortConfigurationProperty { /** * Specifies one or more ranges of ports on a container. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-portconfiguration.html#cfn-gamelift-containergroupdefinition-portconfiguration-containerportranges */ readonly containerPortRanges: Array | cdk.IResolvable; } /** * A set of one or more port numbers that can be opened on the container, and the supported network protocol. * * *Part of:* [ContainerPortConfiguration](https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerPortConfiguration.html) * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerportrange.html */ interface ContainerPortRangeProperty { /** * A starting value for the range of allowed port numbers. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerportrange.html#cfn-gamelift-containergroupdefinition-containerportrange-fromport */ readonly fromPort: number; /** * The network protocol that these ports support. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerportrange.html#cfn-gamelift-containergroupdefinition-containerportrange-protocol */ readonly protocol: string; /** * An ending value for the range of allowed port numbers. * * Port numbers are end-inclusive. This value must be equal to or greater than `FromPort` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerportrange.html#cfn-gamelift-containergroupdefinition-containerportrange-toport */ readonly toPort: number; } /** * A mount point that binds a container to a file or directory on the host system. * * *Part of:* [GameServerContainerDefinition](https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinition.html) , [](https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinitionInput.html) , [SupportContainerDefinition](https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinition.html) , [](https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinitionInput.html) * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containermountpoint.html */ interface ContainerMountPointProperty { /** * The type of access for the container. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containermountpoint.html#cfn-gamelift-containergroupdefinition-containermountpoint-accesslevel */ readonly accessLevel?: string; /** * The mount path on the container. * * If this property isn't set, the instance path is used. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containermountpoint.html#cfn-gamelift-containergroupdefinition-containermountpoint-containerpath */ readonly containerPath?: string; /** * The path to the source file or directory. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containermountpoint.html#cfn-gamelift-containergroupdefinition-containermountpoint-instancepath */ readonly instancePath: string; } /** * Describes a support container in a container group. * * A support container might be in a game server container group or a per-instance container group. Support containers don't run game server processes. * * You can update a support container definition and deploy the updates to an existing fleet. When creating or updating a game server container group definition, use the property [GameServerContainerDefinitionInput](https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinitionInput.html) . * * *Part of:* [ContainerGroupDefinition](https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html) * * *Returned by:* [DescribeContainerGroupDefinition](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeContainerGroupDefinition.html) , [ListContainerGroupDefinitions](https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListContainerGroupDefinitions.html) , [UpdateContainerGroupDefinition](https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateContainerGroupDefinition.html) * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-supportcontainerdefinition.html */ interface SupportContainerDefinitionProperty { /** * The container definition identifier. * * Container names are unique within a container group definition. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-supportcontainerdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinition-containername */ readonly containerName: string; /** * Indicates that the container relies on the status of other containers in the same container group during its startup and shutdown sequences. * * A container might have dependencies on multiple containers. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-supportcontainerdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinition-dependson */ readonly dependsOn?: Array | cdk.IResolvable; /** * A set of environment variables that's passed to the container on startup. * * See the [ContainerDefinition::environment](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-environment) parameter in the *Amazon Elastic Container Service API Reference* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-supportcontainerdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinition-environmentoverride */ readonly environmentOverride?: Array | cdk.IResolvable; /** * Indicates whether the container is vital to the container group. * * If an essential container fails, the entire container group restarts. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-supportcontainerdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinition-essential */ readonly essential?: boolean | cdk.IResolvable; /** * A configuration for a non-terminal health check. * * A support container automatically restarts if it stops functioning or if it fails this health check. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-supportcontainerdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinition-healthcheck */ readonly healthCheck?: CfnContainerGroupDefinition.ContainerHealthCheckProperty | cdk.IResolvable; /** * The URI to the image that Amazon GameLift Servers deploys to a container fleet. * * For a more specific identifier, see `ResolvedImageDigest` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-supportcontainerdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinition-imageuri */ readonly imageUri: string; /** * The amount of memory that Amazon GameLift Servers makes available to the container. * * If memory limits aren't set for an individual container, the container shares the container group's total memory allocation. * * *Related data type:* [ContainerGroupDefinition TotalMemoryLimitMebibytes](https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html) * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-supportcontainerdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinition-memoryhardlimitmebibytes */ readonly memoryHardLimitMebibytes?: number; /** * A mount point that binds a path inside the container to a file or directory on the host system and lets it access the file or directory. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-supportcontainerdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinition-mountpoints */ readonly mountPoints?: Array | cdk.IResolvable; /** * A set of ports that allow access to the container from external users. * * Processes running in the container can bind to a one of these ports. Container ports aren't directly accessed by inbound traffic. Amazon GameLift Servers maps these container ports to externally accessible connection ports, which are assigned as needed from the container fleet's `ConnectionPortRange` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-supportcontainerdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinition-portconfiguration */ readonly portConfiguration?: cdk.IResolvable | CfnContainerGroupDefinition.PortConfigurationProperty; /** * A unique and immutable identifier for the container image. * * The digest is a SHA 256 hash of the container image manifest. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-supportcontainerdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinition-resolvedimagedigest */ readonly resolvedImageDigest?: string; /** * The number of vCPU units that are reserved for the container. * * If no resources are reserved, the container shares the total vCPU limit for the container group. * * *Related data type:* [ContainerGroupDefinition TotalVcpuLimit](https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html) * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-supportcontainerdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinition-vcpu */ readonly vcpu?: number; } /** * Instructions on when and how to check the health of a support container in a container fleet. * * These properties override any Docker health checks that are set in the container image. For more information on container health checks, see [HealthCheck command](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html#ECS-Type-HealthCheck-command) in the *Amazon Elastic Container Service API* . Game server containers don't have a health check parameter; Amazon GameLift Servers automatically handles health checks for these containers. * * The following example instructs the container to initiate a health check command every 60 seconds and wait 10 seconds for it to succeed. If it fails, retry the command 3 times before flagging the container as unhealthy. It also tells the container to wait 100 seconds after launch before counting failed health checks. * * `{"Command": [ "CMD-SHELL", "ps cax | grep "processmanager" || exit 1" ], "Interval": 60, "Timeout": 10, "Retries": 3, "StartPeriod": 100 }` * * *Part of:* [SupportContainerDefinition](https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinition.html) , [SupportContainerDefinitionInput](https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinitionInput.html) * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerhealthcheck.html */ interface ContainerHealthCheckProperty { /** * A string array that specifies the command that the container runs to determine if it's healthy. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerhealthcheck.html#cfn-gamelift-containergroupdefinition-containerhealthcheck-command */ readonly command: Array; /** * The time period (in seconds) between each health check. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerhealthcheck.html#cfn-gamelift-containergroupdefinition-containerhealthcheck-interval */ readonly interval?: number; /** * The number of times to retry a failed health check before flagging the container unhealthy. * * The first run of the command does not count as a retry. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerhealthcheck.html#cfn-gamelift-containergroupdefinition-containerhealthcheck-retries */ readonly retries?: number; /** * The optional grace period (in seconds) to give a container time to bootstrap before the first failed health check counts toward the number of retries. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerhealthcheck.html#cfn-gamelift-containergroupdefinition-containerhealthcheck-startperiod */ readonly startPeriod?: number; /** * The time period (in seconds) to wait for a health check to succeed before counting a failed health check. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerhealthcheck.html#cfn-gamelift-containergroupdefinition-containerhealthcheck-timeout */ readonly timeout?: number; } } /** * Properties for defining a `CfnContainerGroupDefinition` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html */ export interface CfnContainerGroupDefinitionProps { /** * The type of container group. * * Container group type determines how Amazon GameLift Servers deploys the container group on each fleet instance. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-containergrouptype */ readonly containerGroupType?: string; /** * The definition for the game server container in this group. * * This property is used only when the container group type is `GAME_SERVER` . This container definition specifies a container image with the game server build. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-gameservercontainerdefinition */ readonly gameServerContainerDefinition?: CfnContainerGroupDefinition.GameServerContainerDefinitionProperty | cdk.IResolvable; /** * A descriptive identifier for the container group definition. * * The name value is unique in an AWS Region. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-name */ readonly name: string; /** * The platform that all containers in the container group definition run on. * * > Amazon Linux 2 (AL2) will reach end of support on 6/30/2026. See more details in the [Amazon Linux 2 FAQs](https://docs.aws.amazon.com/amazon-linux-2/faqs/) . For game servers that are hosted on AL2 and use server SDK version 4.x for Amazon GameLift Servers, first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See [Migrate to server SDK version 5.](https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html) * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-operatingsystem */ readonly operatingSystem: string; /** * A specific ContainerGroupDefinition version to be updated. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-sourceversionnumber */ readonly sourceVersionNumber?: number; /** * The set of definitions for support containers in this group. * * A container group definition might have zero support container definitions. Support container can be used in any type of container group. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinitions */ readonly supportContainerDefinitions?: Array | cdk.IResolvable; /** * An array of key-value pairs to apply to this resource. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-tags */ readonly tags?: Array; /** * The amount of memory (in MiB) on a fleet instance to allocate for the container group. * * All containers in the group share these resources. * * You can set a limit for each container definition in the group. If individual containers have limits, this total value must be greater than any individual container's memory limit. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-totalmemorylimitmebibytes */ readonly totalMemoryLimitMebibytes: number; /** * The amount of vCPU units on a fleet instance to allocate for the container group (1 vCPU is equal to 1024 CPU units). * * All containers in the group share these resources. You can set a limit for each container definition in the group. If individual containers have limits, this total value must be equal to or greater than the sum of the limits for each container in the group. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-totalvcpulimit */ readonly totalVcpuLimit: number; /** * An optional description that was provided for a container group definition update. * * Each version can have a unique description. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-versiondescription */ readonly versionDescription?: string; } export type { IAliasRef, AliasReference }; export type { IBuildRef, BuildReference }; export type { IFleetRef, FleetReference }; export type { IGameServerGroupRef, GameServerGroupReference }; export type { IGameSessionQueueRef, GameSessionQueueReference }; export type { ILocationRef, LocationReference }; export type { IMatchmakingConfigurationRef, MatchmakingConfigurationReference }; export type { IMatchmakingRuleSetRef, MatchmakingRuleSetReference }; export type { IScriptRef, ScriptReference }; export type { IContainerFleetRef, ContainerFleetReference }; export type { IContainerGroupDefinitionRef, ContainerGroupDefinitionReference };