GameLift / Client / create_container_fleet

create_container_fleet#

GameLift.Client.create_container_fleet(**kwargs)#

Creates a managed fleet of Amazon Elastic Compute Cloud (Amazon EC2) instances to host your containerized game servers. Use this operation to define how to deploy a container architecture onto each fleet instance and configure fleet settings. You can create a container fleet in any Amazon Web Services Regions that Amazon GameLift supports for multi-location fleets. A container fleet can be deployed to a single location or multiple locations. Container fleets are deployed with Amazon Linux 2023 as the instance operating system.

Define the fleet’s container architecture using container group definitions. Each fleet can have one of the following container group types:

  • The game server container group runs your game server build and dependent software. Amazon GameLift deploys one or more replicas of this container group to each fleet instance. The number of replicas depends on the computing capabilities of the fleet instance in use.

  • An optional per-instance container group might be used to run other software that only needs to run once per instance, such as background services, logging, or test processes. One per-instance container group is deployed to each fleet instance.

Each container group can include the definition for one or more containers. A container definition specifies a container image that is stored in an Amazon Elastic Container Registry (Amazon ECR) public or private repository.

Request options

Use this operation to make the following types of requests. Most fleet settings have default values, so you can create a working fleet with a minimal configuration and default values, which you can customize later.

  • Create a fleet with no container groups. You can configure a container fleet and then add container group definitions later. In this scenario, no fleet instances are deployed, and the fleet can’t host game sessions until you add a game server container group definition. Provide the following required parameter values:

    • FleetRoleArn

  • Create a fleet with a game server container group. Provide the following required parameter values:

    • FleetRoleArn

    • GameServerContainerGroupDefinitionName

  • Create a fleet with a game server container group and a per-instance container group. Provide the following required parameter values:

    • FleetRoleArn

    • GameServerContainerGroupDefinitionName

    • PerInstanceContainerGroupDefinitionName

Results

If successful, this operation creates a new container fleet resource, places it in PENDING status, and initiates the fleet creation workflow. For fleets with container groups, this workflow starts a fleet deployment and transitions the status to ACTIVE. Fleets without a container group are placed in CREATED status.

You can update most of the properties of a fleet, including container group definitions, and deploy the update across all fleet instances. Use a fleet update to deploy a new game server version update across the container fleet.

See also: AWS API Documentation

Request Syntax

response = client.create_container_fleet(
    FleetRoleArn='string',
    Description='string',
    GameServerContainerGroupDefinitionName='string',
    PerInstanceContainerGroupDefinitionName='string',
    InstanceConnectionPortRange={
        'FromPort': 123,
        'ToPort': 123
    },
    InstanceInboundPermissions=[
        {
            'FromPort': 123,
            'ToPort': 123,
            'IpRange': 'string',
            'Protocol': 'TCP'|'UDP'
        },
    ],
    GameServerContainerGroupsPerInstance=123,
    InstanceType='string',
    BillingType='ON_DEMAND'|'SPOT',
    Locations=[
        {
            'Location': 'string'
        },
    ],
    MetricGroups=[
        'string',
    ],
    NewGameSessionProtectionPolicy='NoProtection'|'FullProtection',
    GameSessionCreationLimitPolicy={
        'NewGameSessionsPerCreator': 123,
        'PolicyPeriodInMinutes': 123
    },
    LogConfiguration={
        'LogDestination': 'NONE'|'CLOUDWATCH'|'S3',
        'S3BucketName': 'string',
        'LogGroupArn': 'string'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • FleetRoleArn (string) –

    [REQUIRED]

    The unique identifier for an Identity and Access Management (IAM) role with permissions to run your containers on resources that are managed by Amazon GameLift. Use an IAM service role with the GameLiftContainerFleetPolicy managed policy attached. For more information, see Set up an IAM service role. You can’t change this fleet property after the fleet is created.

    IAM role ARN values use the following pattern: arn:aws:iam::[Amazon Web Services account]:role/[role name].

  • Description (string) – A meaningful description of the container fleet.

  • GameServerContainerGroupDefinitionName (string) –

    A container group definition resource that describes how to deploy containers with your game server build and support software onto each fleet instance. You can specify the container group definition’s name to use the latest version. Alternatively, provide an ARN value with a specific version number.

    Create a container group definition by calling CreateContainerGroupDefinition. This operation creates a ContainerGroupDefinition resource.

  • PerInstanceContainerGroupDefinitionName (string) –

    The name of a container group definition resource that describes a set of axillary software. A fleet instance has one process for executables in this container group. A per-instance container group is optional. You can update the fleet to add or remove a per-instance container group at any time. You can specify the container group definition’s name to use the latest version. Alternatively, provide an ARN value with a specific version number.

    Create a container group definition by calling CreateContainerGroupDefinition. This operation creates a ContainerGroupDefinition resource.

  • InstanceConnectionPortRange (dict) –

    The set of port numbers to open on each fleet instance. A fleet’s connection ports map to container ports that are configured in the fleet’s container group definitions.

    By default, Amazon GameLift calculates an optimal port range based on your fleet configuration. To use the calculated range, don’t set this parameter. The values are:

    • Port range: 4192 to a number calculated based on your fleet configuration. Amazon GameLift uses the following formula: 4192 + [# of game server container groups per fleet instance] * [# of container ports in the game server container group definition] + [# of container ports in the game server container group definition]

    You can also choose to manually set this parameter. When manually setting this parameter, you must use port numbers that match the fleet’s inbound permissions port range.

    Note

    If you set values manually, Amazon GameLift no longer calculates a port range for you, even if you later remove the manual settings.

    • FromPort (integer) – [REQUIRED]

      Starting value for the port range.

    • ToPort (integer) – [REQUIRED]

      Ending value for the port. Port numbers are end-inclusive. This value must be equal to or greater than FromPort.

  • InstanceInboundPermissions (list) –

    The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. As a best practice, when remotely accessing a fleet instance, we recommend opening ports only when you need them and closing them when you’re finished.

    By default, Amazon GameLift calculates an optimal port range based on your fleet configuration. To use the calculated range, don’t set this parameter. The values are:

    • Protocol: UDP

    • Port range: 4192 to a number calculated based on your fleet configuration. Amazon GameLift uses the following formula: 4192 + [# of game server container groups per fleet instance] * [# of container ports in the game server container group definition] + [# of container ports in the game server container group definition]

    You can also choose to manually set this parameter. When manually setting this parameter, you must use port numbers that match the fleet’s connection port range.

    Note

    If you set values manually, Amazon GameLift no longer calculates a port range for you, even if you later remove the manual settings.

    • (dict) –

      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 managed container fleets, the port settings must use the same port numbers as the fleet’s connection ports.

      For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP messaging and one for UDP.

      • FromPort (integer) – [REQUIRED]

        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.

      • ToPort (integer) – [REQUIRED]

        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.

      • IpRange (string) – [REQUIRED]

        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]”.

      • Protocol (string) – [REQUIRED]

        The network communication protocol used by the fleet.

  • GameServerContainerGroupsPerInstance (integer) –

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

    By default, Amazon GameLift calculates the maximum number of game server container groups that can fit on each instance. This calculation is based on the CPU and memory resources of the fleet’s instance type). To use the calculated maximum, don’t set this parameter. If you set this number manually, Amazon GameLift uses your value as long as it’s less than the calculated maximum.

  • InstanceType (string) –

    The Amazon EC2 instance type to use for all instances in the fleet. For multi-location fleets, the instance type must be available in the home region and all remote locations. 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.

    By default, Amazon GameLift selects an instance type that fits the needs of your container groups and is available in all selected fleet locations. You can also choose to manually set this parameter. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions of Amazon EC2 instance types.

    You can’t update this fleet property later.

  • BillingType (string) –

    Indicates whether to use On-Demand or Spot instances for this fleet. Learn more about when to use On-Demand versus Spot Instances. This fleet property can’t be changed after the fleet is created.

    By default, this property is set to ON_DEMAND.

    You can’t update this fleet property later.

  • Locations (list) –

    A set of locations to deploy container fleet instances to. You can add any Amazon Web Services Region or Local Zone that’s supported by Amazon GameLift. Provide a list of one or more Amazon Web Services Region codes, such as us-west-2, or Local Zone names. Also include the fleet’s home Region, which is the Amazon Web Services Region where the fleet is created. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting.

    • (dict) –

      A remote location where a multi-location fleet can deploy game servers for game hosting.

      • Location (string) – [REQUIRED]

        An Amazon Web Services Region code, such as us-west-2. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting.

  • MetricGroups (list) –

    The name of an Amazon Web Services CloudWatch metric group to add this fleet to. You can use a metric group to aggregate metrics for multiple fleets. You can specify an existing metric group name or use a new name to create a new metric group. Each fleet can have only one metric group, but you can change this value at any time.

    • (string) –

  • NewGameSessionProtectionPolicy (string) –

    Determines whether Amazon GameLift can shut down game sessions on the fleet that are actively running and hosting players. Amazon GameLift might prompt an instance shutdown when scaling down fleet capacity or when retiring unhealthy instances. You can also set game session protection for individual game sessions using UpdateGameSession.

    • NoProtection – Game sessions can be shut down during active gameplay.

    • FullProtection – Game sessions in ACTIVE status can’t be shut down.

    By default, this property is set to NoProtection.

  • GameSessionCreationLimitPolicy (dict) –

    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.

    • NewGameSessionsPerCreator (integer) –

      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 checks that the player (identified by CreatorId) has created fewer than game session limit in the specified time period.

    • PolicyPeriodInMinutes (integer) –

      The time span used in evaluating the resource creation limit policy.

  • LogConfiguration (dict) –

    A method for collecting container logs for the fleet. Amazon GameLift saves all standard output for each container in logs, including game session logs. You can select from the following methods:

    • 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.

    By default, this property is set to CLOUDWATCH.

    Amazon GameLift requires permissions to send logs other Amazon Web Services services in your account. These permissions are included in the IAM fleet role for this container fleet (see FleetRoleArn).

    • LogDestination (string) –

      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.

      • NONE – Don’t collect container logs.

    • S3BucketName (string) –

      If log destination is S3, logs are sent to the specified Amazon S3 bucket name.

    • LogGroupArn (string) –

      If log destination is CLOUDWATCH, logs are sent to the specified log group in Amazon CloudWatch.

  • Tags (list) –

    A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

    • (dict) –

      A label that you can assign to a Amazon GameLift resource.

      Learn more

      Tagging Amazon Web Services Resources in the Amazon Web Services General Reference

      Amazon Web Services Tagging Strategies

      Related actions

      All APIs by task

      • Key (string) – [REQUIRED]

        The key for a developer-defined key value pair for tagging an Amazon Web Services resource.

      • Value (string) – [REQUIRED]

        The value for a developer-defined key value pair for tagging an Amazon Web Services resource.

Return type:

dict

Returns:

Response Syntax

{
    'ContainerFleet': {
        'FleetId': 'string',
        'FleetArn': 'string',
        'FleetRoleArn': 'string',
        'GameServerContainerGroupDefinitionName': 'string',
        'GameServerContainerGroupDefinitionArn': 'string',
        'PerInstanceContainerGroupDefinitionName': 'string',
        'PerInstanceContainerGroupDefinitionArn': 'string',
        'InstanceConnectionPortRange': {
            'FromPort': 123,
            'ToPort': 123
        },
        'InstanceInboundPermissions': [
            {
                'FromPort': 123,
                'ToPort': 123,
                'IpRange': 'string',
                'Protocol': 'TCP'|'UDP'
            },
        ],
        'GameServerContainerGroupsPerInstance': 123,
        'MaximumGameServerContainerGroupsPerInstance': 123,
        'InstanceType': 'string',
        'BillingType': 'ON_DEMAND'|'SPOT',
        'Description': 'string',
        'CreationTime': datetime(2015, 1, 1),
        'MetricGroups': [
            'string',
        ],
        'NewGameSessionProtectionPolicy': 'NoProtection'|'FullProtection',
        'GameSessionCreationLimitPolicy': {
            'NewGameSessionsPerCreator': 123,
            'PolicyPeriodInMinutes': 123
        },
        'Status': 'PENDING'|'CREATING'|'CREATED'|'ACTIVATING'|'ACTIVE'|'UPDATING'|'DELETING',
        'DeploymentDetails': {
            'LatestDeploymentId': 'string'
        },
        'LogConfiguration': {
            'LogDestination': 'NONE'|'CLOUDWATCH'|'S3',
            'S3BucketName': 'string',
            'LogGroupArn': 'string'
        },
        'LocationAttributes': [
            {
                'Location': 'string',
                'Status': 'PENDING'|'CREATING'|'CREATED'|'ACTIVATING'|'ACTIVE'|'UPDATING'|'DELETING'
            },
        ]
    }
}

Response Structure

  • (dict) –

    • ContainerFleet (dict) –

      The properties for the new container fleet, including current status. All fleets are initially placed in PENDING status.

      • FleetId (string) –

        A unique identifier for the container fleet to retrieve.

      • FleetArn (string) –

        The Amazon Resource Name ( ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift fleet ARN, the resource ID matches the FleetId value.

      • FleetRoleArn (string) –

        The unique identifier for an Identity and Access Management (IAM) role with permissions to run your containers on resources that are managed by Amazon GameLift. See Set up an IAM service role. This fleet property can’t be changed.

      • GameServerContainerGroupDefinitionName (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.

      • GameServerContainerGroupDefinitionArn (string) –

        The Amazon Resource Name ( ARN) that is assigned to the fleet’s game server container group. The ARN value also identifies the specific container group definition version in use.

      • PerInstanceContainerGroupDefinitionName (string) –

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

      • PerInstanceContainerGroupDefinitionArn (string) –

        The Amazon Resource Name ( ARN) that is assigned to the fleet’s per-instance container group. The ARN value also identifies the specific container group definition version in use.

      • InstanceConnectionPortRange (dict) –

        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.

        • FromPort (integer) –

          Starting value for the port range.

        • ToPort (integer) –

          Ending value for the port. Port numbers are end-inclusive. This value must be equal to or greater than FromPort.

      • InstanceInboundPermissions (list) –

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

        • (dict) –

          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 managed container fleets, the port settings must use the same port numbers as the fleet’s connection ports.

          For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP messaging and one for UDP.

          • FromPort (integer) –

            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.

          • ToPort (integer) –

            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.

          • IpRange (string) –

            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]”.

          • Protocol (string) –

            The network communication protocol used by the fleet.

      • GameServerContainerGroupsPerInstance (integer) –

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

      • MaximumGameServerContainerGroupsPerInstance (integer) –

        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.

      • InstanceType (string) –

        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.

      • BillingType (string) –

        Indicates whether the fleet uses On-Demand or Spot instances for this fleet. Learn more about when to use On-Demand versus Spot Instances. You can’t update this fleet property.

        By default, this property is set to ON_DEMAND.

      • Description (string) –

        A meaningful description of the container fleet.

      • CreationTime (datetime) –

        A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

      • MetricGroups (list) –

        The name of an Amazon Web Services CloudWatch metric group to add this fleet to. Metric groups aggregate metrics for multiple fleets.

        • (string) –

      • NewGameSessionProtectionPolicy (string) –

        Determines whether Amazon GameLift can shut down game sessions on the fleet that are actively running and hosting players. Amazon GameLift might prompt an instance shutdown when scaling down fleet capacity or when retiring unhealthy instances. You can also set game session protection for individual game sessions using UpdateGameSession.

        • NoProtection – Game sessions can be shut down during active gameplay.

        • FullProtection – Game sessions in ACTIVE status can’t be shut down.

      • GameSessionCreationLimitPolicy (dict) –

        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.

        • NewGameSessionsPerCreator (integer) –

          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 checks that the player (identified by CreatorId) has created fewer than game session limit in the specified time period.

        • PolicyPeriodInMinutes (integer) –

          The time span used in evaluating the resource creation limit policy.

      • Status (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.

      • DeploymentDetails (dict) –

        Information about the most recent deployment for the container fleet.

        • LatestDeploymentId (string) –

          A unique identifier for a fleet deployment.

      • LogConfiguration (dict) –

        The method that is used to collect container logs for the fleet. Amazon GameLift saves all standard output for each container in logs, including game session logs.

        • CLOUDWATCH – Send logs to an Amazon CloudWatch log group that you define. Each container emits a log stream, which is organized in the log group.

        • S3 – Store logs in an Amazon S3 bucket that you define.

        • NONE – Don’t collect container logs.

        • LogDestination (string) –

          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.

          • NONE – Don’t collect container logs.

        • S3BucketName (string) –

          If log destination is S3, logs are sent to the specified Amazon S3 bucket name.

        • LogGroupArn (string) –

          If log destination is CLOUDWATCH, logs are sent to the specified log group in Amazon CloudWatch.

      • LocationAttributes (list) –

        Information about the container fleet’s remote locations where fleet instances are deployed.

        • (dict) –

          Details about a location in a multi-location container fleet.

          • Location (string) –

            A location identifier.

          • Status (string) –

            The status of fleet activity in the location.

            • 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.

Exceptions