aws-cdk-lib.aws_gamelift.CfnAlias.RoutingStrategyProperty

interface RoutingStrategyProperty

LanguageType name
.NETAmazon.CDK.AWS.GameLift.CfnAlias.RoutingStrategyProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsgamelift#CfnAlias_RoutingStrategyProperty
Javasoftware.amazon.awscdk.services.gamelift.CfnAlias.RoutingStrategyProperty
Pythonaws_cdk.aws_gamelift.CfnAlias.RoutingStrategyProperty
TypeScript aws-cdk-lib » aws_gamelift » CfnAlias » RoutingStrategyProperty

The routing configuration for a fleet alias.

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-lib';
const routingStrategyProperty: gamelift.CfnAlias.RoutingStrategyProperty = {
  type: 'type',

  // the properties below are optional
  fleetId: 'fleetId',
  message: 'message',
};

Properties

NameTypeDescription
typestringA type of routing strategy.
fleetId?stringA unique identifier for a fleet that the alias points to.
message?stringThe message text to be used with a terminal routing strategy.

type

Type: string

A type of routing strategy.

Possible routing types include the following:

  • SIMPLE - The alias resolves to one specific fleet. Use this type when routing to active fleets.
  • TERMINAL - The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the message that you specified in the Message property.

fleetId?

Type: string (optional)

A unique identifier for a fleet that the alias points to.

If you specify SIMPLE for the Type property, you must specify this property.


message?

Type: string (optional)

The message text to be used with a terminal routing strategy.

If you specify TERMINAL for the Type property, you must specify this property.