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

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

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

aws-native.gamelift.getFleet

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

    The AWS::GameLift::Fleet resource creates an Amazon GameLift (GameLift) fleet to host game servers. A fleet is a set of EC2 or Anywhere instances, each of which can host multiple game sessions.

    Using getFleet

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getFleet(args: GetFleetArgs, opts?: InvokeOptions): Promise<GetFleetResult>
    function getFleetOutput(args: GetFleetOutputArgs, opts?: InvokeOptions): Output<GetFleetResult>
    def get_fleet(fleet_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetFleetResult
    def get_fleet_output(fleet_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetFleetResult]
    func LookupFleet(ctx *Context, args *LookupFleetArgs, opts ...InvokeOption) (*LookupFleetResult, error)
    func LookupFleetOutput(ctx *Context, args *LookupFleetOutputArgs, opts ...InvokeOption) LookupFleetResultOutput

    > Note: This function is named LookupFleet in the Go SDK.

    public static class GetFleet 
    {
        public static Task<GetFleetResult> InvokeAsync(GetFleetArgs args, InvokeOptions? opts = null)
        public static Output<GetFleetResult> Invoke(GetFleetInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetFleetResult> getFleet(GetFleetArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:gamelift:getFleet
      arguments:
        # arguments dictionary

    The following arguments are supported:

    FleetId string
    Unique fleet ID
    FleetId string
    Unique fleet ID
    fleetId String
    Unique fleet ID
    fleetId string
    Unique fleet ID
    fleet_id str
    Unique fleet ID
    fleetId String
    Unique fleet ID

    getFleet Result

    The following output properties are available:

    AnywhereConfiguration Pulumi.AwsNative.GameLift.Outputs.FleetAnywhereConfiguration
    Configuration for Anywhere fleet.
    Description string
    A human-readable description of a fleet.
    DesiredEc2Instances int
    [DEPRECATED] The number of EC2 instances that you want this fleet to host. When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.
    Ec2InboundPermissions List<Pulumi.AwsNative.GameLift.Outputs.FleetIpPermission>
    A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
    FleetId string
    Unique fleet ID
    Locations List<Pulumi.AwsNative.GameLift.Outputs.FleetLocationConfiguration>

    A set of remote locations to deploy additional instances to and manage as part of the fleet. This parameter can only be used when creating fleets in AWS Regions that support multiple locations. You can add any Amazon GameLift-supported AWS Region as a remote location, in the form of an AWS Region code, such as us-west-2 or Local Zone code. To create a fleet with instances in the home Region only, don't set this parameter.

    When using this parameter, Amazon GameLift requires you to include your home location in the request.

    MaxSize int
    [DEPRECATED] The maximum value that is allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.
    MetricGroups List<string>
    The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string.
    MinSize int
    [DEPRECATED] The minimum value allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.
    Name string
    A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
    NewGameSessionProtectionPolicy Pulumi.AwsNative.GameLift.FleetNewGameSessionProtectionPolicy
    A game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions.
    ResourceCreationLimitPolicy Pulumi.AwsNative.GameLift.Outputs.FleetResourceCreationLimitPolicy
    A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
    RuntimeConfiguration Pulumi.AwsNative.GameLift.Outputs.FleetRuntimeConfiguration

    Instructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime script. The runtime configuration defines the server executables or launch script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails with an invalid request exception.

    This parameter is required unless the parameters ServerLaunchPath and ServerLaunchParameters are defined. Runtime configuration has replaced these parameters, but fleets that use them will continue to work.

    ScalingPolicies List<Pulumi.AwsNative.GameLift.Outputs.FleetScalingPolicy>
    A list of rules that control how a fleet is scaled.
    AnywhereConfiguration FleetAnywhereConfiguration
    Configuration for Anywhere fleet.
    Description string
    A human-readable description of a fleet.
    DesiredEc2Instances int
    [DEPRECATED] The number of EC2 instances that you want this fleet to host. When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.
    Ec2InboundPermissions []FleetIpPermission
    A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
    FleetId string
    Unique fleet ID
    Locations []FleetLocationConfiguration

    A set of remote locations to deploy additional instances to and manage as part of the fleet. This parameter can only be used when creating fleets in AWS Regions that support multiple locations. You can add any Amazon GameLift-supported AWS Region as a remote location, in the form of an AWS Region code, such as us-west-2 or Local Zone code. To create a fleet with instances in the home Region only, don't set this parameter.

    When using this parameter, Amazon GameLift requires you to include your home location in the request.

    MaxSize int
    [DEPRECATED] The maximum value that is allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.
    MetricGroups []string
    The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string.
    MinSize int
    [DEPRECATED] The minimum value allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.
    Name string
    A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
    NewGameSessionProtectionPolicy FleetNewGameSessionProtectionPolicy
    A game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions.
    ResourceCreationLimitPolicy FleetResourceCreationLimitPolicy
    A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
    RuntimeConfiguration FleetRuntimeConfiguration

    Instructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime script. The runtime configuration defines the server executables or launch script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails with an invalid request exception.

    This parameter is required unless the parameters ServerLaunchPath and ServerLaunchParameters are defined. Runtime configuration has replaced these parameters, but fleets that use them will continue to work.

    ScalingPolicies []FleetScalingPolicy
    A list of rules that control how a fleet is scaled.
    anywhereConfiguration FleetAnywhereConfiguration
    Configuration for Anywhere fleet.
    description String
    A human-readable description of a fleet.
    desiredEc2Instances Integer
    [DEPRECATED] The number of EC2 instances that you want this fleet to host. When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.
    ec2InboundPermissions List<FleetIpPermission>
    A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
    fleetId String
    Unique fleet ID
    locations List<FleetLocationConfiguration>

    A set of remote locations to deploy additional instances to and manage as part of the fleet. This parameter can only be used when creating fleets in AWS Regions that support multiple locations. You can add any Amazon GameLift-supported AWS Region as a remote location, in the form of an AWS Region code, such as us-west-2 or Local Zone code. To create a fleet with instances in the home Region only, don't set this parameter.

    When using this parameter, Amazon GameLift requires you to include your home location in the request.

    maxSize Integer
    [DEPRECATED] The maximum value that is allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.
    metricGroups List<String>
    The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string.
    minSize Integer
    [DEPRECATED] The minimum value allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.
    name String
    A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
    newGameSessionProtectionPolicy FleetNewGameSessionProtectionPolicy
    A game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions.
    resourceCreationLimitPolicy FleetResourceCreationLimitPolicy
    A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
    runtimeConfiguration FleetRuntimeConfiguration

    Instructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime script. The runtime configuration defines the server executables or launch script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails with an invalid request exception.

    This parameter is required unless the parameters ServerLaunchPath and ServerLaunchParameters are defined. Runtime configuration has replaced these parameters, but fleets that use them will continue to work.

    scalingPolicies List<FleetScalingPolicy>
    A list of rules that control how a fleet is scaled.
    anywhereConfiguration FleetAnywhereConfiguration
    Configuration for Anywhere fleet.
    description string
    A human-readable description of a fleet.
    desiredEc2Instances number
    [DEPRECATED] The number of EC2 instances that you want this fleet to host. When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.
    ec2InboundPermissions FleetIpPermission[]
    A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
    fleetId string
    Unique fleet ID
    locations FleetLocationConfiguration[]

    A set of remote locations to deploy additional instances to and manage as part of the fleet. This parameter can only be used when creating fleets in AWS Regions that support multiple locations. You can add any Amazon GameLift-supported AWS Region as a remote location, in the form of an AWS Region code, such as us-west-2 or Local Zone code. To create a fleet with instances in the home Region only, don't set this parameter.

    When using this parameter, Amazon GameLift requires you to include your home location in the request.

    maxSize number
    [DEPRECATED] The maximum value that is allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.
    metricGroups string[]
    The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string.
    minSize number
    [DEPRECATED] The minimum value allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.
    name string
    A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
    newGameSessionProtectionPolicy FleetNewGameSessionProtectionPolicy
    A game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions.
    resourceCreationLimitPolicy FleetResourceCreationLimitPolicy
    A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
    runtimeConfiguration FleetRuntimeConfiguration

    Instructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime script. The runtime configuration defines the server executables or launch script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails with an invalid request exception.

    This parameter is required unless the parameters ServerLaunchPath and ServerLaunchParameters are defined. Runtime configuration has replaced these parameters, but fleets that use them will continue to work.

    scalingPolicies FleetScalingPolicy[]
    A list of rules that control how a fleet is scaled.
    anywhere_configuration FleetAnywhereConfiguration
    Configuration for Anywhere fleet.
    description str
    A human-readable description of a fleet.
    desired_ec2_instances int
    [DEPRECATED] The number of EC2 instances that you want this fleet to host. When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.
    ec2_inbound_permissions Sequence[FleetIpPermission]
    A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
    fleet_id str
    Unique fleet ID
    locations Sequence[FleetLocationConfiguration]

    A set of remote locations to deploy additional instances to and manage as part of the fleet. This parameter can only be used when creating fleets in AWS Regions that support multiple locations. You can add any Amazon GameLift-supported AWS Region as a remote location, in the form of an AWS Region code, such as us-west-2 or Local Zone code. To create a fleet with instances in the home Region only, don't set this parameter.

    When using this parameter, Amazon GameLift requires you to include your home location in the request.

    max_size int
    [DEPRECATED] The maximum value that is allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.
    metric_groups Sequence[str]
    The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string.
    min_size int
    [DEPRECATED] The minimum value allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.
    name str
    A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
    new_game_session_protection_policy FleetNewGameSessionProtectionPolicy
    A game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions.
    resource_creation_limit_policy FleetResourceCreationLimitPolicy
    A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
    runtime_configuration FleetRuntimeConfiguration

    Instructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime script. The runtime configuration defines the server executables or launch script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails with an invalid request exception.

    This parameter is required unless the parameters ServerLaunchPath and ServerLaunchParameters are defined. Runtime configuration has replaced these parameters, but fleets that use them will continue to work.

    scaling_policies Sequence[FleetScalingPolicy]
    A list of rules that control how a fleet is scaled.
    anywhereConfiguration Property Map
    Configuration for Anywhere fleet.
    description String
    A human-readable description of a fleet.
    desiredEc2Instances Number
    [DEPRECATED] The number of EC2 instances that you want this fleet to host. When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.
    ec2InboundPermissions List<Property Map>
    A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
    fleetId String
    Unique fleet ID
    locations List<Property Map>

    A set of remote locations to deploy additional instances to and manage as part of the fleet. This parameter can only be used when creating fleets in AWS Regions that support multiple locations. You can add any Amazon GameLift-supported AWS Region as a remote location, in the form of an AWS Region code, such as us-west-2 or Local Zone code. To create a fleet with instances in the home Region only, don't set this parameter.

    When using this parameter, Amazon GameLift requires you to include your home location in the request.

    maxSize Number
    [DEPRECATED] The maximum value that is allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.
    metricGroups List<String>
    The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string.
    minSize Number
    [DEPRECATED] The minimum value allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.
    name String
    A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
    newGameSessionProtectionPolicy "FullProtection" | "NoProtection"
    A game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions.
    resourceCreationLimitPolicy Property Map
    A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
    runtimeConfiguration Property Map

    Instructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime script. The runtime configuration defines the server executables or launch script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails with an invalid request exception.

    This parameter is required unless the parameters ServerLaunchPath and ServerLaunchParameters are defined. Runtime configuration has replaced these parameters, but fleets that use them will continue to work.

    scalingPolicies List<Property Map>
    A list of rules that control how a fleet is scaled.

    Supporting Types

    FleetAnywhereConfiguration

    Cost string
    Cost of compute can be specified on Anywhere Fleets to prioritize placement across Queue destinations based on Cost.
    Cost string
    Cost of compute can be specified on Anywhere Fleets to prioritize placement across Queue destinations based on Cost.
    cost String
    Cost of compute can be specified on Anywhere Fleets to prioritize placement across Queue destinations based on Cost.
    cost string
    Cost of compute can be specified on Anywhere Fleets to prioritize placement across Queue destinations based on Cost.
    cost str
    Cost of compute can be specified on Anywhere Fleets to prioritize placement across Queue destinations based on Cost.
    cost String
    Cost of compute can be specified on Anywhere Fleets to prioritize placement across Queue destinations based on Cost.

    FleetIpPermission

    FromPort int
    A starting value for a range of allowed port numbers.
    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 Pulumi.AwsNative.GameLift.FleetIpPermissionProtocol
    The network communication protocol used by the fleet.
    ToPort int
    An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
    FromPort int
    A starting value for a range of allowed port numbers.
    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 FleetIpPermissionProtocol
    The network communication protocol used by the fleet.
    ToPort int
    An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
    fromPort Integer
    A starting value for a range of allowed port numbers.
    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 FleetIpPermissionProtocol
    The network communication protocol used by the fleet.
    toPort Integer
    An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
    fromPort number
    A starting value for a range of allowed port numbers.
    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 FleetIpPermissionProtocol
    The network communication protocol used by the fleet.
    toPort number
    An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
    from_port int
    A starting value for a range of allowed port numbers.
    ip_range str
    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 FleetIpPermissionProtocol
    The network communication protocol used by the fleet.
    to_port int
    An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
    fromPort Number
    A starting value for a range of allowed port numbers.
    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 "TCP" | "UDP"
    The network communication protocol used by the fleet.
    toPort Number
    An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.

    FleetIpPermissionProtocol

    FleetLocationCapacity

    DesiredEc2Instances int
    The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.
    MaxSize int
    The maximum value that is allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.
    MinSize int
    The minimum value allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.
    DesiredEc2Instances int
    The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.
    MaxSize int
    The maximum value that is allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.
    MinSize int
    The minimum value allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.
    desiredEc2Instances Integer
    The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.
    maxSize Integer
    The maximum value that is allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.
    minSize Integer
    The minimum value allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.
    desiredEc2Instances number
    The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.
    maxSize number
    The maximum value that is allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.
    minSize number
    The minimum value allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.
    desired_ec2_instances int
    The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.
    max_size int
    The maximum value that is allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.
    min_size int
    The minimum value allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.
    desiredEc2Instances Number
    The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.
    maxSize Number
    The maximum value that is allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.
    minSize Number
    The minimum value allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.

    FleetLocationConfiguration

    Location string
    An AWS Region code, such as us-west-2 .
    LocationCapacity Pulumi.AwsNative.GameLift.Inputs.FleetLocationCapacity

    Current resource capacity settings for managed EC2 fleets and container fleets. For multi-location fleets, location values might refer to a fleet's remote location or its home Region.

    Returned by: DescribeFleetCapacity , DescribeFleetLocationCapacity , UpdateFleetCapacity

    Location string
    An AWS Region code, such as us-west-2 .
    LocationCapacity FleetLocationCapacity

    Current resource capacity settings for managed EC2 fleets and container fleets. For multi-location fleets, location values might refer to a fleet's remote location or its home Region.

    Returned by: DescribeFleetCapacity , DescribeFleetLocationCapacity , UpdateFleetCapacity

    location String
    An AWS Region code, such as us-west-2 .
    locationCapacity FleetLocationCapacity

    Current resource capacity settings for managed EC2 fleets and container fleets. For multi-location fleets, location values might refer to a fleet's remote location or its home Region.

    Returned by: DescribeFleetCapacity , DescribeFleetLocationCapacity , UpdateFleetCapacity

    location string
    An AWS Region code, such as us-west-2 .
    locationCapacity FleetLocationCapacity

    Current resource capacity settings for managed EC2 fleets and container fleets. For multi-location fleets, location values might refer to a fleet's remote location or its home Region.

    Returned by: DescribeFleetCapacity , DescribeFleetLocationCapacity , UpdateFleetCapacity

    location str
    An AWS Region code, such as us-west-2 .
    location_capacity FleetLocationCapacity

    Current resource capacity settings for managed EC2 fleets and container fleets. For multi-location fleets, location values might refer to a fleet's remote location or its home Region.

    Returned by: DescribeFleetCapacity , DescribeFleetLocationCapacity , UpdateFleetCapacity

    location String
    An AWS Region code, such as us-west-2 .
    locationCapacity Property Map

    Current resource capacity settings for managed EC2 fleets and container fleets. For multi-location fleets, location values might refer to a fleet's remote location or its home Region.

    Returned by: DescribeFleetCapacity , DescribeFleetLocationCapacity , UpdateFleetCapacity

    FleetNewGameSessionProtectionPolicy

    FleetResourceCreationLimitPolicy

    NewGameSessionsPerCreator int
    The maximum number of game sessions that an individual can create during the policy period.
    PolicyPeriodInMinutes int
    The time span used in evaluating the resource creation limit policy.
    NewGameSessionsPerCreator int
    The maximum number of game sessions that an individual can create during the policy period.
    PolicyPeriodInMinutes int
    The time span used in evaluating the resource creation limit policy.
    newGameSessionsPerCreator Integer
    The maximum number of game sessions that an individual can create during the policy period.
    policyPeriodInMinutes Integer
    The time span used in evaluating the resource creation limit policy.
    newGameSessionsPerCreator number
    The maximum number of game sessions that an individual can create during the policy period.
    policyPeriodInMinutes number
    The time span used in evaluating the resource creation limit policy.
    new_game_sessions_per_creator int
    The maximum number of game sessions that an individual can create during the policy period.
    policy_period_in_minutes int
    The time span used in evaluating the resource creation limit policy.
    newGameSessionsPerCreator Number
    The maximum number of game sessions that an individual can create during the policy period.
    policyPeriodInMinutes Number
    The time span used in evaluating the resource creation limit policy.

    FleetRuntimeConfiguration

    GameSessionActivationTimeoutSeconds int
    The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.
    MaxConcurrentGameSessionActivations int
    The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
    ServerProcesses List<Pulumi.AwsNative.GameLift.Inputs.FleetServerProcess>
    A collection of server process configurations that describe which server processes to run on each instance in a fleet.
    GameSessionActivationTimeoutSeconds int
    The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.
    MaxConcurrentGameSessionActivations int
    The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
    ServerProcesses []FleetServerProcess
    A collection of server process configurations that describe which server processes to run on each instance in a fleet.
    gameSessionActivationTimeoutSeconds Integer
    The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.
    maxConcurrentGameSessionActivations Integer
    The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
    serverProcesses List<FleetServerProcess>
    A collection of server process configurations that describe which server processes to run on each instance in a fleet.
    gameSessionActivationTimeoutSeconds number
    The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.
    maxConcurrentGameSessionActivations number
    The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
    serverProcesses FleetServerProcess[]
    A collection of server process configurations that describe which server processes to run on each instance in a fleet.
    game_session_activation_timeout_seconds int
    The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.
    max_concurrent_game_session_activations int
    The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
    server_processes Sequence[FleetServerProcess]
    A collection of server process configurations that describe which server processes to run on each instance in a fleet.
    gameSessionActivationTimeoutSeconds Number
    The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.
    maxConcurrentGameSessionActivations Number
    The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
    serverProcesses List<Property Map>
    A collection of server process configurations that describe which server processes to run on each instance in a fleet.

    FleetScalingPolicy

    MetricName Pulumi.AwsNative.GameLift.FleetScalingPolicyMetricName
    Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
    Name string
    A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
    ComparisonOperator Pulumi.AwsNative.GameLift.FleetScalingPolicyComparisonOperator
    Comparison operator to use when measuring a metric against the threshold value.
    EvaluationPeriods int
    Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
    Location string
    The fleet location.
    PolicyType Pulumi.AwsNative.GameLift.FleetScalingPolicyPolicyType
    The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.
    ScalingAdjustment int
    Amount of adjustment to make, based on the scaling adjustment type.
    ScalingAdjustmentType Pulumi.AwsNative.GameLift.FleetScalingPolicyScalingAdjustmentType
    The type of adjustment to make to a fleet's instance count.
    Status Pulumi.AwsNative.GameLift.FleetScalingPolicyStatus
    Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change.
    TargetConfiguration Pulumi.AwsNative.GameLift.Inputs.FleetTargetConfiguration
    An object that contains settings for a target-based scaling policy.
    Threshold double
    Metric value used to trigger a scaling event.
    UpdateStatus Pulumi.AwsNative.GameLift.FleetScalingPolicyUpdateStatus
    The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.
    MetricName FleetScalingPolicyMetricName
    Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
    Name string
    A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
    ComparisonOperator FleetScalingPolicyComparisonOperator
    Comparison operator to use when measuring a metric against the threshold value.
    EvaluationPeriods int
    Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
    Location string
    The fleet location.
    PolicyType FleetScalingPolicyPolicyType
    The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.
    ScalingAdjustment int
    Amount of adjustment to make, based on the scaling adjustment type.
    ScalingAdjustmentType FleetScalingPolicyScalingAdjustmentType
    The type of adjustment to make to a fleet's instance count.
    Status FleetScalingPolicyStatus
    Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change.
    TargetConfiguration FleetTargetConfiguration
    An object that contains settings for a target-based scaling policy.
    Threshold float64
    Metric value used to trigger a scaling event.
    UpdateStatus FleetScalingPolicyUpdateStatus
    The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.
    metricName FleetScalingPolicyMetricName
    Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
    name String
    A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
    comparisonOperator FleetScalingPolicyComparisonOperator
    Comparison operator to use when measuring a metric against the threshold value.
    evaluationPeriods Integer
    Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
    location String
    The fleet location.
    policyType FleetScalingPolicyPolicyType
    The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.
    scalingAdjustment Integer
    Amount of adjustment to make, based on the scaling adjustment type.
    scalingAdjustmentType FleetScalingPolicyScalingAdjustmentType
    The type of adjustment to make to a fleet's instance count.
    status FleetScalingPolicyStatus
    Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change.
    targetConfiguration FleetTargetConfiguration
    An object that contains settings for a target-based scaling policy.
    threshold Double
    Metric value used to trigger a scaling event.
    updateStatus FleetScalingPolicyUpdateStatus
    The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.
    metricName FleetScalingPolicyMetricName
    Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
    name string
    A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
    comparisonOperator FleetScalingPolicyComparisonOperator
    Comparison operator to use when measuring a metric against the threshold value.
    evaluationPeriods number
    Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
    location string
    The fleet location.
    policyType FleetScalingPolicyPolicyType
    The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.
    scalingAdjustment number
    Amount of adjustment to make, based on the scaling adjustment type.
    scalingAdjustmentType FleetScalingPolicyScalingAdjustmentType
    The type of adjustment to make to a fleet's instance count.
    status FleetScalingPolicyStatus
    Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change.
    targetConfiguration FleetTargetConfiguration
    An object that contains settings for a target-based scaling policy.
    threshold number
    Metric value used to trigger a scaling event.
    updateStatus FleetScalingPolicyUpdateStatus
    The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.
    metric_name FleetScalingPolicyMetricName
    Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
    name str
    A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
    comparison_operator FleetScalingPolicyComparisonOperator
    Comparison operator to use when measuring a metric against the threshold value.
    evaluation_periods int
    Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
    location str
    The fleet location.
    policy_type FleetScalingPolicyPolicyType
    The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.
    scaling_adjustment int
    Amount of adjustment to make, based on the scaling adjustment type.
    scaling_adjustment_type FleetScalingPolicyScalingAdjustmentType
    The type of adjustment to make to a fleet's instance count.
    status FleetScalingPolicyStatus
    Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change.
    target_configuration FleetTargetConfiguration
    An object that contains settings for a target-based scaling policy.
    threshold float
    Metric value used to trigger a scaling event.
    update_status FleetScalingPolicyUpdateStatus
    The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.
    metricName "ActivatingGameSessions" | "ActiveGameSessions" | "ActiveInstances" | "AvailableGameSessions" | "AvailablePlayerSessions" | "CurrentPlayerSessions" | "IdleInstances" | "PercentAvailableGameSessions" | "PercentIdleInstances" | "QueueDepth" | "WaitTime" | "ConcurrentActivatableGameSessions"
    Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
    name String
    A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
    comparisonOperator "GreaterThanOrEqualToThreshold" | "GreaterThanThreshold" | "LessThanThreshold" | "LessThanOrEqualToThreshold"
    Comparison operator to use when measuring a metric against the threshold value.
    evaluationPeriods Number
    Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
    location String
    The fleet location.
    policyType "RuleBased" | "TargetBased"
    The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.
    scalingAdjustment Number
    Amount of adjustment to make, based on the scaling adjustment type.
    scalingAdjustmentType "ChangeInCapacity" | "ExactCapacity" | "PercentChangeInCapacity"
    The type of adjustment to make to a fleet's instance count.
    status "ACTIVE" | "UPDATE_REQUESTED" | "UPDATING" | "DELETE_REQUESTED" | "DELETING" | "DELETED" | "ERROR"
    Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change.
    targetConfiguration Property Map
    An object that contains settings for a target-based scaling policy.
    threshold Number
    Metric value used to trigger a scaling event.
    updateStatus "PENDING_UPDATE"
    The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.

    FleetScalingPolicyComparisonOperator

    FleetScalingPolicyMetricName

    FleetScalingPolicyPolicyType

    FleetScalingPolicyScalingAdjustmentType

    FleetScalingPolicyStatus

    FleetScalingPolicyUpdateStatus

    FleetServerProcess

    ConcurrentExecutions int
    The number of server processes that use this configuration to run concurrently on an instance.
    LaunchPath string

    The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:

    Windows (for custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe"

    Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "/local/game/MyRealtimeScript.js"

    Parameters string
    An optional list of parameters to pass to the server executable or Realtime script on launch.
    ConcurrentExecutions int
    The number of server processes that use this configuration to run concurrently on an instance.
    LaunchPath string

    The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:

    Windows (for custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe"

    Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "/local/game/MyRealtimeScript.js"

    Parameters string
    An optional list of parameters to pass to the server executable or Realtime script on launch.
    concurrentExecutions Integer
    The number of server processes that use this configuration to run concurrently on an instance.
    launchPath String

    The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:

    Windows (for custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe"

    Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "/local/game/MyRealtimeScript.js"

    parameters String
    An optional list of parameters to pass to the server executable or Realtime script on launch.
    concurrentExecutions number
    The number of server processes that use this configuration to run concurrently on an instance.
    launchPath string

    The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:

    Windows (for custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe"

    Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "/local/game/MyRealtimeScript.js"

    parameters string
    An optional list of parameters to pass to the server executable or Realtime script on launch.
    concurrent_executions int
    The number of server processes that use this configuration to run concurrently on an instance.
    launch_path str

    The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:

    Windows (for custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe"

    Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "/local/game/MyRealtimeScript.js"

    parameters str
    An optional list of parameters to pass to the server executable or Realtime script on launch.
    concurrentExecutions Number
    The number of server processes that use this configuration to run concurrently on an instance.
    launchPath String

    The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:

    Windows (for custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe"

    Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "/local/game/MyRealtimeScript.js"

    parameters String
    An optional list of parameters to pass to the server executable or Realtime script on launch.

    FleetTargetConfiguration

    TargetValue double
    Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).
    TargetValue float64
    Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).
    targetValue Double
    Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).
    targetValue number
    Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).
    target_value float
    Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).
    targetValue Number
    Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).

    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.108.4 published on Tuesday, Jun 18, 2024 by Pulumi