pulumi-aws-kotlin/com.pulumi.aws.workspaces.kotlin/WorkspacesFunctions/getWorkspace

getWorkspace

suspend fun getWorkspace(argument: GetWorkspacePlainArgs): GetWorkspaceResult

Use this data source to get information about a workspace in AWS Workspaces Service.

Example Usage

Filter By Workspace ID

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.workspaces.WorkspacesFunctions;
import com.pulumi.aws.workspaces.inputs.GetWorkspaceArgs;
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) {
        final var example = WorkspacesFunctions.getWorkspace(GetWorkspaceArgs.builder()
            .workspaceId("ws-cj5xcxsz5")
            .build());
    }
}
Content copied to clipboard

Filter By Directory ID & User Name

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.workspaces.WorkspacesFunctions;
import com.pulumi.aws.workspaces.inputs.GetWorkspaceArgs;
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) {
        final var example = WorkspacesFunctions.getWorkspace(GetWorkspaceArgs.builder()
            .directoryId("d-9967252f57")
            .userName("Example")
            .build());
    }
}
Content copied to clipboard

Return

A collection of values returned by getWorkspace.

Parameters

argument

A collection of arguments for invoking getWorkspace.

suspend fun getWorkspace(directoryId: String? = null, tags: Map<String, String>? = null, userName: String? = null, workspaceId: String? = null): GetWorkspaceResult

Return

A collection of values returned by getWorkspace.

Parameters

directoryId

ID of the directory for the WorkSpace. You have to specify user_name along with directory_id. You cannot combine this parameter with workspace_id.

tags

Tags for the WorkSpace.

userName

User name of the user for the WorkSpace. This user name must exist in the directory for the WorkSpace. You cannot combine this parameter with workspace_id.

workspaceId

ID of the WorkSpace. You cannot combine this parameter with directory_id.

See also

.

suspend fun getWorkspace(argument: suspend GetWorkspacePlainArgsBuilder.() -> Unit): GetWorkspaceResult

Return

A collection of values returned by getWorkspace.

Parameters

argument

Builder for com.pulumi.aws.workspaces.kotlin.inputs.GetWorkspacePlainArgs.

See also

.