Class CfnAlias

The AWS::GameLift::Alias resource creates an alias for an Amazon GameLift (GameLift) fleet destination.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnAlias
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.GameLift
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnAlias : CfnResource, IInspectable, IAliasRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Syntax (vb)
Public Class CfnAlias Inherits CfnResource Implements IInspectable, IAliasRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Remarks

There are two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias displays a message instead of routing players to an active fleet. For example, a terminal alias might display a URL link that directs players to an upgrade site. You can use aliases to define destinations in a game session queue or when requesting new game sessions.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html

CloudformationResource: AWS::GameLift::Alias

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 cfnAlias = new CfnAlias(this, "MyCfnAlias", new CfnAliasProps {
                 Name = "name",
                 RoutingStrategy = new RoutingStrategyProperty {
                     Type = "type",

                     // the properties below are optional
                     FleetId = "fleetId",
                     Message = "message"
                 },

                 // the properties below are optional
                 Description = "description",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnAlias(Construct, string, ICfnAliasProps)

The AWS::GameLift::Alias resource creates an alias for an Amazon GameLift (GameLift) fleet destination.

Properties

AliasRef

A reference to a Alias resource.
AttrAliasArn

The Amazon Resource Name ( ARN ) that is assigned to a Amazon GameLift Servers alias resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . In a GameLift alias ARN, the resource ID matches the alias ID value.
AttrAliasId

A unique identifier for the alias. For example, arn:aws:gamelift:us-west-1::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CdkTagManager

Tag Manager which manages the tags for this resource.
CfnProperties

The AWS::GameLift::Alias resource creates an alias for an Amazon GameLift (GameLift) fleet destination.
Description

A human-readable description of the alias.
Name

A descriptive label that is associated with an alias.
RoutingStrategy

The routing configuration, including routing type and fleet target, for the alias.
Tags

An array of key-value pairs to apply to this resource.

Methods

FromAliasArn(Construct, string, string)

Creates a new IAliasRef from an ARN.
FromAliasId(Construct, string, string)

Creates a new IAliasRef from a aliasId.
Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)

The AWS::GameLift::Alias resource creates an alias for an Amazon GameLift (GameLift) fleet destination.

Constructors

CfnAlias(Construct, string, ICfnAliasProps)

The AWS::GameLift::Alias resource creates an alias for an Amazon GameLift (GameLift) fleet destination.

public CfnAlias(Construct scope, string id, ICfnAliasProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnAliasProps

Resource properties.

Remarks

There are two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias displays a message instead of routing players to an active fleet. For example, a terminal alias might display a URL link that directs players to an upgrade site. You can use aliases to define destinations in a game session queue or when requesting new game sessions.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html

CloudformationResource: AWS::GameLift::Alias

ExampleMetadata: fixture=_generated

Properties

AliasRef

A reference to a Alias resource.

public virtual IAliasReference AliasRef { get; }
Property Value

IAliasReference

Remarks

There are two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias displays a message instead of routing players to an active fleet. For example, a terminal alias might display a URL link that directs players to an upgrade site. You can use aliases to define destinations in a game session queue or when requesting new game sessions.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html

CloudformationResource: AWS::GameLift::Alias

ExampleMetadata: fixture=_generated

AttrAliasArn

The Amazon Resource Name ( ARN ) that is assigned to a Amazon GameLift Servers alias resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . In a GameLift alias ARN, the resource ID matches the alias ID value.

public virtual string AttrAliasArn { get; }
Property Value

string

Remarks

CloudformationAttribute: AliasArn

AttrAliasId

A unique identifier for the alias. For example, arn:aws:gamelift:us-west-1::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

public virtual string AttrAliasId { get; }
Property Value

string

Remarks

Alias IDs are unique within a Region.

CloudformationAttribute: AliasId

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

There are two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias displays a message instead of routing players to an active fleet. For example, a terminal alias might display a URL link that directs players to an upgrade site. You can use aliases to define destinations in a game session queue or when requesting new game sessions.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html

CloudformationResource: AWS::GameLift::Alias

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

Remarks

There are two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias displays a message instead of routing players to an active fleet. For example, a terminal alias might display a URL link that directs players to an upgrade site. You can use aliases to define destinations in a game session queue or when requesting new game sessions.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html

CloudformationResource: AWS::GameLift::Alias

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::GameLift::Alias resource creates an alias for an Amazon GameLift (GameLift) fleet destination.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks

There are two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias displays a message instead of routing players to an active fleet. For example, a terminal alias might display a URL link that directs players to an upgrade site. You can use aliases to define destinations in a game session queue or when requesting new game sessions.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html

CloudformationResource: AWS::GameLift::Alias

ExampleMetadata: fixture=_generated

Description

A human-readable description of the alias.

public virtual string? Description { get; set; }
Property Value

string

Remarks

There are two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias displays a message instead of routing players to an active fleet. For example, a terminal alias might display a URL link that directs players to an upgrade site. You can use aliases to define destinations in a game session queue or when requesting new game sessions.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html

CloudformationResource: AWS::GameLift::Alias

ExampleMetadata: fixture=_generated

Name

A descriptive label that is associated with an alias.

public virtual string Name { get; set; }
Property Value

string

Remarks

There are two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias displays a message instead of routing players to an active fleet. For example, a terminal alias might display a URL link that directs players to an upgrade site. You can use aliases to define destinations in a game session queue or when requesting new game sessions.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html

CloudformationResource: AWS::GameLift::Alias

ExampleMetadata: fixture=_generated

RoutingStrategy

The routing configuration, including routing type and fleet target, for the alias.

public virtual object RoutingStrategy { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnAlias.IRoutingStrategyProperty

Tags

An array of key-value pairs to apply to this resource.

public virtual ICfnTag[]? Tags { get; set; }
Property Value

ICfnTag[]

Remarks

There are two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias displays a message instead of routing players to an active fleet. For example, a terminal alias might display a URL link that directs players to an upgrade site. You can use aliases to define destinations in a game session queue or when requesting new game sessions.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html

CloudformationResource: AWS::GameLift::Alias

ExampleMetadata: fixture=_generated

Methods

FromAliasArn(Construct, string, string)

Creates a new IAliasRef from an ARN.

public static IAliasRef FromAliasArn(Construct scope, string id, string arn)
Parameters
scope Construct
id string
arn string
Returns

IAliasRef

Remarks

There are two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias displays a message instead of routing players to an active fleet. For example, a terminal alias might display a URL link that directs players to an upgrade site. You can use aliases to define destinations in a game session queue or when requesting new game sessions.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html

CloudformationResource: AWS::GameLift::Alias

ExampleMetadata: fixture=_generated

FromAliasId(Construct, string, string)

Creates a new IAliasRef from a aliasId.

public static IAliasRef FromAliasId(Construct scope, string id, string aliasId)
Parameters
scope Construct
id string
aliasId string
Returns

IAliasRef

Remarks

There are two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias displays a message instead of routing players to an active fleet. For example, a terminal alias might display a URL link that directs players to an upgrade site. You can use aliases to define destinations in a game session queue or when requesting new game sessions.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html

CloudformationResource: AWS::GameLift::Alias

ExampleMetadata: fixture=_generated

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

There are two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias displays a message instead of routing players to an active fleet. For example, a terminal alias might display a URL link that directs players to an upgrade site. You can use aliases to define destinations in a game session queue or when requesting new game sessions.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html

CloudformationResource: AWS::GameLift::Alias

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::GameLift::Alias resource creates an alias for an Amazon GameLift (GameLift) fleet destination.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

There are two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias displays a message instead of routing players to an active fleet. For example, a terminal alias might display a URL link that directs players to an upgrade site. You can use aliases to define destinations in a game session queue or when requesting new game sessions.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html

CloudformationResource: AWS::GameLift::Alias

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable