Package software.amazon.awscdk.services.gamelift.alpha

Interface Location

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
Location.Jsii$Proxy
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-09-11T18:01:25.560Z") @Stability(Experimental) public interface Location extends software.amazon.jsii.JsiiSerializable
(experimental) A remote location where a multi-location fleet can deploy EC2 instances for game hosting.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.gamelift.alpha.*;
 Location location = Location.builder()
         .region("region")
         // the properties below are optional
         .capacity(LocationCapacity.builder()
                 .desiredCapacity(123)
                 .maxSize(123)
                 .minSize(123)
                 .build())
         .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    Location.Builder
    A builder for Location
    static final class 
    Location.Jsii$Proxy
    An implementation for Location

  • Method Summary

    Modifier and Type
    Method
    Description
    static Location.Builder
    builder()
     
    default LocationCapacity
    getCapacity()
    (experimental) Current resource capacity settings in a specified fleet or location.
    String
    getRegion()
    (experimental) An AWS Region code.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getRegion

      @Stability(Experimental) @NotNull String getRegion()
      (experimental) An AWS Region code.

    • getCapacity

      @Stability(Experimental) @Nullable default LocationCapacity getCapacity()
      (experimental) Current resource capacity settings in a specified fleet or location.

      The location value might refer to a fleet's remote location or its home Region.

      Default: no capacity settings on the specified location

    • builder

      @Stability(Experimental) static Location.Builder builder()
      Returns:
      a Location.Builder of Location