Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. workspaces
  5. ConnectionAlias

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.workspaces.ConnectionAlias

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource Type definition for AWS::WorkSpaces::ConnectionAlias

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[Sequence[_root_inputs.CreateOnlyTagArgs]] = 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-native:workspaces:ConnectionAlias
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

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 This property is required. 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 List<Pulumi.AwsNative.Inputs.CreateOnlyTag>
The tags to associate with the connection alias.
ConnectionString This property is required. 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 CreateOnlyTagArgs
The tags to associate with the connection alias.
connectionString This property is required. 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 List<CreateOnlyTag>
The tags to associate with the connection alias.
connectionString This property is required. 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 CreateOnlyTag[]
The tags to associate with the connection alias.
connection_string This property is required. 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 Sequence[CreateOnlyTagArgs]
The tags to associate with the connection alias.
connectionString This property is required. 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 List<Property Map>
The tags to associate with the connection alias.

Outputs

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

AliasId string
The identifier of the connection alias, returned as a string.
Associations List<Pulumi.AwsNative.WorkSpaces.Outputs.ConnectionAliasAssociation>
The association status of the connection alias.
ConnectionAliasState Pulumi.AwsNative.WorkSpaces.ConnectionAliasState
The current state of the connection alias, returned as a string.
Id string
The provider-assigned unique ID for this managed resource.
AliasId string
The identifier of the connection alias, returned as a string.
Associations []ConnectionAliasAssociation
The association status of the connection alias.
ConnectionAliasState ConnectionAliasStateEnum
The current state of the connection alias, returned as a string.
Id string
The provider-assigned unique ID for this managed resource.
aliasId String
The identifier of the connection alias, returned as a string.
associations List<ConnectionAliasAssociation>
The association status of the connection alias.
connectionAliasState ConnectionAliasState
The current state of the connection alias, returned as a string.
id String
The provider-assigned unique ID for this managed resource.
aliasId string
The identifier of the connection alias, returned as a string.
associations ConnectionAliasAssociation[]
The association status of the connection alias.
connectionAliasState ConnectionAliasState
The current state of the connection alias, returned as a string.
id string
The provider-assigned unique ID for this managed resource.
alias_id str
The identifier of the connection alias, returned as a string.
associations Sequence[ConnectionAliasAssociation]
The association status of the connection alias.
connection_alias_state ConnectionAliasState
The current state of the connection alias, returned as a string.
id str
The provider-assigned unique ID for this managed resource.
aliasId String
The identifier of the connection alias, returned as a string.
associations List<Property Map>
The association status of the connection alias.
connectionAliasState "CREATING" | "CREATED" | "DELETING"
The current state of the connection alias, returned as a string.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

ConnectionAliasAssociation
, ConnectionAliasAssociationArgs

AssociatedAccountId string
The identifier of the AWS account that associated the connection alias with a directory.
AssociationStatus Pulumi.AwsNative.WorkSpaces.ConnectionAliasAssociationAssociationStatus
The association status of the connection alias.
ConnectionIdentifier string
The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies.
ResourceId string
The identifier of the directory associated with a connection alias.
AssociatedAccountId string
The identifier of the AWS account that associated the connection alias with a directory.
AssociationStatus ConnectionAliasAssociationAssociationStatus
The association status of the connection alias.
ConnectionIdentifier string
The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies.
ResourceId string
The identifier of the directory associated with a connection alias.
associatedAccountId String
The identifier of the AWS account that associated the connection alias with a directory.
associationStatus ConnectionAliasAssociationAssociationStatus
The association status of the connection alias.
connectionIdentifier String
The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies.
resourceId String
The identifier of the directory associated with a connection alias.
associatedAccountId string
The identifier of the AWS account that associated the connection alias with a directory.
associationStatus ConnectionAliasAssociationAssociationStatus
The association status of the connection alias.
connectionIdentifier string
The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies.
resourceId string
The identifier of the directory associated with a connection alias.
associated_account_id str
The identifier of the AWS account that associated the connection alias with a directory.
association_status ConnectionAliasAssociationAssociationStatus
The association status of the connection alias.
connection_identifier str
The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies.
resource_id str
The identifier of the directory associated with a connection alias.
associatedAccountId String
The identifier of the AWS account that associated the connection alias with a directory.
associationStatus "NOT_ASSOCIATED" | "PENDING_ASSOCIATION" | "ASSOCIATED_WITH_OWNER_ACCOUNT" | "ASSOCIATED_WITH_SHARED_ACCOUNT" | "PENDING_DISASSOCIATION"
The association status of the connection alias.
connectionIdentifier String
The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies.
resourceId String
The identifier of the directory associated with a connection alias.

ConnectionAliasAssociationAssociationStatus
, ConnectionAliasAssociationAssociationStatusArgs

NotAssociated
NOT_ASSOCIATED
PendingAssociation
PENDING_ASSOCIATION
AssociatedWithOwnerAccount
ASSOCIATED_WITH_OWNER_ACCOUNT
AssociatedWithSharedAccount
ASSOCIATED_WITH_SHARED_ACCOUNT
PendingDisassociation
PENDING_DISASSOCIATION
ConnectionAliasAssociationAssociationStatusNotAssociated
NOT_ASSOCIATED
ConnectionAliasAssociationAssociationStatusPendingAssociation
PENDING_ASSOCIATION
ConnectionAliasAssociationAssociationStatusAssociatedWithOwnerAccount
ASSOCIATED_WITH_OWNER_ACCOUNT
ConnectionAliasAssociationAssociationStatusAssociatedWithSharedAccount
ASSOCIATED_WITH_SHARED_ACCOUNT
ConnectionAliasAssociationAssociationStatusPendingDisassociation
PENDING_DISASSOCIATION
NotAssociated
NOT_ASSOCIATED
PendingAssociation
PENDING_ASSOCIATION
AssociatedWithOwnerAccount
ASSOCIATED_WITH_OWNER_ACCOUNT
AssociatedWithSharedAccount
ASSOCIATED_WITH_SHARED_ACCOUNT
PendingDisassociation
PENDING_DISASSOCIATION
NotAssociated
NOT_ASSOCIATED
PendingAssociation
PENDING_ASSOCIATION
AssociatedWithOwnerAccount
ASSOCIATED_WITH_OWNER_ACCOUNT
AssociatedWithSharedAccount
ASSOCIATED_WITH_SHARED_ACCOUNT
PendingDisassociation
PENDING_DISASSOCIATION
NOT_ASSOCIATED
NOT_ASSOCIATED
PENDING_ASSOCIATION
PENDING_ASSOCIATION
ASSOCIATED_WITH_OWNER_ACCOUNT
ASSOCIATED_WITH_OWNER_ACCOUNT
ASSOCIATED_WITH_SHARED_ACCOUNT
ASSOCIATED_WITH_SHARED_ACCOUNT
PENDING_DISASSOCIATION
PENDING_DISASSOCIATION
"NOT_ASSOCIATED"
NOT_ASSOCIATED
"PENDING_ASSOCIATION"
PENDING_ASSOCIATION
"ASSOCIATED_WITH_OWNER_ACCOUNT"
ASSOCIATED_WITH_OWNER_ACCOUNT
"ASSOCIATED_WITH_SHARED_ACCOUNT"
ASSOCIATED_WITH_SHARED_ACCOUNT
"PENDING_DISASSOCIATION"
PENDING_DISASSOCIATION

ConnectionAliasState
, ConnectionAliasStateArgs

Creating
CREATING
Created
CREATED
Deleting
DELETING
ConnectionAliasStateCreating
CREATING
ConnectionAliasStateCreated
CREATED
ConnectionAliasStateDeleting
DELETING
Creating
CREATING
Created
CREATED
Deleting
DELETING
Creating
CREATING
Created
CREATED
Deleting
DELETING
CREATING
CREATING
CREATED
CREATED
DELETING
DELETING
"CREATING"
CREATING
"CREATED"
CREATED
"DELETING"
DELETING

CreateOnlyTag
, CreateOnlyTagArgs

Key
This property is required.
Changes to this property will trigger replacement.
string
The key name of the tag
Value
This property is required.
Changes to this property will trigger replacement.
string
The value of the tag
Key
This property is required.
Changes to this property will trigger replacement.
string
The key name of the tag
Value
This property is required.
Changes to this property will trigger replacement.
string
The value of the tag
key
This property is required.
Changes to this property will trigger replacement.
String
The key name of the tag
value
This property is required.
Changes to this property will trigger replacement.
String
The value of the tag
key
This property is required.
Changes to this property will trigger replacement.
string
The key name of the tag
value
This property is required.
Changes to this property will trigger replacement.
string
The value of the tag
key
This property is required.
Changes to this property will trigger replacement.
str
The key name of the tag
value
This property is required.
Changes to this property will trigger replacement.
str
The value of the tag
key
This property is required.
Changes to this property will trigger replacement.
String
The key name of the tag
value
This property is required.
Changes to this property will trigger replacement.
String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native