CfnGameServerGroupProps

class aws_cdk.aws_gamelift.CfnGameServerGroupProps(*, game_server_group_name, instance_definitions, launch_template, role_arn, auto_scaling_policy=None, balancing_strategy=None, delete_option=None, game_server_protection_policy=None, max_size=None, min_size=None, tags=None, vpc_subnets=None)

Bases: object

Properties for defining a CfnGameServerGroup.

Parameters
  • game_server_group_name (str) – A developer-defined identifier for the game server group. The name is unique for each Region in each AWS account.

  • instance_definitions (Union[IResolvable, Sequence[Union[IResolvable, InstanceDefinitionProperty]]]) – The set of Amazon EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

  • launch_template (Union[IResolvable, LaunchTemplateProperty]) – AWS::GameLift::GameServerGroup.LaunchTemplate.

  • role_arn (str) – The Amazon Resource Name ( ARN ) for an IAM role that allows Amazon Web Services to access your Amazon EC2 Auto Scaling groups.

  • auto_scaling_policy (Union[IResolvable, AutoScalingPolicyProperty, None]) – AWS::GameLift::GameServerGroup.AutoScalingPolicy.

  • balancing_strategy (Optional[str]) – Indicates how GameLift 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.

  • delete_option (Optional[str]) – AWS::GameLift::GameServerGroup.DeleteOption.

  • game_server_protection_policy (Optional[str]) – 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.

  • max_size (Union[int, float, None]) – AWS::GameLift::GameServerGroup.MaxSize.

  • min_size (Union[int, float, None]) – AWS::GameLift::GameServerGroup.MinSize.

  • tags (Optional[Sequence[CfnTag]]) – AWS::GameLift::GameServerGroup.Tags.

  • vpc_subnets (Optional[Sequence[str]]) – AWS::GameLift::GameServerGroup.VpcSubnets.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_gamelift as gamelift

cfn_game_server_group_props = gamelift.CfnGameServerGroupProps(
    game_server_group_name="gameServerGroupName",
    instance_definitions=[gamelift.CfnGameServerGroup.InstanceDefinitionProperty(
        instance_type="instanceType",

        # the properties below are optional
        weighted_capacity="weightedCapacity"
    )],
    launch_template=gamelift.CfnGameServerGroup.LaunchTemplateProperty(
        launch_template_id="launchTemplateId",
        launch_template_name="launchTemplateName",
        version="version"
    ),
    role_arn="roleArn",

    # the properties below are optional
    auto_scaling_policy=gamelift.CfnGameServerGroup.AutoScalingPolicyProperty(
        target_tracking_configuration=gamelift.CfnGameServerGroup.TargetTrackingConfigurationProperty(
            target_value=123
        ),

        # the properties below are optional
        estimated_instance_warmup=123
    ),
    balancing_strategy="balancingStrategy",
    delete_option="deleteOption",
    game_server_protection_policy="gameServerProtectionPolicy",
    max_size=123,
    min_size=123,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vpc_subnets=["vpcSubnets"]
)

Attributes

auto_scaling_policy

AWS::GameLift::GameServerGroup.AutoScalingPolicy.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-autoscalingpolicy

Return type

Union[IResolvable, AutoScalingPolicyProperty, None]

balancing_strategy

Indicates how GameLift 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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-balancingstrategy

Return type

Optional[str]

delete_option

AWS::GameLift::GameServerGroup.DeleteOption.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-deleteoption

Return type

Optional[str]

game_server_group_name

A developer-defined identifier for the game server group.

The name is unique for each Region in each AWS account.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-gameservergroupname

Return type

str

game_server_protection_policy

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-gameserverprotectionpolicy

Return type

Optional[str]

instance_definitions

The set of Amazon EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-instancedefinitions

Return type

Union[IResolvable, List[Union[IResolvable, InstanceDefinitionProperty]]]

launch_template

AWS::GameLift::GameServerGroup.LaunchTemplate.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-launchtemplate

Return type

Union[IResolvable, LaunchTemplateProperty]

max_size

AWS::GameLift::GameServerGroup.MaxSize.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-maxsize

Return type

Union[int, float, None]

min_size

AWS::GameLift::GameServerGroup.MinSize.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-minsize

Return type

Union[int, float, None]

role_arn

//docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`_ ) for an IAM role that allows Amazon Web Services to access your Amazon EC2 Auto Scaling groups.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-rolearn

Type

The Amazon Resource Name ( `ARN <https

Return type

str

tags

AWS::GameLift::GameServerGroup.Tags.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-tags

Return type

Optional[List[CfnTag]]

vpc_subnets

AWS::GameLift::GameServerGroup.VpcSubnets.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-vpcsubnets

Return type

Optional[List[str]]