Class: Aws::GameLiftStreams::Types::LocationConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::GameLiftStreams::Types::LocationConfiguration

Defined in:

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

Overview

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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.

• #location_name ⇒ String

  A location's name.

• #maximum_capacity ⇒ Integer

  This indicates the maximum capacity that the service can allocate for you.

• #on_demand_capacity ⇒ Integer

  This field is deprecated.

• #target_idle_capacity ⇒ Integer

  This indicates idle capacity which the service pre-allocates and holds for you in anticipation of future activity.

• #vpc_transit_configuration ⇒ Types::VpcTransitConfiguration

  Configuration for connecting the stream group to resources in your Amazon VPC using AWS Transit Gateway.

Instance Attribute Details

#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)

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

class LocationConfiguration < Struct.new(
  :location_name,
  :always_on_capacity,
  :on_demand_capacity,
  :target_idle_capacity,
  :maximum_capacity,
  :vpc_transit_configuration)
  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 2514

class LocationConfiguration < Struct.new(
  :location_name,
  :always_on_capacity,
  :on_demand_capacity,
  :target_idle_capacity,
  :maximum_capacity,
  :vpc_transit_configuration)
  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)

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

class LocationConfiguration < Struct.new(
  :location_name,
  :always_on_capacity,
  :on_demand_capacity,
  :target_idle_capacity,
  :maximum_capacity,
  :vpc_transit_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#on_demand_capacity ⇒ Integer

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.

Returns:

• (Integer)

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

class LocationConfiguration < Struct.new(
  :location_name,
  :always_on_capacity,
  :on_demand_capacity,
  :target_idle_capacity,
  :maximum_capacity,
  :vpc_transit_configuration)
  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)

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

class LocationConfiguration < Struct.new(
  :location_name,
  :always_on_capacity,
  :on_demand_capacity,
  :target_idle_capacity,
  :maximum_capacity,
  :vpc_transit_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_transit_configuration ⇒ Types::VpcTransitConfiguration

Configuration for connecting the stream group to resources in your Amazon VPC using AWS Transit Gateway. This setting is optional. If specified, Amazon GameLift Streams creates a Transit Gateway to enable private network connectivity between the service VPC and your VPC. The VPC ID cannot be changed after the stream group is created, but you can update the CIDR blocks by calling UpdateStreamGroup.

Returns:

• (Types::VpcTransitConfiguration)

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

class LocationConfiguration < Struct.new(
  :location_name,
  :always_on_capacity,
  :on_demand_capacity,
  :target_idle_capacity,
  :maximum_capacity,
  :vpc_transit_configuration)
  SENSITIVE = []
  include Aws::Structure
end