Alias

class aws_cdk.aws_gamelift_alpha.Alias(scope, id, *, alias_name, description=None, fleet=None, terminal_message=None)

Bases: AliasBase

(experimental) 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.

See:

https://docs.aws.amazon.com/gamelift/latest/developerguide/aliases-creating.html

Stability:

experimental

Resource:

AWS::GameLift::Alias

ExampleMetadata:

infused

Example:

# 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"
)
Parameters:

  • scope (Construct)

  • id (str)

  • alias_name (str) – (experimental) Name of this alias.

  • description (Optional[str]) – (experimental) A human-readable description of the alias. Default: no description

  • fleet (Optional[IFleet]) – (experimental) A fleet that the alias points to. If specified, the alias resolves to one specific fleet. At least one of fleet and terminalMessage must be provided. Default: no fleet that the alias points to.

  • terminal_message (Optional[str]) – (experimental) The message text to be used with a terminal routing strategy. At least one of fleet and terminalMessage must be provided. Default: no terminal message

Stability:

experimental

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

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

Parameters:

policy (RemovalPolicy)

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Attributes

PROPERTY_INJECTION_ID = '@aws-cdk.aws-gamelift-alpha.Alias'
alias_arn

(experimental) The ARN of the alias.

Stability:

experimental

alias_id

(experimental) The Identifier of the alias.

Stability:

experimental

env

The environment this resource belongs to.

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

(experimental) A fleet that the alias points to.

Stability:

experimental

node

The tree node.

resource_arn_for_destination

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

Stability:

experimental

stack

The stack in which this resource is defined.

Static Methods

classmethod from_alias_arn(scope, id, alias_arn)

(experimental) Import an existing alias from its ARN.

Parameters:
Stability:

experimental

Return type:

IAlias

classmethod from_alias_attributes(scope, id, *, alias_arn=None, alias_id=None)

(experimental) Import an existing alias from its attributes.

Parameters:

  • scope (Construct)

  • id (str)

  • alias_arn (Optional[str]) – (experimental) The ARN of the alias. At least one of aliasArn and aliasId must be provided. Default: derived from aliasId.

  • alias_id (Optional[str]) – (experimental) The identifier of the alias. At least one of aliasId and aliasArn must be provided. Default: derived from aliasArn.

Stability:

experimental

Return type:

IAlias

classmethod from_alias_id(scope, id, alias_id)

(experimental) Import an existing alias from its identifier.

Parameters:
Stability:

experimental

Return type:

IAlias

classmethod is_construct(x)

Checks if x is a construct.

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:

x (Any) – Any object.

Return type:

bool

Returns:

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

classmethod is_owned_resource(construct)

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

Parameters:

construct (IConstruct)

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct)

Return type:

bool