Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. grafana
  5. getWorkspace
AWS v6.72.0 published on Tuesday, Mar 11, 2025 by Pulumi
pulumi/pulumi-aws

aws.grafana.getWorkspace

Explore with Pulumi AI

aws logo
AWS v6.72.0 published on Tuesday, Mar 11, 2025 by Pulumi
pulumi/pulumi-aws

    Provides an Amazon Managed Grafana workspace data source.

    Example Usage

    Basic configuration

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.grafana.getWorkspace({
    workspaceId: "g-2054c75a02",
});

    import pulumi
import pulumi_aws as aws

example = aws.grafana.get_workspace(workspace_id="g-2054c75a02")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/grafana"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := grafana.LookupWorkspace(ctx, &grafana.LookupWorkspaceArgs{
			WorkspaceId: "g-2054c75a02",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.Grafana.GetWorkspace.Invoke(new()
    {
        WorkspaceId = "g-2054c75a02",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.grafana.GrafanaFunctions;
import com.pulumi.aws.grafana.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 = GrafanaFunctions.getWorkspace(GetWorkspaceArgs.builder()
            .workspaceId("g-2054c75a02")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: aws:grafana:getWorkspace
      arguments:
        workspaceId: g-2054c75a02

    Using getWorkspace

    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 getWorkspace(args: GetWorkspaceArgs, opts?: InvokeOptions): Promise<GetWorkspaceResult>
function getWorkspaceOutput(args: GetWorkspaceOutputArgs, opts?: InvokeOptions): Output<GetWorkspaceResult>
    def get_workspace(tags: Optional[Mapping[str, str]] = None,
                  workspace_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetWorkspaceResult
def get_workspace_output(tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                  workspace_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetWorkspaceResult]
    func LookupWorkspace(ctx *Context, args *LookupWorkspaceArgs, opts ...InvokeOption) (*LookupWorkspaceResult, error)
func LookupWorkspaceOutput(ctx *Context, args *LookupWorkspaceOutputArgs, opts ...InvokeOption) LookupWorkspaceResultOutput

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

    public static class GetWorkspace 
{
    public static Task<GetWorkspaceResult> InvokeAsync(GetWorkspaceArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkspaceResult> Invoke(GetWorkspaceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetWorkspaceResult> getWorkspace(GetWorkspaceArgs args, InvokeOptions options)
public static Output<GetWorkspaceResult> getWorkspace(GetWorkspaceArgs args, InvokeOptions options)

    fn::invoke:
  function: aws:grafana/getWorkspace:getWorkspace
  arguments:
    # arguments dictionary

    The following arguments are supported:

    WorkspaceId string
    Grafana workspace ID.
    Tags Dictionary<string, string>
    Tags assigned to the resource
    WorkspaceId string
    Grafana workspace ID.
    Tags map[string]string
    Tags assigned to the resource
    workspaceId String
    Grafana workspace ID.
    tags Map<String,String>
    Tags assigned to the resource
    workspaceId string
    Grafana workspace ID.
    tags {[key: string]: string}
    Tags assigned to the resource
    workspace_id str
    Grafana workspace ID.
    tags Mapping[str, str]
    Tags assigned to the resource
    workspaceId String
    Grafana workspace ID.
    tags Map<String>
    Tags assigned to the resource

    getWorkspace Result

    The following output properties are available:

    AccountAccessType string
    (Required) Type of account access for the workspace. Valid values are CURRENT_ACCOUNT and ORGANIZATION. If ORGANIZATION is specified, then organizational_units must also be present.
    Arn string
    ARN of the Grafana workspace.
    AuthenticationProviders List<string>
    (Required) Authentication providers for the workspace. Valid values are AWS_SSO, SAML, or both.
    CreatedDate string
    Creation date of the Grafana workspace.
    DataSources List<string>
    Data sources for the workspace.
    Description string
    Workspace description.
    Endpoint string
    Endpoint of the Grafana workspace.
    GrafanaVersion string
    Version of Grafana running on the workspace.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedDate string
    Last updated date of the Grafana workspace.
    Name string
    Grafana workspace name.
    NotificationDestinations List<string>
    The notification destinations.
    OrganizationRoleName string
    The role name that the workspace uses to access resources through Amazon Organizations.
    OrganizationalUnits List<string>
    The Amazon Organizations organizational units that the workspace is authorized to use data sources from.
    PermissionType string
    Permission type of the workspace.
    RoleArn string
    IAM role ARN that the workspace assumes.
    SamlConfigurationStatus string
    StackSetName string
    AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
    Status string
    Status of the Grafana workspace.
    Tags Dictionary<string, string>
    Tags assigned to the resource
    WorkspaceId string
    AccountAccessType string
    (Required) Type of account access for the workspace. Valid values are CURRENT_ACCOUNT and ORGANIZATION. If ORGANIZATION is specified, then organizational_units must also be present.
    Arn string
    ARN of the Grafana workspace.
    AuthenticationProviders []string
    (Required) Authentication providers for the workspace. Valid values are AWS_SSO, SAML, or both.
    CreatedDate string
    Creation date of the Grafana workspace.
    DataSources []string
    Data sources for the workspace.
    Description string
    Workspace description.
    Endpoint string
    Endpoint of the Grafana workspace.
    GrafanaVersion string
    Version of Grafana running on the workspace.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedDate string
    Last updated date of the Grafana workspace.
    Name string
    Grafana workspace name.
    NotificationDestinations []string
    The notification destinations.
    OrganizationRoleName string
    The role name that the workspace uses to access resources through Amazon Organizations.
    OrganizationalUnits []string
    The Amazon Organizations organizational units that the workspace is authorized to use data sources from.
    PermissionType string
    Permission type of the workspace.
    RoleArn string
    IAM role ARN that the workspace assumes.
    SamlConfigurationStatus string
    StackSetName string
    AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
    Status string
    Status of the Grafana workspace.
    Tags map[string]string
    Tags assigned to the resource
    WorkspaceId string
    accountAccessType String
    (Required) Type of account access for the workspace. Valid values are CURRENT_ACCOUNT and ORGANIZATION. If ORGANIZATION is specified, then organizational_units must also be present.
    arn String
    ARN of the Grafana workspace.
    authenticationProviders List<String>
    (Required) Authentication providers for the workspace. Valid values are AWS_SSO, SAML, or both.
    createdDate String
    Creation date of the Grafana workspace.
    dataSources List<String>
    Data sources for the workspace.
    description String
    Workspace description.
    endpoint String
    Endpoint of the Grafana workspace.
    grafanaVersion String
    Version of Grafana running on the workspace.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedDate String
    Last updated date of the Grafana workspace.
    name String
    Grafana workspace name.
    notificationDestinations List<String>
    The notification destinations.
    organizationRoleName String
    The role name that the workspace uses to access resources through Amazon Organizations.
    organizationalUnits List<String>
    The Amazon Organizations organizational units that the workspace is authorized to use data sources from.
    permissionType String
    Permission type of the workspace.
    roleArn String
    IAM role ARN that the workspace assumes.
    samlConfigurationStatus String
    stackSetName String
    AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
    status String
    Status of the Grafana workspace.
    tags Map<String,String>
    Tags assigned to the resource
    workspaceId String
    accountAccessType string
    (Required) Type of account access for the workspace. Valid values are CURRENT_ACCOUNT and ORGANIZATION. If ORGANIZATION is specified, then organizational_units must also be present.
    arn string
    ARN of the Grafana workspace.
    authenticationProviders string[]
    (Required) Authentication providers for the workspace. Valid values are AWS_SSO, SAML, or both.
    createdDate string
    Creation date of the Grafana workspace.
    dataSources string[]
    Data sources for the workspace.
    description string
    Workspace description.
    endpoint string
    Endpoint of the Grafana workspace.
    grafanaVersion string
    Version of Grafana running on the workspace.
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdatedDate string
    Last updated date of the Grafana workspace.
    name string
    Grafana workspace name.
    notificationDestinations string[]
    The notification destinations.
    organizationRoleName string
    The role name that the workspace uses to access resources through Amazon Organizations.
    organizationalUnits string[]
    The Amazon Organizations organizational units that the workspace is authorized to use data sources from.
    permissionType string
    Permission type of the workspace.
    roleArn string
    IAM role ARN that the workspace assumes.
    samlConfigurationStatus string
    stackSetName string
    AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
    status string
    Status of the Grafana workspace.
    tags {[key: string]: string}
    Tags assigned to the resource
    workspaceId string
    account_access_type str
    (Required) Type of account access for the workspace. Valid values are CURRENT_ACCOUNT and ORGANIZATION. If ORGANIZATION is specified, then organizational_units must also be present.
    arn str
    ARN of the Grafana workspace.
    authentication_providers Sequence[str]
    (Required) Authentication providers for the workspace. Valid values are AWS_SSO, SAML, or both.
    created_date str
    Creation date of the Grafana workspace.
    data_sources Sequence[str]
    Data sources for the workspace.
    description str
    Workspace description.
    endpoint str
    Endpoint of the Grafana workspace.
    grafana_version str
    Version of Grafana running on the workspace.
    id str
    The provider-assigned unique ID for this managed resource.
    last_updated_date str
    Last updated date of the Grafana workspace.
    name str
    Grafana workspace name.
    notification_destinations Sequence[str]
    The notification destinations.
    organization_role_name str
    The role name that the workspace uses to access resources through Amazon Organizations.
    organizational_units Sequence[str]
    The Amazon Organizations organizational units that the workspace is authorized to use data sources from.
    permission_type str
    Permission type of the workspace.
    role_arn str
    IAM role ARN that the workspace assumes.
    saml_configuration_status str
    stack_set_name str
    AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
    status str
    Status of the Grafana workspace.
    tags Mapping[str, str]
    Tags assigned to the resource
    workspace_id str
    accountAccessType String
    (Required) Type of account access for the workspace. Valid values are CURRENT_ACCOUNT and ORGANIZATION. If ORGANIZATION is specified, then organizational_units must also be present.
    arn String
    ARN of the Grafana workspace.
    authenticationProviders List<String>
    (Required) Authentication providers for the workspace. Valid values are AWS_SSO, SAML, or both.
    createdDate String
    Creation date of the Grafana workspace.
    dataSources List<String>
    Data sources for the workspace.
    description String
    Workspace description.
    endpoint String
    Endpoint of the Grafana workspace.
    grafanaVersion String
    Version of Grafana running on the workspace.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedDate String
    Last updated date of the Grafana workspace.
    name String
    Grafana workspace name.
    notificationDestinations List<String>
    The notification destinations.
    organizationRoleName String
    The role name that the workspace uses to access resources through Amazon Organizations.
    organizationalUnits List<String>
    The Amazon Organizations organizational units that the workspace is authorized to use data sources from.
    permissionType String
    Permission type of the workspace.
    roleArn String
    IAM role ARN that the workspace assumes.
    samlConfigurationStatus String
    stackSetName String
    AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
    status String
    Status of the Grafana workspace.
    tags Map<String>
    Tags assigned to the resource
    workspaceId String

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.72.0 published on Tuesday, Mar 11, 2025 by Pulumi
    pulumi/pulumi-aws