ConnectionAlias class

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")
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 main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_workspaces_connectionalias" "example" {
  connection_string = "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.ArrayList;
import java.util.Arrays;
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

Import

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

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

Constructors

ConnectionAlias(String name, {ConnectionAliasArgs? args, CustomResourceOptions? options})
Creates a new ConnectionAlias. name The Pulumi resource name. args Arguments used to configure this ConnectionAlias. The set of arguments for ConnectionAlias. options Resource options controlling this resource's behavior.
ConnectionAlias.reference(String urn)
Creates a typed reference to an existing ConnectionAlias resource.

Properties

childResources Set<Resource>
finalinherited
completionSources Map<String, IOutputCompletionSource>
latefinalinherited
connectionString ↔ Output<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.
latefinal
hashCode int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference bool
Whether this instance represents a resource value returned over RPC.
finalinherited
ownerAccountId ↔ Output<String>
The identifier of the Amazon Web Services account that owns the connection alias.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
state ↔ Output<String>
The current state of the connection alias.
latefinal
tags ↔ Output<Map<String, String>?>
A map of tags assigned to the WorkSpaces Connection Alias. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
timeouts ↔ Output<ConnectionAliasTimeouts?>
latefinal
transformations List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() String
Returns this resource's logical name.
inherited
getResourceType() String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {ConnectionAliasState? state, CustomResourceOptions? options}) ConnectionAlias
Gets an existing ConnectionAlias resource's state with the given name and id.