Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. gamelift
  5. GameServerGroup

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.79.0 published on Monday, Oct 2, 2023 by Pulumi
pulumi/pulumi-aws-native

aws-native.gamelift.GameServerGroup

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.79.0 published on Monday, Oct 2, 2023 by Pulumi
pulumi/pulumi-aws-native

    The AWS::GameLift::GameServerGroup resource creates an Amazon GameLift (GameLift) GameServerGroup.

    Create GameServerGroup Resource

    new GameServerGroup(name: string, args: GameServerGroupArgs, opts?: CustomResourceOptions);
    @overload
def GameServerGroup(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    auto_scaling_policy: Optional[GameServerGroupAutoScalingPolicyArgs] = None,
                    balancing_strategy: Optional[GameServerGroupBalancingStrategy] = None,
                    delete_option: Optional[GameServerGroupDeleteOption] = None,
                    game_server_group_name: Optional[str] = None,
                    game_server_protection_policy: Optional[GameServerGroupGameServerProtectionPolicy] = None,
                    instance_definitions: Optional[Sequence[GameServerGroupInstanceDefinitionArgs]] = None,
                    launch_template: Optional[GameServerGroupLaunchTemplateArgs] = None,
                    max_size: Optional[float] = None,
                    min_size: Optional[float] = None,
                    role_arn: Optional[str] = None,
                    tags: Optional[Sequence[GameServerGroupTagArgs]] = None,
                    vpc_subnets: Optional[Sequence[str]] = None)
@overload
def GameServerGroup(resource_name: str,
                    args: GameServerGroupArgs,
                    opts: Optional[ResourceOptions] = None)
    func NewGameServerGroup(ctx *Context, name string, args GameServerGroupArgs, opts ...ResourceOption) (*GameServerGroup, error)
    public GameServerGroup(string name, GameServerGroupArgs args, CustomResourceOptions? opts = null)
    public GameServerGroup(String name, GameServerGroupArgs args)
public GameServerGroup(String name, GameServerGroupArgs args, CustomResourceOptions options)

    type: aws-native:gamelift:GameServerGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GameServerGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args GameServerGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args GameServerGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GameServerGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GameServerGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    GameServerGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The GameServerGroup resource accepts the following input properties:

    InstanceDefinitions List<Pulumi.AwsNative.GameLift.Inputs.GameServerGroupInstanceDefinition>

    A set of EC2 instance types to use when creating instances in the group.

    RoleArn string

    The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

    AutoScalingPolicy Pulumi.AwsNative.GameLift.Inputs.GameServerGroupAutoScalingPolicy

    Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting

    BalancingStrategy Pulumi.AwsNative.GameLift.GameServerGroupBalancingStrategy

    The fallback balancing method to use for the game server group when Spot Instances in a Region become unavailable or are not viable for game hosting.

    DeleteOption Pulumi.AwsNative.GameLift.GameServerGroupDeleteOption

    The type of delete to perform.

    GameServerGroupName string

    An identifier for the new game server group.

    GameServerProtectionPolicy Pulumi.AwsNative.GameLift.GameServerGroupGameServerProtectionPolicy

    A flag that indicates whether instances in the game server group are protected from early termination.

    LaunchTemplate Pulumi.AwsNative.GameLift.Inputs.GameServerGroupLaunchTemplate

    The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group.

    MaxSize double

    The maximum number of instances allowed in the EC2 Auto Scaling group.

    MinSize double

    The minimum number of instances allowed in the EC2 Auto Scaling group.

    Tags List<Pulumi.AwsNative.GameLift.Inputs.GameServerGroupTag>

    A list of labels to assign to the new game server group resource.

    VpcSubnets List<string>

    A list of virtual private cloud (VPC) subnets to use with instances in the game server group.

    InstanceDefinitions []GameServerGroupInstanceDefinitionArgs

    A set of EC2 instance types to use when creating instances in the group.

    RoleArn string

    The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

    AutoScalingPolicy GameServerGroupAutoScalingPolicyArgs

    Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting

    BalancingStrategy GameServerGroupBalancingStrategy

    The fallback balancing method to use for the game server group when Spot Instances in a Region become unavailable or are not viable for game hosting.

    DeleteOption GameServerGroupDeleteOption

    The type of delete to perform.

    GameServerGroupName string

    An identifier for the new game server group.

    GameServerProtectionPolicy GameServerGroupGameServerProtectionPolicy

    A flag that indicates whether instances in the game server group are protected from early termination.

    LaunchTemplate GameServerGroupLaunchTemplateArgs

    The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group.

    MaxSize float64

    The maximum number of instances allowed in the EC2 Auto Scaling group.

    MinSize float64

    The minimum number of instances allowed in the EC2 Auto Scaling group.

    Tags []GameServerGroupTagArgs

    A list of labels to assign to the new game server group resource.

    VpcSubnets []string

    A list of virtual private cloud (VPC) subnets to use with instances in the game server group.

    instanceDefinitions List<GameServerGroupInstanceDefinition>

    A set of EC2 instance types to use when creating instances in the group.

    roleArn String

    The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

    autoScalingPolicy GameServerGroupAutoScalingPolicy

    Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting

    balancingStrategy GameServerGroupBalancingStrategy

    The fallback balancing method to use for the game server group when Spot Instances in a Region become unavailable or are not viable for game hosting.

    deleteOption GameServerGroupDeleteOption

    The type of delete to perform.

    gameServerGroupName String

    An identifier for the new game server group.

    gameServerProtectionPolicy GameServerGroupGameServerProtectionPolicy

    A flag that indicates whether instances in the game server group are protected from early termination.

    launchTemplate GameServerGroupLaunchTemplate

    The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group.

    maxSize Double

    The maximum number of instances allowed in the EC2 Auto Scaling group.

    minSize Double

    The minimum number of instances allowed in the EC2 Auto Scaling group.

    tags List<GameServerGroupTag>

    A list of labels to assign to the new game server group resource.

    vpcSubnets List<String>

    A list of virtual private cloud (VPC) subnets to use with instances in the game server group.

    instanceDefinitions GameServerGroupInstanceDefinition[]

    A set of EC2 instance types to use when creating instances in the group.

    roleArn string

    The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

    autoScalingPolicy GameServerGroupAutoScalingPolicy

    Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting

    balancingStrategy GameServerGroupBalancingStrategy

    The fallback balancing method to use for the game server group when Spot Instances in a Region become unavailable or are not viable for game hosting.

    deleteOption GameServerGroupDeleteOption

    The type of delete to perform.

    gameServerGroupName string

    An identifier for the new game server group.

    gameServerProtectionPolicy GameServerGroupGameServerProtectionPolicy

    A flag that indicates whether instances in the game server group are protected from early termination.

    launchTemplate GameServerGroupLaunchTemplate

    The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group.

    maxSize number

    The maximum number of instances allowed in the EC2 Auto Scaling group.

    minSize number

    The minimum number of instances allowed in the EC2 Auto Scaling group.

    tags GameServerGroupTag[]

    A list of labels to assign to the new game server group resource.

    vpcSubnets string[]

    A list of virtual private cloud (VPC) subnets to use with instances in the game server group.

    instance_definitions Sequence[GameServerGroupInstanceDefinitionArgs]

    A set of EC2 instance types to use when creating instances in the group.

    role_arn str

    The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

    auto_scaling_policy GameServerGroupAutoScalingPolicyArgs

    Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting

    balancing_strategy GameServerGroupBalancingStrategy

    The fallback balancing method to use for the game server group when Spot Instances in a Region become unavailable or are not viable for game hosting.

    delete_option GameServerGroupDeleteOption

    The type of delete to perform.

    game_server_group_name str

    An identifier for the new game server group.

    game_server_protection_policy GameServerGroupGameServerProtectionPolicy

    A flag that indicates whether instances in the game server group are protected from early termination.

    launch_template GameServerGroupLaunchTemplateArgs

    The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group.

    max_size float

    The maximum number of instances allowed in the EC2 Auto Scaling group.

    min_size float

    The minimum number of instances allowed in the EC2 Auto Scaling group.

    tags Sequence[GameServerGroupTagArgs]

    A list of labels to assign to the new game server group resource.

    vpc_subnets Sequence[str]

    A list of virtual private cloud (VPC) subnets to use with instances in the game server group.

    instanceDefinitions List<Property Map>

    A set of EC2 instance types to use when creating instances in the group.

    roleArn String

    The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

    autoScalingPolicy Property Map

    Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting

    balancingStrategy "SPOT_ONLY" | "SPOT_PREFERRED" | "ON_DEMAND_ONLY"

    The fallback balancing method to use for the game server group when Spot Instances in a Region become unavailable or are not viable for game hosting.

    deleteOption "SAFE_DELETE" | "FORCE_DELETE" | "RETAIN"

    The type of delete to perform.

    gameServerGroupName String

    An identifier for the new game server group.

    gameServerProtectionPolicy "NO_PROTECTION" | "FULL_PROTECTION"

    A flag that indicates whether instances in the game server group are protected from early termination.

    launchTemplate Property Map

    The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group.

    maxSize Number

    The maximum number of instances allowed in the EC2 Auto Scaling group.

    minSize Number

    The minimum number of instances allowed in the EC2 Auto Scaling group.

    tags List<Property Map>

    A list of labels to assign to the new game server group resource.

    vpcSubnets List<String>

    A list of virtual private cloud (VPC) subnets to use with instances in the game server group.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GameServerGroup resource produces the following output properties:

    AutoScalingGroupArn string

    A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.

    GameServerGroupArn string

    A generated unique ID for the game server group.

    Id string

    The provider-assigned unique ID for this managed resource.

    AutoScalingGroupArn string

    A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.

    GameServerGroupArn string

    A generated unique ID for the game server group.

    Id string

    The provider-assigned unique ID for this managed resource.

    autoScalingGroupArn String

    A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.

    gameServerGroupArn String

    A generated unique ID for the game server group.

    id String

    The provider-assigned unique ID for this managed resource.

    autoScalingGroupArn string

    A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.

    gameServerGroupArn string

    A generated unique ID for the game server group.

    id string

    The provider-assigned unique ID for this managed resource.

    auto_scaling_group_arn str

    A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.

    game_server_group_arn str

    A generated unique ID for the game server group.

    id str

    The provider-assigned unique ID for this managed resource.

    autoScalingGroupArn String

    A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.

    gameServerGroupArn String

    A generated unique ID for the game server group.

    id String

    The provider-assigned unique ID for this managed resource.

    Supporting Types

    GameServerGroupAutoScalingPolicy, GameServerGroupAutoScalingPolicyArgs

    GameServerGroupBalancingStrategy, GameServerGroupBalancingStrategyArgs

    SpotOnly
    SPOT_ONLY
    SpotPreferred
    SPOT_PREFERRED
    OnDemandOnly
    ON_DEMAND_ONLY
    GameServerGroupBalancingStrategySpotOnly
    SPOT_ONLY
    GameServerGroupBalancingStrategySpotPreferred
    SPOT_PREFERRED
    GameServerGroupBalancingStrategyOnDemandOnly
    ON_DEMAND_ONLY
    SpotOnly
    SPOT_ONLY
    SpotPreferred
    SPOT_PREFERRED
    OnDemandOnly
    ON_DEMAND_ONLY
    SpotOnly
    SPOT_ONLY
    SpotPreferred
    SPOT_PREFERRED
    OnDemandOnly
    ON_DEMAND_ONLY
    SPOT_ONLY
    SPOT_ONLY
    SPOT_PREFERRED
    SPOT_PREFERRED
    ON_DEMAND_ONLY
    ON_DEMAND_ONLY
    "SPOT_ONLY"
    SPOT_ONLY
    "SPOT_PREFERRED"
    SPOT_PREFERRED
    "ON_DEMAND_ONLY"
    ON_DEMAND_ONLY

    GameServerGroupDeleteOption, GameServerGroupDeleteOptionArgs

    SafeDelete
    SAFE_DELETE
    ForceDelete
    FORCE_DELETE
    Retain
    RETAIN
    GameServerGroupDeleteOptionSafeDelete
    SAFE_DELETE
    GameServerGroupDeleteOptionForceDelete
    FORCE_DELETE
    GameServerGroupDeleteOptionRetain
    RETAIN
    SafeDelete
    SAFE_DELETE
    ForceDelete
    FORCE_DELETE
    Retain
    RETAIN
    SafeDelete
    SAFE_DELETE
    ForceDelete
    FORCE_DELETE
    Retain
    RETAIN
    SAFE_DELETE
    SAFE_DELETE
    FORCE_DELETE
    FORCE_DELETE
    RETAIN
    RETAIN
    "SAFE_DELETE"
    SAFE_DELETE
    "FORCE_DELETE"
    FORCE_DELETE
    "RETAIN"
    RETAIN

    GameServerGroupGameServerProtectionPolicy, GameServerGroupGameServerProtectionPolicyArgs

    NoProtection
    NO_PROTECTION
    FullProtection
    FULL_PROTECTION
    GameServerGroupGameServerProtectionPolicyNoProtection
    NO_PROTECTION
    GameServerGroupGameServerProtectionPolicyFullProtection
    FULL_PROTECTION
    NoProtection
    NO_PROTECTION
    FullProtection
    FULL_PROTECTION
    NoProtection
    NO_PROTECTION
    FullProtection
    FULL_PROTECTION
    NO_PROTECTION
    NO_PROTECTION
    FULL_PROTECTION
    FULL_PROTECTION
    "NO_PROTECTION"
    NO_PROTECTION
    "FULL_PROTECTION"
    FULL_PROTECTION

    GameServerGroupInstanceDefinition, GameServerGroupInstanceDefinitionArgs

    GameServerGroupLaunchTemplate, GameServerGroupLaunchTemplateArgs

    GameServerGroupTag, GameServerGroupTagArgs

    Key string

    The key for a developer-defined key:value pair for tagging an AWS resource.

    Value string

    The value for a developer-defined key:value pair for tagging an AWS resource.

    Key string

    The key for a developer-defined key:value pair for tagging an AWS resource.

    Value string

    The value for a developer-defined key:value pair for tagging an AWS resource.

    key String

    The key for a developer-defined key:value pair for tagging an AWS resource.

    value String

    The value for a developer-defined key:value pair for tagging an AWS resource.

    key string

    The key for a developer-defined key:value pair for tagging an AWS resource.

    value string

    The value for a developer-defined key:value pair for tagging an AWS resource.

    key str

    The key for a developer-defined key:value pair for tagging an AWS resource.

    value str

    The value for a developer-defined key:value pair for tagging an AWS resource.

    key String

    The key for a developer-defined key:value pair for tagging an AWS resource.

    value String

    The value for a developer-defined key:value pair for tagging an AWS resource.

    GameServerGroupTargetTrackingConfiguration, GameServerGroupTargetTrackingConfigurationArgs

    TargetValue float64

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.79.0 published on Monday, Oct 2, 2023 by Pulumi
    pulumi/pulumi-aws-native