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 |
Implemented by
Alias
Obtainable from
Alias.fromAliasArn(), Alias.fromAliasAttributes(), Alias.fromAliasId()
Represents a Gamelift Alias for a Gamelift fleet destination.
Properties
| Name | Type | Description |
|---|---|---|
| alias | string | The ARN of the alias. |
| alias | string | The Identifier of the alias. |
| env | Resource | The environment this resource belongs to. |
| node | Node | The tree node. |
| resource | 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:
Resource
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(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 |
|---|---|
| apply | Apply the given removal policy to this resource. |
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).