@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:39.460Z") @Stability(value=Stable) public class CfnAlias extends CfnResource implements IInspectable
The AWS::GameLift::Alias resource creates an alias for an Amazon GameLift (GameLift) fleet destination. There are two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias displays a message instead of routing players to an active fleet. For example, a terminal alias might display a URL link that directs players to an upgrade site. You can use aliases to define destinations in a game session queue or when requesting new game sessions.
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.*;
CfnAlias cfnAlias = CfnAlias.Builder.create(this, "MyCfnAlias")
.name("name")
.routingStrategy(RoutingStrategyProperty.builder()
.type("type")
// the properties below are optional
.fleetId("fleetId")
.message("message")
.build())
// the properties below are optional
.description("description")
.build();
| Modifier and Type | Class and Description |
|---|---|
static class |
CfnAlias.Builder
A fluent builder for
CfnAlias. |
static interface |
CfnAlias.RoutingStrategyProperty
The routing configuration for a fleet alias.
|
software.amazon.jsii.JsiiObject.InitializationModeIInspectable.Jsii$Default, IInspectable.Jsii$Proxy| Modifier and Type | Field and Description |
|---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnAlias(software.constructs.Construct scope,
String id,
CfnAliasProps props)
Create a new `AWS::GameLift::Alias`.
|
protected |
CfnAlias(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnAlias(software.amazon.jsii.JsiiObjectRef objRef) |
| Modifier and Type | Method and Description |
|---|---|
String |
getAttrAliasId()
A unique identifier for the alias.
|
protected Map<String,Object> |
getCfnProperties() |
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.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected Map<String,Object> |
renderProperties(Map<String,Object> props) |
void |
setDescription(String value)
A human-readable description of the alias.
|
void |
setName(String value)
A descriptive label that is associated with an alias.
|
void |
setRoutingStrategy(CfnAlias.RoutingStrategyProperty value)
The routing configuration, including routing type and fleet target, for the alias.
|
void |
setRoutingStrategy(IResolvable value)
The routing configuration, including routing type and fleet target, for the alias.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdjsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnAlias(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnAlias(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public CfnAlias(@NotNull
software.constructs.Construct scope,
@NotNull
String id,
@NotNull
CfnAliasProps props)
scope - - scope in which this resource is defined. This parameter is required.id - - scoped id of the resource. This parameter is required.props - - resource properties. This parameter is required.@Stability(value=Stable)
public void inspect(@NotNull
TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties in class CfnResourceprops - This parameter is required.@Stability(value=Stable) @NotNull public String getAttrAliasId()
Alias IDs are unique within a Region.
@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties in class CfnResource@Stability(value=Stable) @NotNull public String getName()
Alias names do not need to be unique.
@Stability(value=Stable)
public void setName(@NotNull
String value)
Alias names do not need to be unique.
@Stability(value=Stable) @NotNull public Object getRoutingStrategy()
@Stability(value=Stable)
public void setRoutingStrategy(@NotNull
CfnAlias.RoutingStrategyProperty value)
@Stability(value=Stable)
public void setRoutingStrategy(@NotNull
IResolvable value)
@Stability(value=Stable) @Nullable public String getDescription()
@Stability(value=Stable)
public void setDescription(@Nullable
String value)
Copyright © 2022. All rights reserved.