aws-cdk-lib.aws_gamelift.CfnAliasProps

CfnAliasProps Struct

Properties for defining a CfnAlias.

CfnAliasProps

used as props by

• CfnAlias

Source

Generated code

Type last changed

v2.189.0 · 9 Apr 2025

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 cfnAliasProps: gamelift.CfnAliasProps = {
  name: 'name',
  routingStrategy: {
    type: 'type',

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

  // the properties below are optional
  description: 'description',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#

A human-readable description of the alias.

namestringnamestrnameStringNamestringName*stringrequired#

A descriptive label that is associated with an alias.

Alias names do not need to be unique.

routingStrategyIResolvable | CfnAlias.RoutingStrategyPropertyrouting_strategytyping.Union[IResolvable, RoutingStrategyProperty]routingStrategyIResolvableRoutingStrategyIResolvableRoutingStrategyinterface{}required#

The routing configuration, including routing type and fleet target, for the alias.

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#

An array of key-value pairs to apply to this resource.