Class: Aws::GameLiftStreams::Types::LocationState

Inherits:

Struct

• Object
• Struct
• Aws::GameLiftStreams::Types::LocationState

Defined in:

gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb

Overview

Represents a location and its corresponding stream capacity and status.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #allocated_capacity ⇒ Integer

  This value is the number of compute resources that a stream group has provisioned and is ready to stream.

• #always_on_capacity ⇒ Integer

  The streaming capacity that is allocated and ready to handle stream requests without delay.

• #idle_capacity ⇒ Integer

  This value is the amount of allocated capacity that is not currently streaming.

• #location_name ⇒ String

  A location's name.

• #on_demand_capacity ⇒ Integer

  The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated.

• #requested_capacity ⇒ Integer

  This value is the total number of compute resources that you request for a stream group.

• #status ⇒ String

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

Instance Attribute Details

#allocated_capacity ⇒ Integer

This value is the number of compute resources that a stream group has provisioned and is ready to stream. It includes resources that are currently streaming and resources that are idle and ready to respond to stream requests.

Returns:

• (Integer)

# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 2222

class LocationState < Struct.new(
  :location_name,
  :status,
  :always_on_capacity,
  :on_demand_capacity,
  :requested_capacity,
  :allocated_capacity,
  :idle_capacity)
  SENSITIVE = []
  include Aws::Structure
end

#always_on_capacity ⇒ Integer

The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session. Default is 1 when creating a stream group or adding a location.

Returns:

• (Integer)

# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 2222

class LocationState < Struct.new(
  :location_name,
  :status,
  :always_on_capacity,
  :on_demand_capacity,
  :requested_capacity,
  :allocated_capacity,
  :idle_capacity)
  SENSITIVE = []
  include Aws::Structure
end

#idle_capacity ⇒ Integer

This value is the amount of allocated capacity that is not currently streaming. It represents the stream group's availability to respond to new stream requests, but not including on-demand capacity.

Returns:

• (Integer)

# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 2222

class LocationState < Struct.new(
  :location_name,
  :status,
  :always_on_capacity,
  :on_demand_capacity,
  :requested_capacity,
  :allocated_capacity,
  :idle_capacity)
  SENSITIVE = []
  include Aws::Structure
end

#location_name ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 2222

class LocationState < Struct.new(
  :location_name,
  :status,
  :always_on_capacity,
  :on_demand_capacity,
  :requested_capacity,
  :allocated_capacity,
  :idle_capacity)
  SENSITIVE = []
  include Aws::Structure
end

#on_demand_capacity ⇒ Integer

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 2222

class LocationState < Struct.new(
  :location_name,
  :status,
  :always_on_capacity,
  :on_demand_capacity,
  :requested_capacity,
  :allocated_capacity,
  :idle_capacity)
  SENSITIVE = []
  include Aws::Structure
end

#requested_capacity ⇒ Integer

This value is the total number of compute resources that you request for a stream group. This includes resources that Amazon GameLift Streams has either already provisioned or is working to provision. You request capacity for each location in a stream group.

Returns:

• (Integer)

# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 2222

class LocationState < Struct.new(
  :location_name,
  :status,
  :always_on_capacity,
  :on_demand_capacity,
  :requested_capacity,
  :allocated_capacity,
  :idle_capacity)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

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. This will release all provisioned capacity for this location in this stream group.

Returns:

• (String)

# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 2222

class LocationState < Struct.new(
  :location_name,
  :status,
  :always_on_capacity,
  :on_demand_capacity,
  :requested_capacity,
  :allocated_capacity,
  :idle_capacity)
  SENSITIVE = []
  include Aws::Structure
end