Package software.amazon.awscdk.services.gamelift

Interface CfnAliasProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAliasProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:39.236Z")
@Stability(Stable)
public interface CfnAliasProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAlias.

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.*;
 CfnAliasProps cfnAliasProps = CfnAliasProps.builder()
         .name("name")
         .routingStrategy(RoutingStrategyProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .fleetId("fleetId")
                 .message("message")
                 .build())
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAliasProps.Builder	builder()
default String	getDescription()	A human-readable description of the alias.
String	getName()	A descriptive label that is associated with an alias.
Object	getRoutingStrategy()	The routing configuration, including routing type and fleet target, for the alias.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

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

getRoutingStrategy

@Stability(Stable)
@NotNull
Object getRoutingStrategy()

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

Returns union: either IResolvable or CfnAlias.RoutingStrategyProperty

See Also:

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

getDescription

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

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

builder

@Stability(Stable)
static CfnAliasProps.Builder builder()

Returns:

a CfnAliasProps.Builder of CfnAliasProps