interface IAlias 🔹

Language	Type name
.NET	Amazon.CDK.AWS.GameLift.Alpha.IAlias
Go	github.com/aws/aws-cdk-go/awscdkgameliftalpha/v2#IAlias
Java	software.amazon.awscdk.services.gamelift.alpha.IAlias
Python	aws_cdk.aws_gamelift_alpha.IAlias
TypeScript (source)	@aws-cdk/aws-gamelift-alpha » IAlias

Implements IDependable, IConstruct, IEnvironmentAware, IResource, IGameSessionQueueDestination

Implemented by Alias

Obtainable from Alias.fromAliasArn(), Alias.fromAliasAttributes(), Alias.fromAliasId()

Represents a Gamelift Alias for a Gamelift fleet destination.

Properties

Name	Type	Description
aliasArn🔹	string	The ARN of the alias.
aliasId🔹	string	The Identifier of the alias.
env🔹	ResourceEnvironment	The environment this resource belongs to.
node🔹	Node	The tree node.
resourceArnForDestination🔹	string	The ARN(s) to put into the destination field for a game session queue.
stack🔹	Stack	The stack in which this resource is defined.

---

aliasArn🔹

Type: string

The ARN of the alias.

---

aliasId🔹

Type: string

The Identifier of the alias.

---

env🔹

Type: ResourceEnvironment

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.

---

node🔹

Type: Node

The tree node.

---

resourceArnForDestination🔹

Type: string

The ARN(s) to put into the destination field for a game session queue.

This property is for cdk modules to consume only. You should not need to use this property. Instead, use dedicated identifier on each components.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
with(...mixins)🔹	Applies one or more mixins to this construct.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

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

---

with(...mixins)🔹

public with(...mixins: IMixin[]): IConstruct

Parameters

• mixins IMixin — The mixins to apply.

Returns

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