software.amazon.awscdk.services.gamelift

Class CfnAlias

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.gamelift.CfnAlias

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:21.839Z")
public class CfnAlias
extends CfnResource
implements IInspectable

A CloudFormation `AWS::GameLift::Alias`.

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();
 

Nested Class Summary

Nested Classes

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.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

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)

Method Summary

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.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnAlias

protected CfnAlias(software.amazon.jsii.JsiiObjectRef objRef)

CfnAlias

protected CfnAlias(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnAlias

public CfnAlias(Construct scope,
                java.lang.String id,
                CfnAliasProps props)

Create a new `AWS::GameLift::Alias`.

Parameters:

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.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAliasId

public java.lang.String getAttrAliasId()

A unique identifier for the alias. For example, `arn:aws:gamelift:us-west-1::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912`.

Alias IDs are unique within a Region.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getName

public java.lang.String getName()

A descriptive label that is associated with an alias.

Alias names do not need to be unique.

setName

public void setName(java.lang.String value)

A descriptive label that is associated with an alias.

Alias names do not need to be unique.

getRoutingStrategy

public java.lang.Object getRoutingStrategy()

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

setRoutingStrategy

public void setRoutingStrategy(CfnAlias.RoutingStrategyProperty value)

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

setRoutingStrategy

public void setRoutingStrategy(IResolvable value)

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

getDescription

public java.lang.String getDescription()

A human-readable description of the alias.

setDescription

public void setDescription(java.lang.String value)

A human-readable description of the alias.