Interface LocationConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<LocationConfiguration.Builder,LocationConfiguration>, SdkBuilder<LocationConfiguration.Builder,LocationConfiguration>, SdkPojo
Enclosing class:
LocationConfiguration
@Mutable @NotThreadSafe public static interface LocationConfiguration.Builder extends SdkPojo, CopyableBuilder<LocationConfiguration.Builder,LocationConfiguration>

  • Method Details

    • locationName

      LocationConfiguration.Builder locationName(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • alwaysOnCapacity

      LocationConfiguration.Builder alwaysOnCapacity(Integer 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • onDemandCapacity

      @Deprecated LocationConfiguration.Builder onDemandCapacity(Integer onDemandCapacity)
      Deprecated.
      This input field is deprecated in favor of explicit MaximumCapacity values.

      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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetIdleCapacity

      LocationConfiguration.Builder targetIdleCapacity(Integer 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maximumCapacity

      LocationConfiguration.Builder maximumCapacity(Integer 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.