@aws-cdk/aws-gamelift-alpha.Alias

Experimental

@aws-cdk/aws-gamelift-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

Alias L2 construct

A Amazon GameLift alias is used to abstract a fleet designation.

Fleet designations tell GameLift where to search for available resources when creating new game sessions for players. Use aliases instead of specific fleet IDs to seamlessly switch player traffic from one fleet to another by changing the alias's target location.

Aliases are useful in games that don't use queues. Switching fleets in a queue is a simple matter of creating a new fleet, adding it to the queue, and removing the old fleet, none of which is visible to players. In contrast, game clients that don't use queues must specify which fleet to use when communicating with the GameLift service. Without aliases, a fleet switch requires updates to your game code and possibly distribution of an updated game clients to players.

When updating the fleet-id an alias points to, there is a transition period of up to 2 minutes where game sessions on the alias may end up on the old fleet.

Construct›Resource›AliasBase›Alias

implements

• IAlias,
• IGameSessionQueueDestination,
• IResource,
• IEnvironmentAware,
• 2 more

  • IConstruct,
  • IDependable

Stability

Experimental

CloudFormation

AWS::GameLift::Alias

L1 type

CfnAlias

Source

lib/alias.ts

Example

declare const fleet: gamelift.BuildFleet;

// Add an alias to an existing fleet using a dedicated fleet method
const liveAlias = fleet.addAlias('live');

// You can also create a standalone alias
new gamelift.Alias(this, 'TerminalAlias', {
  aliasName: 'terminal-alias',
  terminalMessage: 'A terminal message',
});

# fleet: gamelift.BuildFleet


# Add an alias to an existing fleet using a dedicated fleet method
live_alias = fleet.add_alias("live")

# You can also create a standalone alias
gamelift.Alias(self, "TerminalAlias",
    alias_name="terminal-alias",
    terminal_message="A terminal message"
)

BuildFleet fleet;


// Add an alias to an existing fleet using a dedicated fleet method
Alias liveAlias = fleet.addAlias("live");

// You can also create a standalone alias
// You can also create a standalone alias
Alias.Builder.create(this, "TerminalAlias")
        .aliasName("terminal-alias")
        .terminalMessage("A terminal message")
        .build();

// Install: dotnet add package Amazon.CDK.AWS.GameLift.Alpha
BuildFleet fleet;


// Add an alias to an existing fleet using a dedicated fleet method
var liveAlias = fleet.AddAlias("live");

// You can also create a standalone alias
// You can also create a standalone alias
new Alias(this, "TerminalAlias", new AliasProps {
    AliasName = "terminal-alias",
    TerminalMessage = "A terminal message"
});

// Install: go get github.com/aws/aws-cdk-go/awscdkgameliftalpha/v2
var fleet BuildFleet


// Add an alias to an existing fleet using a dedicated fleet method
liveAlias := fleet.AddAlias(jsii.String("live"))

// You can also create a standalone alias
// You can also create a standalone alias
gamelift.NewAlias(this, jsii.String("TerminalAlias"), &AliasProps{
	AliasName: jsii.String("terminal-alias"),
	TerminalMessage: jsii.String("A terminal message"),
})

Initializer

new Alias(scope: Construct, id: string, props: AliasProps)

Alias(scope: Construct, id: str, props: AliasProps)

new Alias(Construct scope, String id, AliasProps props)

new Alias(Construct scope, string id, AliasProps props)

NewAlias(Scope Construct, Id *string, Props AliasProps)

Construct Props

aliasNamestringalias_namestraliasNameStringAliasNamestringAliasName*stringrequired#

Name of this alias.

description?optionalstringdescription?optionalstrdescription?optionalStringDescription?optionalstringDescription?optional*string#

A human-readable description of the alias.

Default: no description

fleet?optionalIFleetfleet?optionalIFleetfleet?optionalIFleetFleet?optionalIFleetFleet?optionalIFleet#

A fleet that the alias points to. If specified, the alias resolves to one specific fleet.

Default: no fleet that the alias points to.

At least one of fleet and terminalMessage must be provided.

terminalMessage?optionalstringterminal_message?optionalstrterminalMessage?optionalStringTerminalMessage?optionalstringTerminalMessage?optional*string#

The message text to be used with a terminal routing strategy.

Default: no terminal message

At least one of fleet and terminalMessage must be provided.

Properties

aliasArnstringalias_arnstraliasArnStringAliasArnstringAliasArn*string#

The ARN of the alias.

aliasIdstringalias_idstraliasIdStringAliasIdstringAliasId*string#

The Identifier of the alias.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#

The environment this resource belongs to.

notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

fleet?may be undefinedIFleetfleet?may be undefinedIFleetfleet?may be undefinedIFleetFleet?may be undefinedIFleetFleet?may be undefinedIFleet#

A fleet that the alias points to.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringstatic#

Uniquely identifies this class.

resourceArnForDestinationstringresource_arn_for_destinationstrresourceArnForDestinationStringResourceArnForDestinationstringResourceArnForDestination*string#

The ARN to put into the destination field of a game session queue.

stackStackstackStackstackStackStackStackStackStack#

The stack in which this resource is defined.

Methods

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Override the cross-stack reference strength for this resource.

notes · 1 parameter

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters

• strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

fromAliasArn(scope: Construct, id: string, aliasArn: string): IAlias@staticmethod def from_alias_arn(scope: Construct, id: str, alias_arn: str) -> IAliaspublic static IAlias fromAliasArn(Construct scope, String id, String aliasArn)public static IAlias FromAliasArn(Construct scope, string id, string aliasArn)func FromAliasArn(Scope Construct, Id *string, AliasArn *string) IAliasstatic#

Import an existing alias from its ARN.

fromAliasAttributes(scope: Construct, id: string, attrs: AliasAttributes): IAlias@staticmethod def from_alias_attributes(scope: Construct, id: str, attrs: AliasAttributes) -> IAliaspublic static IAlias fromAliasAttributes(Construct scope, String id, AliasAttributes attrs)public static IAlias FromAliasAttributes(Construct scope, string id, AliasAttributes attrs)func FromAliasAttributes(Scope Construct, Id *string, Attrs AliasAttributes) IAliasstatic#

Import an existing alias from its attributes.

fromAliasId(scope: Construct, id: string, aliasId: string): IAlias@staticmethod def from_alias_id(scope: Construct, id: str, alias_id: str) -> IAliaspublic static IAlias fromAliasId(Construct scope, String id, String aliasId)public static IAlias FromAliasId(Construct scope, string id, string aliasId)func FromAliasId(Scope Construct, Id *string, AliasId *string) IAliasstatic#

Import an existing alias from its identifier.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

• xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#

Returns true if the construct was created by CDK, and false otherwise.

isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#

Check whether the given construct is a Resource.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.