Class CfnLocation
The AWS::GameLift::Location resource creates a custom location for use in an Anywhere fleet.
Inherited Members
Namespace: Amazon.CDK.AWS.GameLift
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnLocation : CfnResource, IInspectable, ILocationRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Syntax (vb)
Public Class CfnLocation Inherits CfnResource Implements IInspectable, ILocationRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-location.html
CloudformationResource: AWS::GameLift::Location
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.GameLift;
var cfnLocation = new CfnLocation(this, "MyCfnLocation", new CfnLocationProps {
LocationName = "locationName",
// the properties below are optional
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
| CfnLocation(Construct, string, ICfnLocationProps) | Create a new |
Properties
| AttrLocationArn | A unique identifier for the custom location. |
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| CfnProperties | The AWS::GameLift::Location resource creates a custom location for use in an Anywhere fleet. |
| CfnPropertyNames | The AWS::GameLift::Location resource creates a custom location for use in an Anywhere fleet. |
| LocationName | A descriptive name for the custom location. |
| LocationRef | A reference to a Location resource. |
| Tags | Tag Manager which manages the tags for this resource. |
| TagsRaw | A list of labels to assign to the new resource. |
Methods
| ArnForLocation(ILocationRef) | The AWS::GameLift::Location resource creates a custom location for use in an Anywhere fleet. |
| Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
| IsCfnLocation(object) | Checks whether the given object is a CfnLocation. |
| RenderProperties(IDictionary<string, object>) | The AWS::GameLift::Location resource creates a custom location for use in an Anywhere fleet. |
Constructors
CfnLocation(Construct, string, ICfnLocationProps)
Create a new AWS::GameLift::Location.
public CfnLocation(Construct scope, string id, ICfnLocationProps props)
Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnLocationProps
Resource properties.
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-location.html
CloudformationResource: AWS::GameLift::Location
ExampleMetadata: fixture=_generated
Properties
AttrLocationArn
A unique identifier for the custom location.
public virtual string AttrLocationArn { get; }
Property Value
Remarks
For example, arn:aws:gamelift:[region]::location/location-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 .
CloudformationAttribute: LocationArn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-location.html
CloudformationResource: AWS::GameLift::Location
ExampleMetadata: fixture=_generated
CfnProperties
The AWS::GameLift::Location resource creates a custom location for use in an Anywhere fleet.
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-location.html
CloudformationResource: AWS::GameLift::Location
ExampleMetadata: fixture=_generated
CfnPropertyNames
The AWS::GameLift::Location resource creates a custom location for use in an Anywhere fleet.
protected override IDictionary<string, string> CfnPropertyNames { get; }
Property Value
Overrides
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-location.html
CloudformationResource: AWS::GameLift::Location
ExampleMetadata: fixture=_generated
LocationName
A descriptive name for the custom location.
public virtual string LocationName { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-location.html
CloudformationResource: AWS::GameLift::Location
ExampleMetadata: fixture=_generated
LocationRef
A reference to a Location resource.
public virtual ILocationReference LocationRef { get; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-location.html
CloudformationResource: AWS::GameLift::Location
ExampleMetadata: fixture=_generated
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-location.html
CloudformationResource: AWS::GameLift::Location
ExampleMetadata: fixture=_generated
TagsRaw
A list of labels to assign to the new resource.
public virtual ICfnTag[]? TagsRaw { get; set; }
Property Value
ICfnTag[]
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-location.html
CloudformationResource: AWS::GameLift::Location
ExampleMetadata: fixture=_generated
Methods
ArnForLocation(ILocationRef)
The AWS::GameLift::Location resource creates a custom location for use in an Anywhere fleet.
public static string ArnForLocation(ILocationRef resource)
Parameters
- resource ILocationRef
Returns
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-location.html
CloudformationResource: AWS::GameLift::Location
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.GameLift;
var cfnLocation = new CfnLocation(this, "MyCfnLocation", new CfnLocationProps {
LocationName = "locationName",
// the properties below are optional
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-location.html
CloudformationResource: AWS::GameLift::Location
ExampleMetadata: fixture=_generated
IsCfnLocation(object)
Checks whether the given object is a CfnLocation.
public static bool IsCfnLocation(object x)
Parameters
- x object
Returns
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-location.html
CloudformationResource: AWS::GameLift::Location
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
The AWS::GameLift::Location resource creates a custom location for use in an Anywhere fleet.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-location.html
CloudformationResource: AWS::GameLift::Location
ExampleMetadata: fixture=_generated