pulumi-aws-kotlin/com.pulumi.aws.amp.kotlin/AmpFunctions/getWorkspaces

getWorkspaces

suspend fun getWorkspaces(argument: GetWorkspacesPlainArgs): GetWorkspacesResult

Provides the aliases, ARNs, and workspace IDs of Amazon Prometheus workspaces.

Example Usage

The following example returns all of the workspaces in a region:

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.amp.getWorkspaces({});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
example = aws.amp.get_workspaces()
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var example = Aws.Amp.GetWorkspaces.Invoke();
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/amp"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := amp.GetWorkspaces(ctx, &amp.GetWorkspacesArgs{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.amp.AmpFunctions;
import com.pulumi.aws.amp.inputs.GetWorkspacesArgs;
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 = AmpFunctions.getWorkspaces();
    }
}
Content copied to clipboard
variables:
  example:
    fn::invoke:
      function: aws:amp:getWorkspaces
      arguments: {}
Content copied to clipboard

The following example filters the workspaces by alias. Only the workspaces with aliases that begin with the value of alias_prefix will be returned:

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.amp.getWorkspaces({
    aliasPrefix: "example",
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
example = aws.amp.get_workspaces(alias_prefix="example")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var example = Aws.Amp.GetWorkspaces.Invoke(new()
    {
        AliasPrefix = "example",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/amp"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := amp.GetWorkspaces(ctx, &amp.GetWorkspacesArgs{
			AliasPrefix: pulumi.StringRef("example"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.amp.AmpFunctions;
import com.pulumi.aws.amp.inputs.GetWorkspacesArgs;
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 = AmpFunctions.getWorkspaces(GetWorkspacesArgs.builder()
            .aliasPrefix("example")
            .build());
    }
}
Content copied to clipboard
variables:
  example:
    fn::invoke:
      function: aws:amp:getWorkspaces
      arguments:
        aliasPrefix: example
Content copied to clipboard

Return

A collection of values returned by getWorkspaces.

Parameters

argument

A collection of arguments for invoking getWorkspaces.

suspend fun getWorkspaces(aliasPrefix: String? = null): GetWorkspacesResult

Return

A collection of values returned by getWorkspaces.

Parameters

aliasPrefix

Limits results to workspaces with aliases that begin with this value.

See also

.

suspend fun getWorkspaces(argument: suspend GetWorkspacesPlainArgsBuilder.() -> Unit): GetWorkspacesResult

Return

A collection of values returned by getWorkspaces.

Parameters

argument

Builder for com.pulumi.aws.amp.kotlin.inputs.GetWorkspacesPlainArgs.

See also

.