Class CfnAlias

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

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnAlias
Inherited Members
Namespace: Amazon.CDK.AWS.GameLift
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnAlias : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnAlias
    Inherits CfnResource
    Implements IInspectable, 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(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnAlias(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnAlias(Construct, String, ICfnAliasProps)

Properties

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.
CdkTagManager

Tag Manager which manages the tags for this resource.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
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

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnAlias(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnAlias(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnAlias(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnAlias(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnAlias(Construct, String, ICfnAliasProps)

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

Scope in which this resource is defined.

id System.String

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

props ICfnAliasProps

Resource properties.

Properties

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:&lt;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

System.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

System.String

Remarks

Alias IDs are unique within a Region.

CloudformationAttribute: AliasId

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

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

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Description

A human-readable description of the alias.

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

System.String

Name

A descriptive label that is associated with an alias.

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

System.String

RoutingStrategy

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

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

System.Object

Tags

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

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

ICfnTag[]

Methods

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.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements