CfnAliasProps¶

class aws_cdk.aws_gamelift.CfnAliasProps(*, name, routing_strategy, description=None)¶

Bases: object

Properties for defining a CfnAlias.

Parameters

name (str) – A descriptive label that is associated with an alias. Alias names do not need to be unique.
routing_strategy (Union[RoutingStrategyProperty, Dict[str, Any], IResolvable]) – The routing configuration, including routing type and fleet target, for the alias.
description (Optional[str]) – A human-readable description of the alias.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_gamelift as gamelift

cfn_alias_props = gamelift.CfnAliasProps(
    name="name",
    routing_strategy=gamelift.CfnAlias.RoutingStrategyProperty(
        type="type",

        # the properties below are optional
        fleet_id="fleetId",
        message="message"
    ),

    # the properties below are optional
    description="description"
)

Attributes

description¶

A human-readable description of the alias.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html#cfn-gamelift-alias-description
Return type: Optional[str]

name¶

A descriptive label that is associated with an alias.

Alias names do not need to be unique.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html#cfn-gamelift-alias-name
Return type: str

routing_strategy¶

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html#cfn-gamelift-alias-routingstrategy
Return type: Union[RoutingStrategyProperty, IResolvable]