Skip to content

/AWS1/CL_GMZADDSTRMGRPLOCSOUT

AddStreamGroupLocationsOutput

CONSTRUCTOR

IMPORTING

Required arguments:

iv_identifier TYPE /AWS1/GMZIDENTIFIER /AWS1/GMZIDENTIFIER

This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-1AB2C3De4.

it_locations TYPE /AWS1/CL_GMZLOCATIONSTATE=>TT_LOCATIONSTATES TT_LOCATIONSTATES

This value is set of locations, including their name, current status, and capacities.

A location can be in one of the following states:

  • ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.

  • ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.

  • ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.

  • REMOVING: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group.

Queryable Attributes

Identifier

This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-1AB2C3De4.

Accessible with the following methods

Method Description
GET_IDENTIFIER() Getter for IDENTIFIER, with configurable default
ASK_IDENTIFIER() Getter for IDENTIFIER w/ exceptions if field has no value
HAS_IDENTIFIER() Determine if IDENTIFIER has a value

Locations

This value is set of locations, including their name, current status, and capacities.

A location can be in one of the following states:

  • ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.

  • ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.

  • ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.

  • REMOVING: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group.

Accessible with the following methods

Method Description
GET_LOCATIONS() Getter for LOCATIONS, with configurable default
ASK_LOCATIONS() Getter for LOCATIONS w/ exceptions if field has no value
HAS_LOCATIONS() Determine if LOCATIONS has a value