AWS::GameLiftStreams::StreamGroup LocationConfiguration - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::GameLiftStreams::StreamGroup LocationConfiguration

Configuration settings that define a stream group's stream capacity for a location. When configuring a location for the first time, you must specify a numeric value for at least one of the two capacity types.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "AlwaysOnCapacity" : Integer,
  "LocationName" : String,
  "OnDemandCapacity" : Integer
}

YAML

  AlwaysOnCapacity: Integer
  LocationName: String
  OnDemandCapacity: Integer

Properties

AlwaysOnCapacity

This setting, if non-zero, indicates minimum streaming capacity which is allocated to you and is never released back to the service. You pay for this base level of capacity at all times, whether used or idle.

Required: No

Type: Integer

Minimum: 0

Update requires: No interruption

LocationName

A location's name. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9-]+$

Minimum: 1

Maximum: 20

Update requires: No interruption

OnDemandCapacity

This field is deprecated. Use MaximumCapacity instead. This parameter is ignored when MaximumCapacity is specified.

The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). Default is 0 when you create a stream group or add a location.

Required: No

Type: Integer

Minimum: 0

Update requires: No interruption