class CfnAliasPropsMixin (mixin)

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.GameLift.CfnAliasPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsgamelift#CfnAliasPropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.gamelift.CfnAliasPropsMixin
Python	aws_cdk.cfn_property_mixins.aws_gamelift.CfnAliasPropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_gamelift » CfnAliasPropsMixin

Implements IMixin

Extends Mixin

The AWS::GameLift::Alias resource creates an alias for an Amazon GameLift (GameLift) fleet destination.

There are two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias displays a message instead of routing players to an active fleet. For example, a terminal alias might display a URL link that directs players to an upgrade site. You can use aliases to define destinations in a game session queue or when requesting new game sessions.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_gamelift as gamelift } from '@aws-cdk/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const mergeStrategy: cdk.IMergeStrategy;
const cfnAliasPropsMixin = new gamelift.CfnAliasPropsMixin({
  description: 'description',
  name: 'name',
  routingStrategy: {
    fleetId: 'fleetId',
    message: 'message',
    type: 'type',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnAliasPropsMixin(props: CfnAliasMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnAliasMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::GameLift::Alias.

Properties

Name	Type	Description
props	CfnAliasMixinProps
strategy	IMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnAliasMixinProps

---

strategy

Type: IMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): void

Parameters

• construct IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.