Try AWS Native preview for resources not in the classic version.
aws.workspaces.ConnectionAlias
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
Resource for managing an AWS WorkSpaces Connection Alias.
Example Usage
Basic Usage
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/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
})
}
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());
}
}
import pulumi
import pulumi_aws as aws
example = aws.workspaces.ConnectionAlias("example", connection_string="testdomain.test")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.workspaces.ConnectionAlias("example", {connectionString: "testdomain.test"});
resources:
example:
type: aws:workspaces:ConnectionAlias
properties:
connectionString: testdomain.test
Create ConnectionAlias Resource
new ConnectionAlias(name: string, args: ConnectionAliasArgs, opts?: CustomResourceOptions);
@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)
@overload
def ConnectionAlias(resource_name: str,
args: ConnectionAliasArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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
The ConnectionAlias resource accepts the following input properties:
- Connection
String 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.
- 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
Pulumi.
Aws. Workspaces. Inputs. Connection Alias Timeouts
- Connection
String 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.
- 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
Connection
Alias Timeouts Args
- connection
String 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.
- 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
Connection
Alias Timeouts
- connection
String 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.
- {[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
Connection
Alias Timeouts
- 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.
- 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
Connection
Alias Timeouts Args
- connection
String 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.
- 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.
- Owner
Account stringId The identifier of the Amazon Web Services account that owns the connection alias.
- State string
The current state of the connection alias.
- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- Id string
The provider-assigned unique ID for this managed resource.
- Owner
Account stringId The identifier of the Amazon Web Services account that owns the connection alias.
- State string
The current state of the connection alias.
- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- id String
The provider-assigned unique ID for this managed resource.
- owner
Account StringId The identifier of the Amazon Web Services account that owns the connection alias.
- state String
The current state of the connection alias.
- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- id string
The provider-assigned unique ID for this managed resource.
- owner
Account stringId The identifier of the Amazon Web Services account that owns the connection alias.
- state string
The current state of the connection alias.
- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- id str
The provider-assigned unique ID for this managed resource.
- owner_
account_ strid The identifier of the Amazon Web Services account that owns the connection alias.
- state str
The current state of the connection alias.
- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- id String
The provider-assigned unique ID for this managed resource.
- owner
Account StringId The identifier of the Amazon Web Services account that owns the connection alias.
- state String
The current state of the connection alias.
- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
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)
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.
- Connection
String 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.
- Owner
Account stringId The identifier of the Amazon Web Services account that owns the connection alias.
- State string
The current state of the connection alias.
- 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.- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- Timeouts
Pulumi.
Aws. Workspaces. Inputs. Connection Alias Timeouts
- Connection
String 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.
- Owner
Account stringId The identifier of the Amazon Web Services account that owns the connection alias.
- State string
The current state of the connection alias.
- 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.- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- Timeouts
Connection
Alias Timeouts Args
- connection
String 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.
- owner
Account StringId The identifier of the Amazon Web Services account that owns the connection alias.
- state String
The current state of the connection alias.
- 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.- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- timeouts
Connection
Alias Timeouts
- connection
String 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.
- owner
Account stringId The identifier of the Amazon Web Services account that owns the connection alias.
- state string
The current state of the connection alias.
- {[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.- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- timeouts
Connection
Alias Timeouts
- 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_ strid The identifier of the Amazon Web Services account that owns the connection alias.
- state str
The current state of the connection alias.
- 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.- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- timeouts
Connection
Alias Timeouts Args
- connection
String 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.
- owner
Account StringId The identifier of the Amazon Web Services account that owns the connection alias.
- state String
The current state of the connection alias.
- 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.- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- timeouts Property Map
Supporting Types
ConnectionAliasTimeouts, ConnectionAliasTimeoutsArgs
Import
Using pulumi import
, import WorkSpaces Connection Alias using the connection alias ID. For example:
$ pulumi import aws:workspaces/connectionAlias:ConnectionAlias example rft-8012925589
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.
Try AWS Native preview for resources not in the classic version.