Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. gamelift
  5. Alias

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.2.1 published on Friday, Sep 22, 2023 by Pulumi
pulumi/pulumi-aws

aws.gamelift.Alias

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.2.1 published on Friday, Sep 22, 2023 by Pulumi
pulumi/pulumi-aws

    Provides a GameLift Alias resource.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.GameLift.Alias("example", new()
    {
        Description = "Example Description",
        RoutingStrategy = new Aws.GameLift.Inputs.AliasRoutingStrategyArgs
        {
            Message = "Example Message",
            Type = "TERMINAL",
        },
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gamelift.NewAlias(ctx, "example", &gamelift.AliasArgs{
			Description: pulumi.String("Example Description"),
			RoutingStrategy: &gamelift.AliasRoutingStrategyArgs{
				Message: pulumi.String("Example Message"),
				Type:    pulumi.String("TERMINAL"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.gamelift.Alias;
import com.pulumi.aws.gamelift.AliasArgs;
import com.pulumi.aws.gamelift.inputs.AliasRoutingStrategyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Alias("example", AliasArgs.builder()        
            .description("Example Description")
            .routingStrategy(AliasRoutingStrategyArgs.builder()
                .message("Example Message")
                .type("TERMINAL")
                .build())
            .build());

    }
}

    import pulumi
import pulumi_aws as aws

example = aws.gamelift.Alias("example",
    description="Example Description",
    routing_strategy=aws.gamelift.AliasRoutingStrategyArgs(
        message="Example Message",
        type="TERMINAL",
    ))

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.gamelift.Alias("example", {
    description: "Example Description",
    routingStrategy: {
        message: "Example Message",
        type: "TERMINAL",
    },
});

    resources:
  example:
    type: aws:gamelift:Alias
    properties:
      description: Example Description
      routingStrategy:
        message: Example Message
        type: TERMINAL

    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,
          tags: Optional[Mapping[str, str]] = 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: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 AliasRoutingStrategy

    Specifies the fleet and/or routing type to use for the alias.

    Description string

    Description of the alias.

    Name string

    Name of the alias.

    Tags Dictionary<string, string>

    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    RoutingStrategy AliasRoutingStrategyArgs

    Specifies the fleet and/or routing type to use for the alias.

    Description string

    Description of the alias.

    Name string

    Name of the alias.

    Tags map[string]string

    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    routingStrategy AliasRoutingStrategy

    Specifies the fleet and/or routing type to use for the alias.

    description String

    Description of the alias.

    name String

    Name of the alias.

    tags Map<String,String>

    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    routingStrategy AliasRoutingStrategy

    Specifies the fleet and/or routing type to use for the alias.

    description string

    Description of the alias.

    name string

    Name of the alias.

    tags {[key: string]: string}

    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    routing_strategy AliasRoutingStrategyArgs

    Specifies the fleet and/or routing type to use for the alias.

    description str

    Description of the alias.

    name str

    Name of the alias.

    tags Mapping[str, str]

    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    routingStrategy Property Map

    Specifies the fleet and/or routing type to use for the alias.

    description String

    Description of the alias.

    name String

    Name of the alias.

    tags Map<String>

    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string

    Alias ARN.

    Id string

    The provider-assigned unique ID for this managed resource.

    TagsAll Dictionary<string, string>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Arn string

    Alias ARN.

    Id string

    The provider-assigned unique ID for this managed resource.

    TagsAll map[string]string

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn String

    Alias ARN.

    id String

    The provider-assigned unique ID for this managed resource.

    tagsAll Map<String,String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn string

    Alias ARN.

    id string

    The provider-assigned unique ID for this managed resource.

    tagsAll {[key: string]: string}

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn str

    Alias ARN.

    id str

    The provider-assigned unique ID for this managed resource.

    tags_all Mapping[str, str]

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn String

    Alias ARN.

    id String

    The provider-assigned unique ID for this managed resource.

    tagsAll Map<String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Look up Existing Alias Resource

    Get an existing Alias resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AliasState, opts?: CustomResourceOptions): Alias
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        routing_strategy: Optional[AliasRoutingStrategyArgs] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> Alias
    func GetAlias(ctx *Context, name string, id IDInput, state *AliasState, opts ...ResourceOption) (*Alias, error)
    public static Alias Get(string name, Input<string> id, AliasState? state, CustomResourceOptions? opts = null)
    public static Alias get(String name, Output<String> id, AliasState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string

    Alias ARN.

    Description string

    Description of the alias.

    Name string

    Name of the alias.

    RoutingStrategy AliasRoutingStrategy

    Specifies the fleet and/or routing type to use for the alias.

    Tags Dictionary<string, string>

    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    TagsAll Dictionary<string, string>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Arn string

    Alias ARN.

    Description string

    Description of the alias.

    Name string

    Name of the alias.

    RoutingStrategy AliasRoutingStrategyArgs

    Specifies the fleet and/or routing type to use for the alias.

    Tags map[string]string

    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    TagsAll map[string]string

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn String

    Alias ARN.

    description String

    Description of the alias.

    name String

    Name of the alias.

    routingStrategy AliasRoutingStrategy

    Specifies the fleet and/or routing type to use for the alias.

    tags Map<String,String>

    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll Map<String,String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn string

    Alias ARN.

    description string

    Description of the alias.

    name string

    Name of the alias.

    routingStrategy AliasRoutingStrategy

    Specifies the fleet and/or routing type to use for the alias.

    tags {[key: string]: string}

    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll {[key: string]: string}

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn str

    Alias ARN.

    description str

    Description of the alias.

    name str

    Name of the alias.

    routing_strategy AliasRoutingStrategyArgs

    Specifies the fleet and/or routing type to use for the alias.

    tags Mapping[str, str]

    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tags_all Mapping[str, str]

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn String

    Alias ARN.

    description String

    Description of the alias.

    name String

    Name of the alias.

    routingStrategy Property Map

    Specifies the fleet and/or routing type to use for the alias.

    tags Map<String>

    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll Map<String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Supporting Types

    AliasRoutingStrategy, AliasRoutingStrategyArgs

    Type string

    Type of routing strategyE.g., SIMPLE or TERMINAL

    FleetId string

    ID of the GameLift Fleet to point the alias to.

    Message string

    Message text to be used with the TERMINAL routing strategy.

    Type string

    Type of routing strategyE.g., SIMPLE or TERMINAL

    FleetId string

    ID of the GameLift Fleet to point the alias to.

    Message string

    Message text to be used with the TERMINAL routing strategy.

    type String

    Type of routing strategyE.g., SIMPLE or TERMINAL

    fleetId String

    ID of the GameLift Fleet to point the alias to.

    message String

    Message text to be used with the TERMINAL routing strategy.

    type string

    Type of routing strategyE.g., SIMPLE or TERMINAL

    fleetId string

    ID of the GameLift Fleet to point the alias to.

    message string

    Message text to be used with the TERMINAL routing strategy.

    type str

    Type of routing strategyE.g., SIMPLE or TERMINAL

    fleet_id str

    ID of the GameLift Fleet to point the alias to.

    message str

    Message text to be used with the TERMINAL routing strategy.

    type String

    Type of routing strategyE.g., SIMPLE or TERMINAL

    fleetId String

    ID of the GameLift Fleet to point the alias to.

    message String

    Message text to be used with the TERMINAL routing strategy.

    Import

    Using pulumi import, import GameLift Aliases using the ID. For example:

     $ pulumi import aws:gamelift/alias:Alias example <alias-id>

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the aws Terraform Provider.

    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.2.1 published on Friday, Sep 22, 2023 by Pulumi
    pulumi/pulumi-aws