Class CfnAlias
A CloudFormation AWS::GameLift::Alias
.
Inherited Members
Namespace: Amazon.CDK.AWS.GameLift
Assembly: Amazon.CDK.AWS.GameLift.dll
Syntax (csharp)
public class CfnAlias : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnAlias
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::GameLift::Alias
resource creates an alias for an Amazon GameLift (GameLift) fleet destination. 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.
CloudformationResource: AWS::GameLift::Alias
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html
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"
});
Synopsis
Constructors
CfnAlias(Construct, String, ICfnAliasProps) | Create a new |
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 |
Properties
AttrAliasId | A unique identifier for the alias. For example, |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnAlias(Construct, String, ICfnAliasProps)
Create a new AWS::GameLift::Alias
.
public CfnAlias(Construct scope, string id, ICfnAliasProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnAliasProps
- resource properties.
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
Properties
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
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
Remarks
Name
A descriptive label that is associated with an alias.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Alias names do not need to be unique.
RoutingStrategy
The routing configuration, including routing type and fleet target, for the alias.
public virtual object RoutingStrategy { get; set; }
Property Value
System.Object
Remarks
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>