aws.gamelift.Fleet
Explore with Pulumi AI
Provides a GameLift Fleet resource.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.gamelift.Fleet("example", {
    buildId: exampleAwsGameliftBuild.id,
    ec2InstanceType: "t2.micro",
    fleetType: "ON_DEMAND",
    name: "example-fleet-name",
    runtimeConfiguration: {
        serverProcesses: [{
            concurrentExecutions: 1,
            launchPath: "C:\\game\\GomokuServer.exe",
        }],
    },
});
import pulumi
import pulumi_aws as aws
example = aws.gamelift.Fleet("example",
    build_id=example_aws_gamelift_build["id"],
    ec2_instance_type="t2.micro",
    fleet_type="ON_DEMAND",
    name="example-fleet-name",
    runtime_configuration={
        "server_processes": [{
            "concurrent_executions": 1,
            "launch_path": "C:\\game\\GomokuServer.exe",
        }],
    })
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/gamelift"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gamelift.NewFleet(ctx, "example", &gamelift.FleetArgs{
			BuildId:         pulumi.Any(exampleAwsGameliftBuild.Id),
			Ec2InstanceType: pulumi.String("t2.micro"),
			FleetType:       pulumi.String("ON_DEMAND"),
			Name:            pulumi.String("example-fleet-name"),
			RuntimeConfiguration: &gamelift.FleetRuntimeConfigurationArgs{
				ServerProcesses: gamelift.FleetRuntimeConfigurationServerProcessArray{
					&gamelift.FleetRuntimeConfigurationServerProcessArgs{
						ConcurrentExecutions: pulumi.Int(1),
						LaunchPath:           pulumi.String("C:\\game\\GomokuServer.exe"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() => 
{
    var example = new Aws.GameLift.Fleet("example", new()
    {
        BuildId = exampleAwsGameliftBuild.Id,
        Ec2InstanceType = "t2.micro",
        FleetType = "ON_DEMAND",
        Name = "example-fleet-name",
        RuntimeConfiguration = new Aws.GameLift.Inputs.FleetRuntimeConfigurationArgs
        {
            ServerProcesses = new[]
            {
                new Aws.GameLift.Inputs.FleetRuntimeConfigurationServerProcessArgs
                {
                    ConcurrentExecutions = 1,
                    LaunchPath = "C:\\game\\GomokuServer.exe",
                },
            },
        },
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.gamelift.Fleet;
import com.pulumi.aws.gamelift.FleetArgs;
import com.pulumi.aws.gamelift.inputs.FleetRuntimeConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new Fleet("example", FleetArgs.builder()
            .buildId(exampleAwsGameliftBuild.id())
            .ec2InstanceType("t2.micro")
            .fleetType("ON_DEMAND")
            .name("example-fleet-name")
            .runtimeConfiguration(FleetRuntimeConfigurationArgs.builder()
                .serverProcesses(FleetRuntimeConfigurationServerProcessArgs.builder()
                    .concurrentExecutions(1)
                    .launchPath("C:\\game\\GomokuServer.exe")
                    .build())
                .build())
            .build());
    }
}
resources:
  example:
    type: aws:gamelift:Fleet
    properties:
      buildId: ${exampleAwsGameliftBuild.id}
      ec2InstanceType: t2.micro
      fleetType: ON_DEMAND
      name: example-fleet-name
      runtimeConfiguration:
        serverProcesses:
          - concurrentExecutions: 1
            launchPath: C:\game\GomokuServer.exe
Create Fleet Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Fleet(name: string, args: FleetArgs, opts?: CustomResourceOptions);@overload
def Fleet(resource_name: str,
          args: FleetArgs,
          opts: Optional[ResourceOptions] = None)
@overload
def Fleet(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          ec2_instance_type: Optional[str] = None,
          instance_role_arn: Optional[str] = None,
          description: Optional[str] = None,
          ec2_inbound_permissions: Optional[Sequence[FleetEc2InboundPermissionArgs]] = None,
          certificate_configuration: Optional[FleetCertificateConfigurationArgs] = None,
          fleet_type: Optional[str] = None,
          build_id: Optional[str] = None,
          metric_groups: Optional[Sequence[str]] = None,
          name: Optional[str] = None,
          new_game_session_protection_policy: Optional[str] = None,
          resource_creation_limit_policy: Optional[FleetResourceCreationLimitPolicyArgs] = None,
          runtime_configuration: Optional[FleetRuntimeConfigurationArgs] = None,
          script_id: Optional[str] = None,
          tags: Optional[Mapping[str, str]] = None)func NewFleet(ctx *Context, name string, args FleetArgs, opts ...ResourceOption) (*Fleet, error)public Fleet(string name, FleetArgs args, CustomResourceOptions? opts = null)type: aws:gamelift:Fleet
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args FleetArgs
- 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 FleetArgs
- 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 FleetArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FleetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FleetArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var examplefleetResourceResourceFromGameliftfleet = new Aws.GameLift.Fleet("examplefleetResourceResourceFromGameliftfleet", new()
{
    Ec2InstanceType = "string",
    InstanceRoleArn = "string",
    Description = "string",
    Ec2InboundPermissions = new[]
    {
        new Aws.GameLift.Inputs.FleetEc2InboundPermissionArgs
        {
            FromPort = 0,
            IpRange = "string",
            Protocol = "string",
            ToPort = 0,
        },
    },
    CertificateConfiguration = new Aws.GameLift.Inputs.FleetCertificateConfigurationArgs
    {
        CertificateType = "string",
    },
    FleetType = "string",
    BuildId = "string",
    MetricGroups = new[]
    {
        "string",
    },
    Name = "string",
    NewGameSessionProtectionPolicy = "string",
    ResourceCreationLimitPolicy = new Aws.GameLift.Inputs.FleetResourceCreationLimitPolicyArgs
    {
        NewGameSessionsPerCreator = 0,
        PolicyPeriodInMinutes = 0,
    },
    RuntimeConfiguration = new Aws.GameLift.Inputs.FleetRuntimeConfigurationArgs
    {
        GameSessionActivationTimeoutSeconds = 0,
        MaxConcurrentGameSessionActivations = 0,
        ServerProcesses = new[]
        {
            new Aws.GameLift.Inputs.FleetRuntimeConfigurationServerProcessArgs
            {
                ConcurrentExecutions = 0,
                LaunchPath = "string",
                Parameters = "string",
            },
        },
    },
    ScriptId = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
example, err := gamelift.NewFleet(ctx, "examplefleetResourceResourceFromGameliftfleet", &gamelift.FleetArgs{
	Ec2InstanceType: pulumi.String("string"),
	InstanceRoleArn: pulumi.String("string"),
	Description:     pulumi.String("string"),
	Ec2InboundPermissions: gamelift.FleetEc2InboundPermissionArray{
		&gamelift.FleetEc2InboundPermissionArgs{
			FromPort: pulumi.Int(0),
			IpRange:  pulumi.String("string"),
			Protocol: pulumi.String("string"),
			ToPort:   pulumi.Int(0),
		},
	},
	CertificateConfiguration: &gamelift.FleetCertificateConfigurationArgs{
		CertificateType: pulumi.String("string"),
	},
	FleetType: pulumi.String("string"),
	BuildId:   pulumi.String("string"),
	MetricGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:                           pulumi.String("string"),
	NewGameSessionProtectionPolicy: pulumi.String("string"),
	ResourceCreationLimitPolicy: &gamelift.FleetResourceCreationLimitPolicyArgs{
		NewGameSessionsPerCreator: pulumi.Int(0),
		PolicyPeriodInMinutes:     pulumi.Int(0),
	},
	RuntimeConfiguration: &gamelift.FleetRuntimeConfigurationArgs{
		GameSessionActivationTimeoutSeconds: pulumi.Int(0),
		MaxConcurrentGameSessionActivations: pulumi.Int(0),
		ServerProcesses: gamelift.FleetRuntimeConfigurationServerProcessArray{
			&gamelift.FleetRuntimeConfigurationServerProcessArgs{
				ConcurrentExecutions: pulumi.Int(0),
				LaunchPath:           pulumi.String("string"),
				Parameters:           pulumi.String("string"),
			},
		},
	},
	ScriptId: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
var examplefleetResourceResourceFromGameliftfleet = new Fleet("examplefleetResourceResourceFromGameliftfleet", FleetArgs.builder()
    .ec2InstanceType("string")
    .instanceRoleArn("string")
    .description("string")
    .ec2InboundPermissions(FleetEc2InboundPermissionArgs.builder()
        .fromPort(0)
        .ipRange("string")
        .protocol("string")
        .toPort(0)
        .build())
    .certificateConfiguration(FleetCertificateConfigurationArgs.builder()
        .certificateType("string")
        .build())
    .fleetType("string")
    .buildId("string")
    .metricGroups("string")
    .name("string")
    .newGameSessionProtectionPolicy("string")
    .resourceCreationLimitPolicy(FleetResourceCreationLimitPolicyArgs.builder()
        .newGameSessionsPerCreator(0)
        .policyPeriodInMinutes(0)
        .build())
    .runtimeConfiguration(FleetRuntimeConfigurationArgs.builder()
        .gameSessionActivationTimeoutSeconds(0)
        .maxConcurrentGameSessionActivations(0)
        .serverProcesses(FleetRuntimeConfigurationServerProcessArgs.builder()
            .concurrentExecutions(0)
            .launchPath("string")
            .parameters("string")
            .build())
        .build())
    .scriptId("string")
    .tags(Map.of("string", "string"))
    .build());
examplefleet_resource_resource_from_gameliftfleet = aws.gamelift.Fleet("examplefleetResourceResourceFromGameliftfleet",
    ec2_instance_type="string",
    instance_role_arn="string",
    description="string",
    ec2_inbound_permissions=[{
        "from_port": 0,
        "ip_range": "string",
        "protocol": "string",
        "to_port": 0,
    }],
    certificate_configuration={
        "certificate_type": "string",
    },
    fleet_type="string",
    build_id="string",
    metric_groups=["string"],
    name="string",
    new_game_session_protection_policy="string",
    resource_creation_limit_policy={
        "new_game_sessions_per_creator": 0,
        "policy_period_in_minutes": 0,
    },
    runtime_configuration={
        "game_session_activation_timeout_seconds": 0,
        "max_concurrent_game_session_activations": 0,
        "server_processes": [{
            "concurrent_executions": 0,
            "launch_path": "string",
            "parameters": "string",
        }],
    },
    script_id="string",
    tags={
        "string": "string",
    })
const examplefleetResourceResourceFromGameliftfleet = new aws.gamelift.Fleet("examplefleetResourceResourceFromGameliftfleet", {
    ec2InstanceType: "string",
    instanceRoleArn: "string",
    description: "string",
    ec2InboundPermissions: [{
        fromPort: 0,
        ipRange: "string",
        protocol: "string",
        toPort: 0,
    }],
    certificateConfiguration: {
        certificateType: "string",
    },
    fleetType: "string",
    buildId: "string",
    metricGroups: ["string"],
    name: "string",
    newGameSessionProtectionPolicy: "string",
    resourceCreationLimitPolicy: {
        newGameSessionsPerCreator: 0,
        policyPeriodInMinutes: 0,
    },
    runtimeConfiguration: {
        gameSessionActivationTimeoutSeconds: 0,
        maxConcurrentGameSessionActivations: 0,
        serverProcesses: [{
            concurrentExecutions: 0,
            launchPath: "string",
            parameters: "string",
        }],
    },
    scriptId: "string",
    tags: {
        string: "string",
    },
});
type: aws:gamelift:Fleet
properties:
    buildId: string
    certificateConfiguration:
        certificateType: string
    description: string
    ec2InboundPermissions:
        - fromPort: 0
          ipRange: string
          protocol: string
          toPort: 0
    ec2InstanceType: string
    fleetType: string
    instanceRoleArn: string
    metricGroups:
        - string
    name: string
    newGameSessionProtectionPolicy: string
    resourceCreationLimitPolicy:
        newGameSessionsPerCreator: 0
        policyPeriodInMinutes: 0
    runtimeConfiguration:
        gameSessionActivationTimeoutSeconds: 0
        maxConcurrentGameSessionActivations: 0
        serverProcesses:
            - concurrentExecutions: 0
              launchPath: string
              parameters: string
    scriptId: string
    tags:
        string: string
Fleet Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Fleet resource accepts the following input properties:
- Ec2InstanceType string
- Name of an EC2 instance typeE.g., t2.micro
- BuildId string
- ID of the GameLift Build to be deployed on the fleet.
- CertificateConfiguration FleetCertificate Configuration 
- Prompts GameLift to generate a TLS/SSL certificate for the fleet. See certificate_configuration.
- Description string
- Human-readable description of the fleet.
- Ec2InboundPermissions List<FleetEc2Inbound Permission> 
- Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. See below.
- FleetType string
- Type of fleet. This value must be ON_DEMANDorSPOT. Defaults toON_DEMAND.
- InstanceRole stringArn 
- ARN of an IAM role that instances in the fleet can assume.
- MetricGroups List<string>
- List of names of metric groups to add this fleet to. A metric group tracks metrics across all fleets in the group. Defaults to default.
- Name string
- The name of the fleet.
- NewGame stringSession Protection Policy 
- Game session protection policy to apply to all instances in this fleetE.g., FullProtection. Defaults toNoProtection.
- ResourceCreation FleetLimit Policy Resource Creation Limit Policy 
- Policy that limits the number of game sessions an individual player can create over a span of time for this fleet. See below.
- RuntimeConfiguration FleetRuntime Configuration 
- Instructions for launching server processes on each instance in the fleet. See below.
- ScriptId string
- ID of the GameLift Script to be deployed on the fleet.
- Dictionary<string, string>
- Key-value map of resource tags. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Ec2InstanceType string
- Name of an EC2 instance typeE.g., t2.micro
- BuildId string
- ID of the GameLift Build to be deployed on the fleet.
- CertificateConfiguration FleetCertificate Configuration Args 
- Prompts GameLift to generate a TLS/SSL certificate for the fleet. See certificate_configuration.
- Description string
- Human-readable description of the fleet.
- Ec2InboundPermissions []FleetEc2Inbound Permission Args 
- Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. See below.
- FleetType string
- Type of fleet. This value must be ON_DEMANDorSPOT. Defaults toON_DEMAND.
- InstanceRole stringArn 
- ARN of an IAM role that instances in the fleet can assume.
- MetricGroups []string
- List of names of metric groups to add this fleet to. A metric group tracks metrics across all fleets in the group. Defaults to default.
- Name string
- The name of the fleet.
- NewGame stringSession Protection Policy 
- Game session protection policy to apply to all instances in this fleetE.g., FullProtection. Defaults toNoProtection.
- ResourceCreation FleetLimit Policy Resource Creation Limit Policy Args 
- Policy that limits the number of game sessions an individual player can create over a span of time for this fleet. See below.
- RuntimeConfiguration FleetRuntime Configuration Args 
- Instructions for launching server processes on each instance in the fleet. See below.
- ScriptId string
- ID of the GameLift Script to be deployed on the fleet.
- map[string]string
- Key-value map of resource tags. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- ec2InstanceType String
- Name of an EC2 instance typeE.g., t2.micro
- buildId String
- ID of the GameLift Build to be deployed on the fleet.
- certificateConfiguration FleetCertificate Configuration 
- Prompts GameLift to generate a TLS/SSL certificate for the fleet. See certificate_configuration.
- description String
- Human-readable description of the fleet.
- ec2InboundPermissions List<FleetEc2Inbound Permission> 
- Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. See below.
- fleetType String
- Type of fleet. This value must be ON_DEMANDorSPOT. Defaults toON_DEMAND.
- instanceRole StringArn 
- ARN of an IAM role that instances in the fleet can assume.
- metricGroups List<String>
- List of names of metric groups to add this fleet to. A metric group tracks metrics across all fleets in the group. Defaults to default.
- name String
- The name of the fleet.
- newGame StringSession Protection Policy 
- Game session protection policy to apply to all instances in this fleetE.g., FullProtection. Defaults toNoProtection.
- resourceCreation FleetLimit Policy Resource Creation Limit Policy 
- Policy that limits the number of game sessions an individual player can create over a span of time for this fleet. See below.
- runtimeConfiguration FleetRuntime Configuration 
- Instructions for launching server processes on each instance in the fleet. See below.
- scriptId String
- ID of the GameLift Script to be deployed on the fleet.
- Map<String,String>
- Key-value map of resource tags. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- ec2InstanceType string
- Name of an EC2 instance typeE.g., t2.micro
- buildId string
- ID of the GameLift Build to be deployed on the fleet.
- certificateConfiguration FleetCertificate Configuration 
- Prompts GameLift to generate a TLS/SSL certificate for the fleet. See certificate_configuration.
- description string
- Human-readable description of the fleet.
- ec2InboundPermissions FleetEc2Inbound Permission[] 
- Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. See below.
- fleetType string
- Type of fleet. This value must be ON_DEMANDorSPOT. Defaults toON_DEMAND.
- instanceRole stringArn 
- ARN of an IAM role that instances in the fleet can assume.
- metricGroups string[]
- List of names of metric groups to add this fleet to. A metric group tracks metrics across all fleets in the group. Defaults to default.
- name string
- The name of the fleet.
- newGame stringSession Protection Policy 
- Game session protection policy to apply to all instances in this fleetE.g., FullProtection. Defaults toNoProtection.
- resourceCreation FleetLimit Policy Resource Creation Limit Policy 
- Policy that limits the number of game sessions an individual player can create over a span of time for this fleet. See below.
- runtimeConfiguration FleetRuntime Configuration 
- Instructions for launching server processes on each instance in the fleet. See below.
- scriptId string
- ID of the GameLift Script to be deployed on the fleet.
- {[key: string]: string}
- Key-value map of resource tags. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- ec2_instance_ strtype 
- Name of an EC2 instance typeE.g., t2.micro
- build_id str
- ID of the GameLift Build to be deployed on the fleet.
- certificate_configuration FleetCertificate Configuration Args 
- Prompts GameLift to generate a TLS/SSL certificate for the fleet. See certificate_configuration.
- description str
- Human-readable description of the fleet.
- ec2_inbound_ Sequence[Fleetpermissions Ec2Inbound Permission Args] 
- Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. See below.
- fleet_type str
- Type of fleet. This value must be ON_DEMANDorSPOT. Defaults toON_DEMAND.
- instance_role_ strarn 
- ARN of an IAM role that instances in the fleet can assume.
- metric_groups Sequence[str]
- List of names of metric groups to add this fleet to. A metric group tracks metrics across all fleets in the group. Defaults to default.
- name str
- The name of the fleet.
- new_game_ strsession_ protection_ policy 
- Game session protection policy to apply to all instances in this fleetE.g., FullProtection. Defaults toNoProtection.
- resource_creation_ Fleetlimit_ policy Resource Creation Limit Policy Args 
- Policy that limits the number of game sessions an individual player can create over a span of time for this fleet. See below.
- runtime_configuration FleetRuntime Configuration Args 
- Instructions for launching server processes on each instance in the fleet. See below.
- script_id str
- ID of the GameLift Script to be deployed on the fleet.
- Mapping[str, str]
- Key-value map of resource tags. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- ec2InstanceType String
- Name of an EC2 instance typeE.g., t2.micro
- buildId String
- ID of the GameLift Build to be deployed on the fleet.
- certificateConfiguration Property Map
- Prompts GameLift to generate a TLS/SSL certificate for the fleet. See certificate_configuration.
- description String
- Human-readable description of the fleet.
- ec2InboundPermissions List<Property Map>
- Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. See below.
- fleetType String
- Type of fleet. This value must be ON_DEMANDorSPOT. Defaults toON_DEMAND.
- instanceRole StringArn 
- ARN of an IAM role that instances in the fleet can assume.
- metricGroups List<String>
- List of names of metric groups to add this fleet to. A metric group tracks metrics across all fleets in the group. Defaults to default.
- name String
- The name of the fleet.
- newGame StringSession Protection Policy 
- Game session protection policy to apply to all instances in this fleetE.g., FullProtection. Defaults toNoProtection.
- resourceCreation Property MapLimit Policy 
- Policy that limits the number of game sessions an individual player can create over a span of time for this fleet. See below.
- runtimeConfiguration Property Map
- Instructions for launching server processes on each instance in the fleet. See below.
- scriptId String
- ID of the GameLift Script to be deployed on the fleet.
- Map<String>
- Key-value map of resource tags. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
Outputs
All input properties are implicitly available as output properties. Additionally, the Fleet resource produces the following output properties:
- Arn string
- Fleet ARN.
- BuildArn string
- Build ARN.
- Id string
- The provider-assigned unique ID for this managed resource.
- LogPaths List<string>
- OperatingSystem string
- Operating system of the fleet's computing resources.
- ScriptArn string
- Script ARN.
- Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- Arn string
- Fleet ARN.
- BuildArn string
- Build ARN.
- Id string
- The provider-assigned unique ID for this managed resource.
- LogPaths []string
- OperatingSystem string
- Operating system of the fleet's computing resources.
- ScriptArn string
- Script ARN.
- map[string]string
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- arn String
- Fleet ARN.
- buildArn String
- Build ARN.
- id String
- The provider-assigned unique ID for this managed resource.
- logPaths List<String>
- operatingSystem String
- Operating system of the fleet's computing resources.
- scriptArn String
- Script ARN.
- Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- arn string
- Fleet ARN.
- buildArn string
- Build ARN.
- id string
- The provider-assigned unique ID for this managed resource.
- logPaths string[]
- operatingSystem string
- Operating system of the fleet's computing resources.
- scriptArn string
- Script ARN.
- {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- arn str
- Fleet ARN.
- build_arn str
- Build ARN.
- id str
- The provider-assigned unique ID for this managed resource.
- log_paths Sequence[str]
- operating_system str
- Operating system of the fleet's computing resources.
- script_arn str
- Script ARN.
- Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- arn String
- Fleet ARN.
- buildArn String
- Build ARN.
- id String
- The provider-assigned unique ID for this managed resource.
- logPaths List<String>
- operatingSystem String
- Operating system of the fleet's computing resources.
- scriptArn String
- Script ARN.
- Map<String>
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
Look up Existing Fleet Resource
Get an existing Fleet resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: FleetState, opts?: CustomResourceOptions): Fleet@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        build_arn: Optional[str] = None,
        build_id: Optional[str] = None,
        certificate_configuration: Optional[FleetCertificateConfigurationArgs] = None,
        description: Optional[str] = None,
        ec2_inbound_permissions: Optional[Sequence[FleetEc2InboundPermissionArgs]] = None,
        ec2_instance_type: Optional[str] = None,
        fleet_type: Optional[str] = None,
        instance_role_arn: Optional[str] = None,
        log_paths: Optional[Sequence[str]] = None,
        metric_groups: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        new_game_session_protection_policy: Optional[str] = None,
        operating_system: Optional[str] = None,
        resource_creation_limit_policy: Optional[FleetResourceCreationLimitPolicyArgs] = None,
        runtime_configuration: Optional[FleetRuntimeConfigurationArgs] = None,
        script_arn: Optional[str] = None,
        script_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> Fleetfunc GetFleet(ctx *Context, name string, id IDInput, state *FleetState, opts ...ResourceOption) (*Fleet, error)public static Fleet Get(string name, Input<string> id, FleetState? state, CustomResourceOptions? opts = null)public static Fleet get(String name, Output<String> id, FleetState state, CustomResourceOptions options)resources:  _:    type: aws:gamelift:Fleet    get:      id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Arn string
- Fleet ARN.
- BuildArn string
- Build ARN.
- BuildId string
- ID of the GameLift Build to be deployed on the fleet.
- CertificateConfiguration FleetCertificate Configuration 
- Prompts GameLift to generate a TLS/SSL certificate for the fleet. See certificate_configuration.
- Description string
- Human-readable description of the fleet.
- Ec2InboundPermissions List<FleetEc2Inbound Permission> 
- Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. See below.
- Ec2InstanceType string
- Name of an EC2 instance typeE.g., t2.micro
- FleetType string
- Type of fleet. This value must be ON_DEMANDorSPOT. Defaults toON_DEMAND.
- InstanceRole stringArn 
- ARN of an IAM role that instances in the fleet can assume.
- LogPaths List<string>
- MetricGroups List<string>
- List of names of metric groups to add this fleet to. A metric group tracks metrics across all fleets in the group. Defaults to default.
- Name string
- The name of the fleet.
- NewGame stringSession Protection Policy 
- Game session protection policy to apply to all instances in this fleetE.g., FullProtection. Defaults toNoProtection.
- OperatingSystem string
- Operating system of the fleet's computing resources.
- ResourceCreation FleetLimit Policy Resource Creation Limit Policy 
- Policy that limits the number of game sessions an individual player can create over a span of time for this fleet. See below.
- RuntimeConfiguration FleetRuntime Configuration 
- Instructions for launching server processes on each instance in the fleet. See below.
- ScriptArn string
- Script ARN.
- ScriptId string
- ID of the GameLift Script to be deployed on the fleet.
- Dictionary<string, string>
- Key-value map of resource tags. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- Arn string
- Fleet ARN.
- BuildArn string
- Build ARN.
- BuildId string
- ID of the GameLift Build to be deployed on the fleet.
- CertificateConfiguration FleetCertificate Configuration Args 
- Prompts GameLift to generate a TLS/SSL certificate for the fleet. See certificate_configuration.
- Description string
- Human-readable description of the fleet.
- Ec2InboundPermissions []FleetEc2Inbound Permission Args 
- Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. See below.
- Ec2InstanceType string
- Name of an EC2 instance typeE.g., t2.micro
- FleetType string
- Type of fleet. This value must be ON_DEMANDorSPOT. Defaults toON_DEMAND.
- InstanceRole stringArn 
- ARN of an IAM role that instances in the fleet can assume.
- LogPaths []string
- MetricGroups []string
- List of names of metric groups to add this fleet to. A metric group tracks metrics across all fleets in the group. Defaults to default.
- Name string
- The name of the fleet.
- NewGame stringSession Protection Policy 
- Game session protection policy to apply to all instances in this fleetE.g., FullProtection. Defaults toNoProtection.
- OperatingSystem string
- Operating system of the fleet's computing resources.
- ResourceCreation FleetLimit Policy Resource Creation Limit Policy Args 
- Policy that limits the number of game sessions an individual player can create over a span of time for this fleet. See below.
- RuntimeConfiguration FleetRuntime Configuration Args 
- Instructions for launching server processes on each instance in the fleet. See below.
- ScriptArn string
- Script ARN.
- ScriptId string
- ID of the GameLift Script to be deployed on the fleet.
- map[string]string
- Key-value map of resource tags. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- map[string]string
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- arn String
- Fleet ARN.
- buildArn String
- Build ARN.
- buildId String
- ID of the GameLift Build to be deployed on the fleet.
- certificateConfiguration FleetCertificate Configuration 
- Prompts GameLift to generate a TLS/SSL certificate for the fleet. See certificate_configuration.
- description String
- Human-readable description of the fleet.
- ec2InboundPermissions List<FleetEc2Inbound Permission> 
- Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. See below.
- ec2InstanceType String
- Name of an EC2 instance typeE.g., t2.micro
- fleetType String
- Type of fleet. This value must be ON_DEMANDorSPOT. Defaults toON_DEMAND.
- instanceRole StringArn 
- ARN of an IAM role that instances in the fleet can assume.
- logPaths List<String>
- metricGroups List<String>
- List of names of metric groups to add this fleet to. A metric group tracks metrics across all fleets in the group. Defaults to default.
- name String
- The name of the fleet.
- newGame StringSession Protection Policy 
- Game session protection policy to apply to all instances in this fleetE.g., FullProtection. Defaults toNoProtection.
- operatingSystem String
- Operating system of the fleet's computing resources.
- resourceCreation FleetLimit Policy Resource Creation Limit Policy 
- Policy that limits the number of game sessions an individual player can create over a span of time for this fleet. See below.
- runtimeConfiguration FleetRuntime Configuration 
- Instructions for launching server processes on each instance in the fleet. See below.
- scriptArn String
- Script ARN.
- scriptId String
- ID of the GameLift Script to be deployed on the fleet.
- Map<String,String>
- Key-value map of resource tags. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- arn string
- Fleet ARN.
- buildArn string
- Build ARN.
- buildId string
- ID of the GameLift Build to be deployed on the fleet.
- certificateConfiguration FleetCertificate Configuration 
- Prompts GameLift to generate a TLS/SSL certificate for the fleet. See certificate_configuration.
- description string
- Human-readable description of the fleet.
- ec2InboundPermissions FleetEc2Inbound Permission[] 
- Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. See below.
- ec2InstanceType string
- Name of an EC2 instance typeE.g., t2.micro
- fleetType string
- Type of fleet. This value must be ON_DEMANDorSPOT. Defaults toON_DEMAND.
- instanceRole stringArn 
- ARN of an IAM role that instances in the fleet can assume.
- logPaths string[]
- metricGroups string[]
- List of names of metric groups to add this fleet to. A metric group tracks metrics across all fleets in the group. Defaults to default.
- name string
- The name of the fleet.
- newGame stringSession Protection Policy 
- Game session protection policy to apply to all instances in this fleetE.g., FullProtection. Defaults toNoProtection.
- operatingSystem string
- Operating system of the fleet's computing resources.
- resourceCreation FleetLimit Policy Resource Creation Limit Policy 
- Policy that limits the number of game sessions an individual player can create over a span of time for this fleet. See below.
- runtimeConfiguration FleetRuntime Configuration 
- Instructions for launching server processes on each instance in the fleet. See below.
- scriptArn string
- Script ARN.
- scriptId string
- ID of the GameLift Script to be deployed on the fleet.
- {[key: string]: string}
- Key-value map of resource tags. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- arn str
- Fleet ARN.
- build_arn str
- Build ARN.
- build_id str
- ID of the GameLift Build to be deployed on the fleet.
- certificate_configuration FleetCertificate Configuration Args 
- Prompts GameLift to generate a TLS/SSL certificate for the fleet. See certificate_configuration.
- description str
- Human-readable description of the fleet.
- ec2_inbound_ Sequence[Fleetpermissions Ec2Inbound Permission Args] 
- Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. See below.
- ec2_instance_ strtype 
- Name of an EC2 instance typeE.g., t2.micro
- fleet_type str
- Type of fleet. This value must be ON_DEMANDorSPOT. Defaults toON_DEMAND.
- instance_role_ strarn 
- ARN of an IAM role that instances in the fleet can assume.
- log_paths Sequence[str]
- metric_groups Sequence[str]
- List of names of metric groups to add this fleet to. A metric group tracks metrics across all fleets in the group. Defaults to default.
- name str
- The name of the fleet.
- new_game_ strsession_ protection_ policy 
- Game session protection policy to apply to all instances in this fleetE.g., FullProtection. Defaults toNoProtection.
- operating_system str
- Operating system of the fleet's computing resources.
- resource_creation_ Fleetlimit_ policy Resource Creation Limit Policy Args 
- Policy that limits the number of game sessions an individual player can create over a span of time for this fleet. See below.
- runtime_configuration FleetRuntime Configuration Args 
- Instructions for launching server processes on each instance in the fleet. See below.
- script_arn str
- Script ARN.
- script_id str
- ID of the GameLift Script to be deployed on the fleet.
- Mapping[str, str]
- Key-value map of resource tags. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- arn String
- Fleet ARN.
- buildArn String
- Build ARN.
- buildId String
- ID of the GameLift Build to be deployed on the fleet.
- certificateConfiguration Property Map
- Prompts GameLift to generate a TLS/SSL certificate for the fleet. See certificate_configuration.
- description String
- Human-readable description of the fleet.
- ec2InboundPermissions List<Property Map>
- Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. See below.
- ec2InstanceType String
- Name of an EC2 instance typeE.g., t2.micro
- fleetType String
- Type of fleet. This value must be ON_DEMANDorSPOT. Defaults toON_DEMAND.
- instanceRole StringArn 
- ARN of an IAM role that instances in the fleet can assume.
- logPaths List<String>
- metricGroups List<String>
- List of names of metric groups to add this fleet to. A metric group tracks metrics across all fleets in the group. Defaults to default.
- name String
- The name of the fleet.
- newGame StringSession Protection Policy 
- Game session protection policy to apply to all instances in this fleetE.g., FullProtection. Defaults toNoProtection.
- operatingSystem String
- Operating system of the fleet's computing resources.
- resourceCreation Property MapLimit Policy 
- Policy that limits the number of game sessions an individual player can create over a span of time for this fleet. See below.
- runtimeConfiguration Property Map
- Instructions for launching server processes on each instance in the fleet. See below.
- scriptArn String
- Script ARN.
- scriptId String
- ID of the GameLift Script to be deployed on the fleet.
- Map<String>
- Key-value map of resource tags. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Map<String>
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
Supporting Types
FleetCertificateConfiguration, FleetCertificateConfigurationArgs      
- CertificateType string
- Indicates whether a TLS/SSL certificate is generated for a fleet. Valid values are DISABLEDandGENERATED. Default value isDISABLED.
- CertificateType string
- Indicates whether a TLS/SSL certificate is generated for a fleet. Valid values are DISABLEDandGENERATED. Default value isDISABLED.
- certificateType String
- Indicates whether a TLS/SSL certificate is generated for a fleet. Valid values are DISABLEDandGENERATED. Default value isDISABLED.
- certificateType string
- Indicates whether a TLS/SSL certificate is generated for a fleet. Valid values are DISABLEDandGENERATED. Default value isDISABLED.
- certificate_type str
- Indicates whether a TLS/SSL certificate is generated for a fleet. Valid values are DISABLEDandGENERATED. Default value isDISABLED.
- certificateType String
- Indicates whether a TLS/SSL certificate is generated for a fleet. Valid values are DISABLEDandGENERATED. Default value isDISABLED.
FleetEc2InboundPermission, FleetEc2InboundPermissionArgs      
- FromPort int
- Starting value for a range of allowed port numbers.
- IpRange string
- Range of allowed IP addresses expressed in CIDR notationE.g., 000.000.000.000/[subnet mask]or0.0.0.0/[subnet mask].
- Protocol string
- Network communication protocol used by the fleetE.g., TCPorUDP
- ToPort int
- Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than from_port.
- FromPort int
- Starting value for a range of allowed port numbers.
- IpRange string
- Range of allowed IP addresses expressed in CIDR notationE.g., 000.000.000.000/[subnet mask]or0.0.0.0/[subnet mask].
- Protocol string
- Network communication protocol used by the fleetE.g., TCPorUDP
- ToPort int
- Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than from_port.
- fromPort Integer
- Starting value for a range of allowed port numbers.
- ipRange String
- Range of allowed IP addresses expressed in CIDR notationE.g., 000.000.000.000/[subnet mask]or0.0.0.0/[subnet mask].
- protocol String
- Network communication protocol used by the fleetE.g., TCPorUDP
- toPort Integer
- Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than from_port.
- fromPort number
- Starting value for a range of allowed port numbers.
- ipRange string
- Range of allowed IP addresses expressed in CIDR notationE.g., 000.000.000.000/[subnet mask]or0.0.0.0/[subnet mask].
- protocol string
- Network communication protocol used by the fleetE.g., TCPorUDP
- toPort number
- Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than from_port.
- from_port int
- Starting value for a range of allowed port numbers.
- ip_range str
- Range of allowed IP addresses expressed in CIDR notationE.g., 000.000.000.000/[subnet mask]or0.0.0.0/[subnet mask].
- protocol str
- Network communication protocol used by the fleetE.g., TCPorUDP
- to_port int
- Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than from_port.
- fromPort Number
- Starting value for a range of allowed port numbers.
- ipRange String
- Range of allowed IP addresses expressed in CIDR notationE.g., 000.000.000.000/[subnet mask]or0.0.0.0/[subnet mask].
- protocol String
- Network communication protocol used by the fleetE.g., TCPorUDP
- toPort Number
- Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than from_port.
FleetResourceCreationLimitPolicy, FleetResourceCreationLimitPolicyArgs          
- NewGame intSessions Per Creator 
- Maximum number of game sessions that an individual can create during the policy period.
- PolicyPeriod intIn Minutes 
- Time span used in evaluating the resource creation limit policy.
- NewGame intSessions Per Creator 
- Maximum number of game sessions that an individual can create during the policy period.
- PolicyPeriod intIn Minutes 
- Time span used in evaluating the resource creation limit policy.
- newGame IntegerSessions Per Creator 
- Maximum number of game sessions that an individual can create during the policy period.
- policyPeriod IntegerIn Minutes 
- Time span used in evaluating the resource creation limit policy.
- newGame numberSessions Per Creator 
- Maximum number of game sessions that an individual can create during the policy period.
- policyPeriod numberIn Minutes 
- Time span used in evaluating the resource creation limit policy.
- new_game_ intsessions_ per_ creator 
- Maximum number of game sessions that an individual can create during the policy period.
- policy_period_ intin_ minutes 
- Time span used in evaluating the resource creation limit policy.
- newGame NumberSessions Per Creator 
- Maximum number of game sessions that an individual can create during the policy period.
- policyPeriod NumberIn Minutes 
- Time span used in evaluating the resource creation limit policy.
FleetRuntimeConfiguration, FleetRuntimeConfigurationArgs      
- GameSession intActivation Timeout Seconds 
- Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING.
- MaxConcurrent intGame Session Activations 
- Maximum number of game sessions with status ACTIVATINGto allow on an instance simultaneously.
- ServerProcesses List<FleetRuntime Configuration Server Process> 
- Collection of server process configurations that describe which server processes to run on each instance in a fleet. See below.
- GameSession intActivation Timeout Seconds 
- Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING.
- MaxConcurrent intGame Session Activations 
- Maximum number of game sessions with status ACTIVATINGto allow on an instance simultaneously.
- ServerProcesses []FleetRuntime Configuration Server Process 
- Collection of server process configurations that describe which server processes to run on each instance in a fleet. See below.
- gameSession IntegerActivation Timeout Seconds 
- Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING.
- maxConcurrent IntegerGame Session Activations 
- Maximum number of game sessions with status ACTIVATINGto allow on an instance simultaneously.
- serverProcesses List<FleetRuntime Configuration Server Process> 
- Collection of server process configurations that describe which server processes to run on each instance in a fleet. See below.
- gameSession numberActivation Timeout Seconds 
- Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING.
- maxConcurrent numberGame Session Activations 
- Maximum number of game sessions with status ACTIVATINGto allow on an instance simultaneously.
- serverProcesses FleetRuntime Configuration Server Process[] 
- Collection of server process configurations that describe which server processes to run on each instance in a fleet. See below.
- game_session_ intactivation_ timeout_ seconds 
- Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING.
- max_concurrent_ intgame_ session_ activations 
- Maximum number of game sessions with status ACTIVATINGto allow on an instance simultaneously.
- server_processes Sequence[FleetRuntime Configuration Server Process] 
- Collection of server process configurations that describe which server processes to run on each instance in a fleet. See below.
- gameSession NumberActivation Timeout Seconds 
- Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING.
- maxConcurrent NumberGame Session Activations 
- Maximum number of game sessions with status ACTIVATINGto allow on an instance simultaneously.
- serverProcesses List<Property Map>
- Collection of server process configurations that describe which server processes to run on each instance in a fleet. See below.
FleetRuntimeConfigurationServerProcess, FleetRuntimeConfigurationServerProcessArgs          
- ConcurrentExecutions int
- Number of server processes using this configuration to run concurrently on an instance.
- LaunchPath string
- Location of the server executable in a game build. All game builds are installed on instances at the root : for Windows instances C:\game, and for Linux instances/local/game.
- Parameters string
- Optional list of parameters to pass to the server executable on launch.
- ConcurrentExecutions int
- Number of server processes using this configuration to run concurrently on an instance.
- LaunchPath string
- Location of the server executable in a game build. All game builds are installed on instances at the root : for Windows instances C:\game, and for Linux instances/local/game.
- Parameters string
- Optional list of parameters to pass to the server executable on launch.
- concurrentExecutions Integer
- Number of server processes using this configuration to run concurrently on an instance.
- launchPath String
- Location of the server executable in a game build. All game builds are installed on instances at the root : for Windows instances C:\game, and for Linux instances/local/game.
- parameters String
- Optional list of parameters to pass to the server executable on launch.
- concurrentExecutions number
- Number of server processes using this configuration to run concurrently on an instance.
- launchPath string
- Location of the server executable in a game build. All game builds are installed on instances at the root : for Windows instances C:\game, and for Linux instances/local/game.
- parameters string
- Optional list of parameters to pass to the server executable on launch.
- concurrent_executions int
- Number of server processes using this configuration to run concurrently on an instance.
- launch_path str
- Location of the server executable in a game build. All game builds are installed on instances at the root : for Windows instances C:\game, and for Linux instances/local/game.
- parameters str
- Optional list of parameters to pass to the server executable on launch.
- concurrentExecutions Number
- Number of server processes using this configuration to run concurrently on an instance.
- launchPath String
- Location of the server executable in a game build. All game builds are installed on instances at the root : for Windows instances C:\game, and for Linux instances/local/game.
- parameters String
- Optional list of parameters to pass to the server executable on launch.
Import
Using pulumi import, import GameLift Fleets using the ID. For example:
$ pulumi import aws:gamelift/fleet:Fleet example <fleet-id>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the awsTerraform Provider.