We recommend new projects start with resources from the AWS provider.
We recommend new projects start with resources from the AWS provider.
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 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
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:
- 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. -
List<Pulumi.
Aws Native. Inputs. Create Only Tag> - The tags to associate with the connection alias.
- 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. -
Create
Only Tag Args - The tags to associate with the connection alias.
- 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. -
List<Create
Only Tag> - The tags to associate with the connection alias.
- 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. -
Create
Only Tag[] - The tags to associate with the connection alias.
- 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. -
Sequence[Create
Only Tag Args] - The tags to associate with the connection alias.
- 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. - 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:
- Alias
Id string - The identifier of the connection alias, returned as a string.
- Associations
List<Pulumi.
Aws Native. Work Spaces. Outputs. Connection Alias Association> - The association status of the connection alias.
- Connection
Alias Pulumi.State Aws Native. Work Spaces. Connection Alias State - The current state of the connection alias, returned as a string.
- Id string
- The provider-assigned unique ID for this managed resource.
- Alias
Id string - The identifier of the connection alias, returned as a string.
- Associations
[]Connection
Alias Association - The association status of the connection alias.
- Connection
Alias ConnectionState Alias State Enum - The current state of the connection alias, returned as a string.
- Id string
- The provider-assigned unique ID for this managed resource.
- alias
Id String - The identifier of the connection alias, returned as a string.
- associations
List<Connection
Alias Association> - The association status of the connection alias.
- connection
Alias ConnectionState Alias State - The current state of the connection alias, returned as a string.
- id String
- The provider-assigned unique ID for this managed resource.
- alias
Id string - The identifier of the connection alias, returned as a string.
- associations
Connection
Alias Association[] - The association status of the connection alias.
- connection
Alias ConnectionState Alias State - 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[Connection
Alias Association] - The association status of the connection alias.
- connection_
alias_ Connectionstate Alias State - The current state of the connection alias, returned as a string.
- id str
- The provider-assigned unique ID for this managed resource.
- alias
Id String - The identifier of the connection alias, returned as a string.
- associations List<Property Map>
- The association status of the connection alias.
- connection
Alias "CREATING" | "CREATED" | "DELETING"State - 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
- Associated
Account stringId - The identifier of the AWS account that associated the connection alias with a directory.
- Association
Status Pulumi.Aws Native. Work Spaces. Connection Alias Association Association Status - The association status of the connection alias.
- Connection
Identifier 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.
- Resource
Id string - The identifier of the directory associated with a connection alias.
- Associated
Account stringId - The identifier of the AWS account that associated the connection alias with a directory.
- Association
Status ConnectionAlias Association Association Status - The association status of the connection alias.
- Connection
Identifier 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.
- Resource
Id string - The identifier of the directory associated with a connection alias.
- associated
Account StringId - The identifier of the AWS account that associated the connection alias with a directory.
- association
Status ConnectionAlias Association Association Status - The association status of the connection alias.
- connection
Identifier 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.
- resource
Id String - The identifier of the directory associated with a connection alias.
- associated
Account stringId - The identifier of the AWS account that associated the connection alias with a directory.
- association
Status ConnectionAlias Association Association Status - The association status of the connection alias.
- connection
Identifier 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.
- resource
Id string - The identifier of the directory associated with a connection alias.
- associated_
account_ strid - The identifier of the AWS account that associated the connection alias with a directory.
- association_
status ConnectionAlias Association Association Status - 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.
- associated
Account StringId - The identifier of the AWS account that associated the connection alias with a directory.
- association
Status "NOT_ASSOCIATED" | "PENDING_ASSOCIATION" | "ASSOCIATED_WITH_OWNER_ACCOUNT" | "ASSOCIATED_WITH_SHARED_ACCOUNT" | "PENDING_DISASSOCIATION" - The association status of the connection alias.
- connection
Identifier 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.
- resource
Id String - The identifier of the directory associated with a connection alias.
ConnectionAliasAssociationAssociationStatus, ConnectionAliasAssociationAssociationStatusArgs
- 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
- Connection
Alias Association Association Status Not Associated NOT_ASSOCIATED- Connection
Alias Association Association Status Pending Association PENDING_ASSOCIATION- Connection
Alias Association Association Status Associated With Owner Account ASSOCIATED_WITH_OWNER_ACCOUNT- Connection
Alias Association Association Status Associated With Shared Account ASSOCIATED_WITH_SHARED_ACCOUNT- Connection
Alias Association Association Status 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
- 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
- "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
- Connection
Alias State Creating CREATING- Connection
Alias State Created CREATED- Connection
Alias State Deleting 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
A set of tags to apply to the resource.Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
