Package software.amazon.awscdk.services.gamelift

Interface CfnAlias.RoutingStrategyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAlias.RoutingStrategyProperty.Jsii$Proxy

Enclosing class:

CfnAlias

@Stability(Stable)
public static interface CfnAlias.RoutingStrategyProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.gamelift.*;
 RoutingStrategyProperty routingStrategyProperty = RoutingStrategyProperty.builder()
         .type("type")
         // the properties below are optional
         .fleetId("fleetId")
         .message("message")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-alias-routingstrategy.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAlias.RoutingStrategyProperty.Builder	A builder for CfnAlias.RoutingStrategyProperty
static final class	CfnAlias.RoutingStrategyProperty.Jsii$Proxy	An implementation for CfnAlias.RoutingStrategyProperty

Method Summary

Modifier and Type	Method	Description
static CfnAlias.RoutingStrategyProperty.Builder	builder()
default String	getFleetId()	A unique identifier for a fleet that the alias points to.
default String	getMessage()	The message text to be used with a terminal routing strategy.
String	getType()	A type of routing strategy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getType

@Stability(Stable)
@NotNull
String getType()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-alias-routingstrategy.html#cfn-gamelift-alias-routingstrategy-type

getFleetId

@Stability(Stable)
@Nullable
default String getFleetId()

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-alias-routingstrategy.html#cfn-gamelift-alias-routingstrategy-fleetid

getMessage

@Stability(Stable)
@Nullable
default String getMessage()

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-alias-routingstrategy.html#cfn-gamelift-alias-routingstrategy-message

builder

@Stability(Stable)
static CfnAlias.RoutingStrategyProperty.Builder builder()

Returns:

a CfnAlias.RoutingStrategyProperty.Builder of CfnAlias.RoutingStrategyProperty