/AWS1/CL_GMZLOCATIONCONF

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. To update the capacity for an existing stream group, call UpdateStreamGroup. To add a new location and specify its capacity, call AddStreamGroupLocations.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_locationname TYPE /AWS1/GMZLOCATIONNAME /AWS1/GMZLOCATIONNAME

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.

Optional arguments:

iv_alwaysoncapacity TYPE /AWS1/GMZALWAYSONCAPACITY /AWS1/GMZALWAYSONCAPACITY

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.

iv_ondemandcapacity TYPE /AWS1/GMZONDEMANDCAPACITY /AWS1/GMZONDEMANDCAPACITY

This field is deprecated. Use MaximumCapacity instead. This parameter cannot be used with MaximumCapacity or TargetIdleCapacity in the same location configuration.

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 creating a stream group or adding a location.

iv_targetidlecapacity TYPE /AWS1/GMZTARGETIDLECAPACITY /AWS1/GMZTARGETIDLECAPACITY

This indicates idle capacity which the service pre-allocates and holds for you in anticipation of future activity. This helps to insulate your users from capacity-allocation delays. You pay for capacity which is held in this intentional idle state.

iv_maximumcapacity TYPE /AWS1/GMZMAXIMUMCAPACITY /AWS1/GMZMAXIMUMCAPACITY

This indicates the maximum capacity that the service can allocate for you. Newly created streams may take a few minutes to start. Capacity is released back to the service when idle. You pay for capacity that is allocated to you until it is released.

---

Queryable Attributes

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.

Accessible with the following methods

Method	Description
GET_LOCATIONNAME()	Getter for LOCATIONNAME, with configurable default
ASK_LOCATIONNAME()	Getter for LOCATIONNAME w/ exceptions if field has no value
HAS_LOCATIONNAME()	Determine if LOCATIONNAME has a value

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.

Accessible with the following methods

Method	Description
GET_ALWAYSONCAPACITY()	Getter for ALWAYSONCAPACITY, with configurable default
ASK_ALWAYSONCAPACITY()	Getter for ALWAYSONCAPACITY w/ exceptions if field has no va
HAS_ALWAYSONCAPACITY()	Determine if ALWAYSONCAPACITY has a value

OnDemandCapacity

This field is deprecated. Use MaximumCapacity instead. This parameter cannot be used with MaximumCapacity or TargetIdleCapacity in the same location configuration.

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 creating a stream group or adding a location.

Accessible with the following methods

Method	Description
GET_ONDEMANDCAPACITY()	Getter for ONDEMANDCAPACITY, with configurable default
ASK_ONDEMANDCAPACITY()	Getter for ONDEMANDCAPACITY w/ exceptions if field has no va
HAS_ONDEMANDCAPACITY()	Determine if ONDEMANDCAPACITY has a value

TargetIdleCapacity

This indicates idle capacity which the service pre-allocates and holds for you in anticipation of future activity. This helps to insulate your users from capacity-allocation delays. You pay for capacity which is held in this intentional idle state.

Accessible with the following methods

Method	Description
GET_TARGETIDLECAPACITY()	Getter for TARGETIDLECAPACITY, with configurable default
ASK_TARGETIDLECAPACITY()	Getter for TARGETIDLECAPACITY w/ exceptions if field has no
HAS_TARGETIDLECAPACITY()	Determine if TARGETIDLECAPACITY has a value

MaximumCapacity

This indicates the maximum capacity that the service can allocate for you. Newly created streams may take a few minutes to start. Capacity is released back to the service when idle. You pay for capacity that is allocated to you until it is released.

Accessible with the following methods

Method	Description
GET_MAXIMUMCAPACITY()	Getter for MAXIMUMCAPACITY, with configurable default
ASK_MAXIMUMCAPACITY()	Getter for MAXIMUMCAPACITY w/ exceptions if field has no val
HAS_MAXIMUMCAPACITY()	Determine if MAXIMUMCAPACITY has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_LOCATIONCONFIGURATIONS

TYPES TT_LOCATIONCONFIGURATIONS TYPE STANDARD TABLE OF REF TO /AWS1/CL_GMZLOCATIONCONF WITH DEFAULT KEY
.