1. Pulumi Registry
  2. AWS Native
  3. API Docs
  4. gamelift
  5. Alias
aws-native logo
AWS Native v0.55.0, Mar 28 23

aws-native.gamelift.Alias

The AWS::GameLift::Alias resource creates an alias for an Amazon GameLift (GameLift) fleet destination.

Example Usage

Example

using System.Collections.Generic;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var aliasResource = new AwsNative.GameLift.Alias("aliasResource", new()
    {
        Name = "MyTerminalAlias",
        Description = "A terminal alias",
        RoutingStrategy = new AwsNative.GameLift.Inputs.AliasRoutingStrategyArgs
        {
            Type = AwsNative.GameLift.AliasRoutingStrategyType.Terminal,
            Message = "Terminal routing strategy message",
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/gamelift"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gamelift.NewAlias(ctx, "aliasResource", &gamelift.AliasArgs{
			Name:        pulumi.String("MyTerminalAlias"),
			Description: pulumi.String("A terminal alias"),
			RoutingStrategy: &gamelift.AliasRoutingStrategyArgs{
				Type:    gamelift.AliasRoutingStrategyTypeTerminal,
				Message: pulumi.String("Terminal routing strategy message"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_aws_native as aws_native

alias_resource = aws_native.gamelift.Alias("aliasResource",
    name="MyTerminalAlias",
    description="A terminal alias",
    routing_strategy=aws_native.gamelift.AliasRoutingStrategyArgs(
        type=aws_native.gamelift.AliasRoutingStrategyType.TERMINAL,
        message="Terminal routing strategy message",
    ))

import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const aliasResource = new aws_native.gamelift.Alias("aliasResource", {
    name: "MyTerminalAlias",
    description: "A terminal alias",
    routingStrategy: {
        type: aws_native.gamelift.AliasRoutingStrategyType.Terminal,
        message: "Terminal routing strategy message",
    },
});

Coming soon!

Example

using System.Collections.Generic;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var aliasResource = new AwsNative.GameLift.Alias("aliasResource", new()
    {
        Name = "MyTerminalAlias",
        Description = "A terminal alias",
        RoutingStrategy = new AwsNative.GameLift.Inputs.AliasRoutingStrategyArgs
        {
            Type = AwsNative.GameLift.AliasRoutingStrategyType.Terminal,
            Message = "Terminal routing strategy message",
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/gamelift"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gamelift.NewAlias(ctx, "aliasResource", &gamelift.AliasArgs{
			Name:        pulumi.String("MyTerminalAlias"),
			Description: pulumi.String("A terminal alias"),
			RoutingStrategy: &gamelift.AliasRoutingStrategyArgs{
				Type:    gamelift.AliasRoutingStrategyTypeTerminal,
				Message: pulumi.String("Terminal routing strategy message"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_aws_native as aws_native

alias_resource = aws_native.gamelift.Alias("aliasResource",
    name="MyTerminalAlias",
    description="A terminal alias",
    routing_strategy=aws_native.gamelift.AliasRoutingStrategyArgs(
        type=aws_native.gamelift.AliasRoutingStrategyType.TERMINAL,
        message="Terminal routing strategy message",
    ))

import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const aliasResource = new aws_native.gamelift.Alias("aliasResource", {
    name: "MyTerminalAlias",
    description: "A terminal alias",
    routingStrategy: {
        type: aws_native.gamelift.AliasRoutingStrategyType.Terminal,
        message: "Terminal routing strategy message",
    },
});

Coming soon!

Create Alias Resource

new Alias(name: string, args: AliasArgs, opts?: CustomResourceOptions);
@overload
def Alias(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          description: Optional[str] = None,
          name: Optional[str] = None,
          routing_strategy: Optional[AliasRoutingStrategyArgs] = None)
@overload
def Alias(resource_name: str,
          args: AliasArgs,
          opts: Optional[ResourceOptions] = None)
func NewAlias(ctx *Context, name string, args AliasArgs, opts ...ResourceOption) (*Alias, error)
public Alias(string name, AliasArgs args, CustomResourceOptions? opts = null)
public Alias(String name, AliasArgs args)
public Alias(String name, AliasArgs args, CustomResourceOptions options)

type: aws-native:gamelift:Alias
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AliasArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args AliasArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args AliasArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AliasArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args AliasArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Alias Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Alias resource accepts the following input properties:

RoutingStrategy Pulumi.AwsNative.GameLift.Inputs.AliasRoutingStrategyArgs

A routing configuration that specifies where traffic is directed for this alias, such as to a fleet or to a message.

Description string

A human-readable description of the alias.

Name string

A descriptive label that is associated with an alias. Alias names do not need to be unique.

RoutingStrategy AliasRoutingStrategyArgs

A routing configuration that specifies where traffic is directed for this alias, such as to a fleet or to a message.

Description string

A human-readable description of the alias.

Name string

A descriptive label that is associated with an alias. Alias names do not need to be unique.

routingStrategy AliasRoutingStrategyArgs

A routing configuration that specifies where traffic is directed for this alias, such as to a fleet or to a message.

description String

A human-readable description of the alias.

name String

A descriptive label that is associated with an alias. Alias names do not need to be unique.

routingStrategy AliasRoutingStrategyArgs

A routing configuration that specifies where traffic is directed for this alias, such as to a fleet or to a message.

description string

A human-readable description of the alias.

name string

A descriptive label that is associated with an alias. Alias names do not need to be unique.

routing_strategy AliasRoutingStrategyArgs

A routing configuration that specifies where traffic is directed for this alias, such as to a fleet or to a message.

description str

A human-readable description of the alias.

name str

A descriptive label that is associated with an alias. Alias names do not need to be unique.

routingStrategy Property Map

A routing configuration that specifies where traffic is directed for this alias, such as to a fleet or to a message.

description String

A human-readable description of the alias.

name String

A descriptive label that is associated with an alias. Alias names do not need to be unique.

Outputs

All input properties are implicitly available as output properties. Additionally, the Alias resource produces the following output properties:

AliasId string

Unique alias ID

Id string

The provider-assigned unique ID for this managed resource.

AliasId string

Unique alias ID

Id string

The provider-assigned unique ID for this managed resource.

aliasId String

Unique alias ID

id String

The provider-assigned unique ID for this managed resource.

aliasId string

Unique alias ID

id string

The provider-assigned unique ID for this managed resource.

alias_id str

Unique alias ID

id str

The provider-assigned unique ID for this managed resource.

aliasId String

Unique alias ID

id String

The provider-assigned unique ID for this managed resource.

Supporting Types

AliasRoutingStrategy

Type Pulumi.AwsNative.GameLift.AliasRoutingStrategyType

Simple routing strategy. The alias resolves to one specific fleet. Use this type when routing to active fleets.

FleetId string

A unique identifier for a fleet that the alias points to. If you specify SIMPLE for the Type property, you must specify this property.

Message string

The message text to be used with a terminal routing strategy. If you specify TERMINAL for the Type property, you must specify this property.

Type AliasRoutingStrategyType

Simple routing strategy. The alias resolves to one specific fleet. Use this type when routing to active fleets.

FleetId string

A unique identifier for a fleet that the alias points to. If you specify SIMPLE for the Type property, you must specify this property.

Message string

The message text to be used with a terminal routing strategy. If you specify TERMINAL for the Type property, you must specify this property.

type AliasRoutingStrategyType

Simple routing strategy. The alias resolves to one specific fleet. Use this type when routing to active fleets.

fleetId String

A unique identifier for a fleet that the alias points to. If you specify SIMPLE for the Type property, you must specify this property.

message String

The message text to be used with a terminal routing strategy. If you specify TERMINAL for the Type property, you must specify this property.

type AliasRoutingStrategyType

Simple routing strategy. The alias resolves to one specific fleet. Use this type when routing to active fleets.

fleetId string

A unique identifier for a fleet that the alias points to. If you specify SIMPLE for the Type property, you must specify this property.

message string

The message text to be used with a terminal routing strategy. If you specify TERMINAL for the Type property, you must specify this property.

type AliasRoutingStrategyType

Simple routing strategy. The alias resolves to one specific fleet. Use this type when routing to active fleets.

fleet_id str

A unique identifier for a fleet that the alias points to. If you specify SIMPLE for the Type property, you must specify this property.

message str

The message text to be used with a terminal routing strategy. If you specify TERMINAL for the Type property, you must specify this property.

type "SIMPLE" | "TERMINAL"

Simple routing strategy. The alias resolves to one specific fleet. Use this type when routing to active fleets.

fleetId String

A unique identifier for a fleet that the alias points to. If you specify SIMPLE for the Type property, you must specify this property.

message String

The message text to be used with a terminal routing strategy. If you specify TERMINAL for the Type property, you must specify this property.

AliasRoutingStrategyType

Simple
SIMPLE
Terminal
TERMINAL
AliasRoutingStrategyTypeSimple
SIMPLE
AliasRoutingStrategyTypeTerminal
TERMINAL
Simple
SIMPLE
Terminal
TERMINAL
Simple
SIMPLE
Terminal
TERMINAL
SIMPLE
SIMPLE
TERMINAL
TERMINAL
"SIMPLE"
SIMPLE
"TERMINAL"
TERMINAL

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0