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

Inherits:
Struct
  • Object
show all
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:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allocated_capacity ⇒ Integer

This value is the stream capacity that Amazon GameLift Streams has provisioned in a stream group that can respond immediately to stream requests. It includes resources that are currently streaming and resources that are idle and ready to respond to stream requests. When target-idle capacity is configured, the idle resources include the capacity buffer maintained beyond ongoing sessions. You pay for this capacity whether it's in use or not. After making changes to capacity, it can take a few minutes for the allocated capacity count to reflect the change while compute resources are allocated or deallocated. Similarly, when allocated on-demand capacity is no longer needed, it can take a few minutes for Amazon GameLift Streams to spin down the allocated capacity.

Returns:

  • (Integer) 


2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
 
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 2610

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

#always_on_capacity ⇒ Integer

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.

Returns:

  • (Integer) 


2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
 
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 2610

class LocationState < Struct.new(
  :location_name,
  :status,
  :always_on_capacity,
  :on_demand_capacity,
  :target_idle_capacity,
  :maximum_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 ability to respond immediately to new stream requests with near-instant startup time.

Returns:

  • (Integer) 


2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
 
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 2610

class LocationState < Struct.new(
  :location_name,
  :status,
  :always_on_capacity,
  :on_demand_capacity,
  :target_idle_capacity,
  :maximum_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) 


2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
 
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 2610

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

#maximum_capacity ⇒ Integer

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.

Returns:

  • (Integer) 


2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
 
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 2610

class LocationState < Struct.new(
  :location_name,
  :status,
  :always_on_capacity,
  :on_demand_capacity,
  :target_idle_capacity,
  :maximum_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) 


2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
 
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 2610

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

#requested_capacity ⇒ Integer

This value is the always-on capacity that you most recently requested for a stream group. You request capacity separately for each location in a stream group. In response to an increase in requested capacity, Amazon GameLift Streams attempts to provision compute resources to make the stream group's allocated capacity meet requested capacity. When always-on capacity is decreased, it can take a few minutes to deprovision allocated capacity to match the requested capacity.

Returns:

  • (Integer) 


2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
 
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 2610

class LocationState < Struct.new(
  :location_name,
  :status,
  :always_on_capacity,
  :on_demand_capacity,
  :target_idle_capacity,
  :maximum_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) 


2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
 
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 2610

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

#target_idle_capacity ⇒ Integer

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.

Returns:

  • (Integer) 


2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
 
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 2610

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