Package software.amazon.awscdk.services.gamelift

Class CfnLocation

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.gamelift.CfnLocation
All Implemented Interfaces:
IInspectable, ILocationRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:37.367Z") @Stability(Stable) public class CfnLocation extends CfnResource implements IInspectable, ILocationRef, ITaggable
The AWS::GameLift::Location resource creates a custom location for use in an Anywhere fleet.

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.*;
 CfnLocation cfnLocation = CfnLocation.Builder.create(this, "MyCfnLocation")
         .locationName("locationName")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnLocation

      protected CfnLocation(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnLocation

      protected CfnLocation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnLocation

      @Stability(Stable) public CfnLocation(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnLocationProps props)
      Create a new AWS::GameLift::Location.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForLocation

      @Stability(Stable) @NotNull public static String arnForLocation(@NotNull ILocationRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnLocation

      @Stability(Stable) @NotNull public static Boolean isCfnLocation(@NotNull Object x)
      Checks whether the given object is a CfnLocation.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrLocationArn

      @Stability(Stable) @NotNull public String getAttrLocationArn()
      A unique identifier for the custom location.

      For example, arn:aws:gamelift:[region]::location/location-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getLocationRef

      @Stability(Stable) @NotNull public LocationReference getLocationRef()
      A reference to a Location resource.
      Specified by:
      getLocationRef in interface ILocationRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getLocationName

      @Stability(Stable) @NotNull public String getLocationName()
      A descriptive name for the custom location.

    • setLocationName

      @Stability(Stable) public void setLocationName(@NotNull String value)
      A descriptive name for the custom location.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      A list of labels to assign to the new resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      A list of labels to assign to the new resource.