AWS::GameLift::Location - Amazon CloudFormation
SyntaxPropertiesReturn valuesSee also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::GameLift::Location

The AWS::GameLift::Location resource creates a custom location for use in an Anywhere fleet.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::GameLift::Location",
  "Properties" : {
      "LocationName" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::GameLift::Location
Properties:
  LocationName: String
  Tags: 
    - Tag

Properties

LocationName

A descriptive name for the custom location.

Required: Yes

Type: String

Pattern: ^custom-[A-Za-z0-9\-]+

Minimum: 8

Maximum: 64

Update requires: Replacement

Tags

A list of labels to assign to the new resource. Tags are developer-defined key-value pairs. Tagging Amazon resources are useful for resource management, access management, and cost allocation. For more information, see Tagging Amazon Resources in the Amazon General Rareference.

Required: No

Type: Array of Tag

Maximum: 200

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the custom location ID, such as arn:aws:gamelift:[region]::location/location-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

LocationArn

A unique identifier for the custom location. For example, arn:aws:gamelift:[region]::location/location-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

See also