interface CfnAliasProps

Language	Type name
.NET	Amazon.CDK.AWS.GameLift.CfnAliasProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsgamelift#CfnAliasProps
Java	software.amazon.awscdk.services.gamelift.CfnAliasProps
Python	aws_cdk.aws_gamelift.CfnAliasProps
TypeScript	aws-cdk-lib » aws_gamelift » CfnAliasProps

Properties for defining a CfnAlias.

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-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

Name	Type	Description
name	string	A descriptive label that is associated with an alias.
routingStrategy	IResolvable | RoutingStrategyProperty	The routing configuration, including routing type and fleet target, for the alias.
description?	string	A human-readable description of the alias.
tags?	CfnTag[]	An array of key-value pairs to apply to this resource.

---

name

Type: string

A descriptive label that is associated with an alias.

Alias names do not need to be unique.

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

---

routingStrategy

Type: IResolvable | RoutingStrategyProperty

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

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

---

description?

Type: string (optional)

A human-readable description of the alias.

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

---

tags?

Type: CfnTag[] (optional)

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

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