Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. workspaces
  5. ConnectionAlias
AWS v6.80.0 published on Tuesday, May 6, 2025 by Pulumi
pulumi/pulumi-aws

aws.workspaces.ConnectionAlias

Explore with Pulumi AI

aws logo
AWS v6.80.0 published on Tuesday, May 6, 2025 by Pulumi
pulumi/pulumi-aws

    Resource for managing an AWS WorkSpaces Connection Alias.

    Example Usage

    Basic Usage

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

const example = new aws.workspaces.ConnectionAlias("example", {connectionString: "testdomain.test"});

    import pulumi
import pulumi_aws as aws

example = aws.workspaces.ConnectionAlias("example", connection_string="testdomain.test")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := workspaces.NewConnectionAlias(ctx, "example", &workspaces.ConnectionAliasArgs{
			ConnectionString: pulumi.String("testdomain.test"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Workspaces.ConnectionAlias("example", new()
    {
        ConnectionString = "testdomain.test",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.workspaces.ConnectionAlias;
import com.pulumi.aws.workspaces.ConnectionAliasArgs;
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 ConnectionAlias("example", ConnectionAliasArgs.builder()
            .connectionString("testdomain.test")
            .build());

    }
}

    resources:
  example:
    type: aws:workspaces:ConnectionAlias
    properties:
      connectionString: testdomain.test

    Create ConnectionAlias Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ConnectionAlias(name: string, args: ConnectionAliasArgs, opts?: CustomResourceOptions);
    @overload
def ConnectionAlias(resource_name: str,
                    args: ConnectionAliasArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def ConnectionAlias(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    connection_string: Optional[str] = None,
                    tags: Optional[Mapping[str, str]] = None,
                    timeouts: Optional[ConnectionAliasTimeoutsArgs] = None)
    func NewConnectionAlias(ctx *Context, name string, args ConnectionAliasArgs, opts ...ResourceOption) (*ConnectionAlias, error)
    public ConnectionAlias(string name, ConnectionAliasArgs args, CustomResourceOptions? opts = null)
    public ConnectionAlias(String name, ConnectionAliasArgs args)
public ConnectionAlias(String name, ConnectionAliasArgs args, CustomResourceOptions options)

    type: aws:workspaces:ConnectionAlias
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ConnectionAliasArgs
    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 ConnectionAliasArgs
    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 ConnectionAliasArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectionAliasArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConnectionAliasArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var connectionAliasResource = new Aws.Workspaces.ConnectionAlias("connectionAliasResource", new()
{
    ConnectionString = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Timeouts = new Aws.Workspaces.Inputs.ConnectionAliasTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
});

    example, err := workspaces.NewConnectionAlias(ctx, "connectionAliasResource", &workspaces.ConnectionAliasArgs{
	ConnectionString: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Timeouts: &workspaces.ConnectionAliasTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
	},
})

    var connectionAliasResource = new ConnectionAlias("connectionAliasResource", ConnectionAliasArgs.builder()
    .connectionString("string")
    .tags(Map.of("string", "string"))
    .timeouts(ConnectionAliasTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .build());

    connection_alias_resource = aws.workspaces.ConnectionAlias("connectionAliasResource",
    connection_string="string",
    tags={
        "string": "string",
    },
    timeouts={
        "create": "string",
        "delete": "string",
    })

    const connectionAliasResource = new aws.workspaces.ConnectionAlias("connectionAliasResource", {
    connectionString: "string",
    tags: {
        string: "string",
    },
    timeouts: {
        create: "string",
        "delete": "string",
    },
});

    type: aws:workspaces:ConnectionAlias
properties:
    connectionString: string
    tags:
        string: string
    timeouts:
        create: string
        delete: string

    ConnectionAlias Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ConnectionAlias resource accepts the following input properties:

    ConnectionString string
    The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com.
    Tags Dictionary<string, string>
    A map of tags assigned to the WorkSpaces Connection Alias. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Timeouts ConnectionAliasTimeouts
    ConnectionString string
    The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com.
    Tags map[string]string
    A map of tags assigned to the WorkSpaces Connection Alias. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Timeouts ConnectionAliasTimeoutsArgs
    connectionString String
    The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com.
    tags Map<String,String>
    A map of tags assigned to the WorkSpaces Connection Alias. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts ConnectionAliasTimeouts
    connectionString string
    The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com.
    tags {[key: string]: string}
    A map of tags assigned to the WorkSpaces Connection Alias. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts ConnectionAliasTimeouts
    connection_string str
    The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com.
    tags Mapping[str, str]
    A map of tags assigned to the WorkSpaces Connection Alias. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts ConnectionAliasTimeoutsArgs
    connectionString String
    The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com.
    tags Map<String>
    A map of tags assigned to the WorkSpaces Connection Alias. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts Property Map

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    OwnerAccountId string
    The identifier of the Amazon Web Services account that owns the connection alias.
    State string
    The current state of the connection alias.
    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.

    Id string
    The provider-assigned unique ID for this managed resource.
    OwnerAccountId string
    The identifier of the Amazon Web Services account that owns the connection alias.
    State string
    The current state of the connection alias.
    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.

    id String
    The provider-assigned unique ID for this managed resource.
    ownerAccountId String
    The identifier of the Amazon Web Services account that owns the connection alias.
    state String
    The current state of the connection alias.
    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.

    id string
    The provider-assigned unique ID for this managed resource.
    ownerAccountId string
    The identifier of the Amazon Web Services account that owns the connection alias.
    state string
    The current state of the connection alias.
    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.

    id str
    The provider-assigned unique ID for this managed resource.
    owner_account_id str
    The identifier of the Amazon Web Services account that owns the connection alias.
    state str
    The current state of the connection alias.
    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.

    id String
    The provider-assigned unique ID for this managed resource.
    ownerAccountId String
    The identifier of the Amazon Web Services account that owns the connection alias.
    state String
    The current state of the connection alias.
    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 ConnectionAlias Resource

    Get an existing ConnectionAlias 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?: ConnectionAliasState, opts?: CustomResourceOptions): ConnectionAlias
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        connection_string: Optional[str] = None,
        owner_account_id: Optional[str] = None,
        state: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        timeouts: Optional[ConnectionAliasTimeoutsArgs] = None) -> ConnectionAlias
    func GetConnectionAlias(ctx *Context, name string, id IDInput, state *ConnectionAliasState, opts ...ResourceOption) (*ConnectionAlias, error)
    public static ConnectionAlias Get(string name, Input<string> id, ConnectionAliasState? state, CustomResourceOptions? opts = null)
    public static ConnectionAlias get(String name, Output<String> id, ConnectionAliasState state, CustomResourceOptions options)
    resources:  _:    type: aws:workspaces:ConnectionAlias    get:      id: ${id}
    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:
    ConnectionString string
    The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com.
    OwnerAccountId string
    The identifier of the Amazon Web Services account that owns the connection alias.
    State string
    The current state of the connection alias.
    Tags Dictionary<string, string>
    A map of tags assigned to the WorkSpaces Connection Alias. 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.

    Timeouts ConnectionAliasTimeouts
    ConnectionString string
    The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com.
    OwnerAccountId string
    The identifier of the Amazon Web Services account that owns the connection alias.
    State string
    The current state of the connection alias.
    Tags map[string]string
    A map of tags assigned to the WorkSpaces Connection Alias. 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.

    Timeouts ConnectionAliasTimeoutsArgs
    connectionString String
    The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com.
    ownerAccountId String
    The identifier of the Amazon Web Services account that owns the connection alias.
    state String
    The current state of the connection alias.
    tags Map<String,String>
    A map of tags assigned to the WorkSpaces Connection Alias. 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.

    timeouts ConnectionAliasTimeouts
    connectionString string
    The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com.
    ownerAccountId string
    The identifier of the Amazon Web Services account that owns the connection alias.
    state string
    The current state of the connection alias.
    tags {[key: string]: string}
    A map of tags assigned to the WorkSpaces Connection Alias. 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.

    timeouts ConnectionAliasTimeouts
    connection_string str
    The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com.
    owner_account_id str
    The identifier of the Amazon Web Services account that owns the connection alias.
    state str
    The current state of the connection alias.
    tags Mapping[str, str]
    A map of tags assigned to the WorkSpaces Connection Alias. 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.

    timeouts ConnectionAliasTimeoutsArgs
    connectionString String
    The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com.
    ownerAccountId String
    The identifier of the Amazon Web Services account that owns the connection alias.
    state String
    The current state of the connection alias.
    tags Map<String>
    A map of tags assigned to the WorkSpaces Connection Alias. 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.

    timeouts Property Map

    Supporting Types

    ConnectionAliasTimeouts, ConnectionAliasTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.

    Import

    Using pulumi import, import WorkSpaces Connection Alias using the connection alias ID. For example:

    $ pulumi import aws:workspaces/connectionAlias:ConnectionAlias example rft-8012925589

    To learn more about importing existing cloud resources, see Importing resources.

    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
    AWS v6.80.0 published on Tuesday, May 6, 2025 by Pulumi
    pulumi/pulumi-aws