@aws-cdk_aws-gamelift-alpha.AliasBase

class AliasBase ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.GameLift.Alpha.AliasBase
Gogithub.com/aws/aws-cdk-go/awscdkgameliftalpha/v2#AliasBase
Javasoftware.amazon.awscdk.services.gamelift.alpha.AliasBase
Pythonaws_cdk.aws_gamelift_alpha.AliasBase
TypeScript (source)@aws-cdk/aws-gamelift-alpha ยป AliasBase

Implements IConstruct, IDependable, IResource, IAlias, IGameSessionQueueDestination

Extends Resource

Implemented by Alias

Base class for new and imported GameLift Alias.

Initializer

new AliasBase(scope: Construct, id: string, props?: ResourceProps)

Parameters

  • scope Construct
  • id string
  • props ResourceProps

Properties

NameTypeDescription
aliasArn๐Ÿ”นstringThe ARN of the alias.
aliasId๐Ÿ”นstringThe Identifier of the alias.
env๐Ÿ”นResourceEnvironmentThe environment this resource belongs to.
node๐Ÿ”นNodeThe tree node.
resourceArnForDestination๐Ÿ”นstringThe ARN to put into the destination field of a game session queue.
stack๐Ÿ”นStackThe 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 by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


node๐Ÿ”น

Type: Node

The tree node.


resourceArnForDestination๐Ÿ”น

Type: string

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


stack๐Ÿ”น

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
applyRemovalPolicy(policy)๐Ÿ”นApply the given removal policy to this resource.
toString()๐Ÿ”นReturns a string representation of 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).


toString()๐Ÿ”น

public toString(): string

Returns

  • string

Returns a string representation of this construct.