@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-14T16:25:21.839Z") 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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnAlias(Construct scope,
java.lang.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 |
---|---|
java.lang.String |
getAttrAliasId()
A unique identifier for the alias.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDescription()
A human-readable description of the alias.
|
java.lang.String |
getName()
A descriptive label that is associated with an alias.
|
java.lang.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 java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setDescription(java.lang.String value)
A human-readable description of the alias.
|
void |
setName(java.lang.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, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnAlias(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnAlias(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnAlias(Construct scope, java.lang.String id, 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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrAliasId()
Alias IDs are unique within a Region.
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getName()
Alias names do not need to be unique.
public void setName(java.lang.String value)
Alias names do not need to be unique.
public java.lang.Object getRoutingStrategy()
public void setRoutingStrategy(CfnAlias.RoutingStrategyProperty value)
public void setRoutingStrategy(IResolvable value)
public java.lang.String getDescription()
public void setDescription(java.lang.String value)