AWS Native

v0.43.0 published on Thursday, Dec 1, 2022 by Pulumi

getAlias

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

Using getAlias

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAlias(args: GetAliasArgs, opts?: InvokeOptions): Promise<GetAliasResult>
function getAliasOutput(args: GetAliasOutputArgs, opts?: InvokeOptions): Output<GetAliasResult>
def get_alias(alias_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetAliasResult
def get_alias_output(alias_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetAliasResult]
func LookupAlias(ctx *Context, args *LookupAliasArgs, opts ...InvokeOption) (*LookupAliasResult, error)
func LookupAliasOutput(ctx *Context, args *LookupAliasOutputArgs, opts ...InvokeOption) LookupAliasResultOutput

> Note: This function is named LookupAlias in the Go SDK.

public static class GetAlias 
{
    public static Task<GetAliasResult> InvokeAsync(GetAliasArgs args, InvokeOptions? opts = null)
    public static Output<GetAliasResult> Invoke(GetAliasInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAliasResult> getAlias(GetAliasArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: aws-native:gamelift:getAlias
  arguments:
    # arguments dictionary

The following arguments are supported:

AliasId string

Unique alias ID

AliasId string

Unique alias ID

aliasId String

Unique alias ID

aliasId string

Unique alias ID

alias_id str

Unique alias ID

aliasId String

Unique alias ID

getAlias Result

The following output properties are available:

AliasId string

Unique alias ID

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 Pulumi.AwsNative.GameLift.Outputs.AliasRoutingStrategy

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

AliasId string

Unique alias ID

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 AliasRoutingStrategy

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

aliasId String

Unique alias ID

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 AliasRoutingStrategy

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

aliasId string

Unique alias ID

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 AliasRoutingStrategy

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

alias_id str

Unique alias ID

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.

routing_strategy AliasRoutingStrategy

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

aliasId String

Unique alias ID

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 Property Map

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

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

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0