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

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.workspaces.getConnectionAlias

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::WorkSpaces::ConnectionAlias

    Using getConnectionAlias

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getConnectionAlias(args: GetConnectionAliasArgs, opts?: InvokeOptions): Promise<GetConnectionAliasResult>
function getConnectionAliasOutput(args: GetConnectionAliasOutputArgs, opts?: InvokeOptions): Output<GetConnectionAliasResult>
    def get_connection_alias(alias_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetConnectionAliasResult
def get_connection_alias_output(alias_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetConnectionAliasResult]
    func LookupConnectionAlias(ctx *Context, args *LookupConnectionAliasArgs, opts ...InvokeOption) (*LookupConnectionAliasResult, error)
func LookupConnectionAliasOutput(ctx *Context, args *LookupConnectionAliasOutputArgs, opts ...InvokeOption) LookupConnectionAliasResultOutput

    > Note: This function is named LookupConnectionAlias in the Go SDK.

    public static class GetConnectionAlias 
{
    public static Task<GetConnectionAliasResult> InvokeAsync(GetConnectionAliasArgs args, InvokeOptions? opts = null)
    public static Output<GetConnectionAliasResult> Invoke(GetConnectionAliasInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetConnectionAliasResult> getConnectionAlias(GetConnectionAliasArgs args, InvokeOptions options)
public static Output<GetConnectionAliasResult> getConnectionAlias(GetConnectionAliasArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:workspaces:getConnectionAlias
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AliasId string
    The identifier of the connection alias, returned as a string.
    AliasId string
    The identifier of the connection alias, returned as a string.
    aliasId String
    The identifier of the connection alias, returned as a string.
    aliasId string
    The identifier of the connection alias, returned as a string.
    alias_id str
    The identifier of the connection alias, returned as a string.
    aliasId String
    The identifier of the connection alias, returned as a string.

    getConnectionAlias Result

    The following output properties are available:

    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.
    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.
    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.
    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.
    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.
    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.

    Supporting Types

    ConnectionAliasAssociation

    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

    ConnectionAliasState

    Package Details

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

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

    AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-aws-native