1. Packages
  2. AWS Classic
  3. API Docs
  4. grafana
  5. Workspace

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.24.0 published on Tuesday, Feb 27, 2024 by Pulumi

aws.grafana.Workspace

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.24.0 published on Tuesday, Feb 27, 2024 by Pulumi

    Provides an Amazon Managed Grafana workspace resource.

    Example Usage

    Basic configuration

    using System.Collections.Generic;
    using System.Linq;
    using System.Text.Json;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var assume = new Aws.Iam.Role("assume", new()
        {
            AssumeRolePolicy = JsonSerializer.Serialize(new Dictionary<string, object?>
            {
                ["Version"] = "2012-10-17",
                ["Statement"] = new[]
                {
                    new Dictionary<string, object?>
                    {
                        ["Action"] = "sts:AssumeRole",
                        ["Effect"] = "Allow",
                        ["Sid"] = "",
                        ["Principal"] = new Dictionary<string, object?>
                        {
                            ["Service"] = "grafana.amazonaws.com",
                        },
                    },
                },
            }),
        });
    
        var example = new Aws.Grafana.Workspace("example", new()
        {
            AccountAccessType = "CURRENT_ACCOUNT",
            AuthenticationProviders = new[]
            {
                "SAML",
            },
            PermissionType = "SERVICE_MANAGED",
            RoleArn = assume.Arn,
        });
    
    });
    
    package main
    
    import (
    	"encoding/json"
    
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/grafana"
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iam"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		tmpJSON0, err := json.Marshal(map[string]interface{}{
    			"Version": "2012-10-17",
    			"Statement": []map[string]interface{}{
    				map[string]interface{}{
    					"Action": "sts:AssumeRole",
    					"Effect": "Allow",
    					"Sid":    "",
    					"Principal": map[string]interface{}{
    						"Service": "grafana.amazonaws.com",
    					},
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		json0 := string(tmpJSON0)
    		assume, err := iam.NewRole(ctx, "assume", &iam.RoleArgs{
    			AssumeRolePolicy: pulumi.String(json0),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = grafana.NewWorkspace(ctx, "example", &grafana.WorkspaceArgs{
    			AccountAccessType: pulumi.String("CURRENT_ACCOUNT"),
    			AuthenticationProviders: pulumi.StringArray{
    				pulumi.String("SAML"),
    			},
    			PermissionType: pulumi.String("SERVICE_MANAGED"),
    			RoleArn:        assume.Arn,
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.iam.Role;
    import com.pulumi.aws.iam.RoleArgs;
    import com.pulumi.aws.grafana.Workspace;
    import com.pulumi.aws.grafana.WorkspaceArgs;
    import static com.pulumi.codegen.internal.Serialization.*;
    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) {
            var assume = new Role("assume", RoleArgs.builder()        
                .assumeRolePolicy(serializeJson(
                    jsonObject(
                        jsonProperty("Version", "2012-10-17"),
                        jsonProperty("Statement", jsonArray(jsonObject(
                            jsonProperty("Action", "sts:AssumeRole"),
                            jsonProperty("Effect", "Allow"),
                            jsonProperty("Sid", ""),
                            jsonProperty("Principal", jsonObject(
                                jsonProperty("Service", "grafana.amazonaws.com")
                            ))
                        )))
                    )))
                .build());
    
            var example = new Workspace("example", WorkspaceArgs.builder()        
                .accountAccessType("CURRENT_ACCOUNT")
                .authenticationProviders("SAML")
                .permissionType("SERVICE_MANAGED")
                .roleArn(assume.arn())
                .build());
    
        }
    }
    
    import pulumi
    import json
    import pulumi_aws as aws
    
    assume = aws.iam.Role("assume", assume_role_policy=json.dumps({
        "Version": "2012-10-17",
        "Statement": [{
            "Action": "sts:AssumeRole",
            "Effect": "Allow",
            "Sid": "",
            "Principal": {
                "Service": "grafana.amazonaws.com",
            },
        }],
    }))
    example = aws.grafana.Workspace("example",
        account_access_type="CURRENT_ACCOUNT",
        authentication_providers=["SAML"],
        permission_type="SERVICE_MANAGED",
        role_arn=assume.arn)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const assume = new aws.iam.Role("assume", {assumeRolePolicy: JSON.stringify({
        Version: "2012-10-17",
        Statement: [{
            Action: "sts:AssumeRole",
            Effect: "Allow",
            Sid: "",
            Principal: {
                Service: "grafana.amazonaws.com",
            },
        }],
    })});
    const example = new aws.grafana.Workspace("example", {
        accountAccessType: "CURRENT_ACCOUNT",
        authenticationProviders: ["SAML"],
        permissionType: "SERVICE_MANAGED",
        roleArn: assume.arn,
    });
    
    resources:
      example:
        type: aws:grafana:Workspace
        properties:
          accountAccessType: CURRENT_ACCOUNT
          authenticationProviders:
            - SAML
          permissionType: SERVICE_MANAGED
          roleArn: ${assume.arn}
      assume:
        type: aws:iam:Role
        properties:
          assumeRolePolicy:
            fn::toJSON:
              Version: 2012-10-17
              Statement:
                - Action: sts:AssumeRole
                  Effect: Allow
                  Sid:
                  Principal:
                    Service: grafana.amazonaws.com
    

    Create Workspace Resource

    new Workspace(name: string, args: WorkspaceArgs, opts?: CustomResourceOptions);
    @overload
    def Workspace(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  account_access_type: Optional[str] = None,
                  authentication_providers: Optional[Sequence[str]] = None,
                  configuration: Optional[str] = None,
                  data_sources: Optional[Sequence[str]] = None,
                  description: Optional[str] = None,
                  grafana_version: Optional[str] = None,
                  name: Optional[str] = None,
                  network_access_control: Optional[WorkspaceNetworkAccessControlArgs] = None,
                  notification_destinations: Optional[Sequence[str]] = None,
                  organization_role_name: Optional[str] = None,
                  organizational_units: Optional[Sequence[str]] = None,
                  permission_type: Optional[str] = None,
                  role_arn: Optional[str] = None,
                  stack_set_name: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None,
                  vpc_configuration: Optional[WorkspaceVpcConfigurationArgs] = None)
    @overload
    def Workspace(resource_name: str,
                  args: WorkspaceArgs,
                  opts: Optional[ResourceOptions] = None)
    func NewWorkspace(ctx *Context, name string, args WorkspaceArgs, opts ...ResourceOption) (*Workspace, error)
    public Workspace(string name, WorkspaceArgs args, CustomResourceOptions? opts = null)
    public Workspace(String name, WorkspaceArgs args)
    public Workspace(String name, WorkspaceArgs args, CustomResourceOptions options)
    
    type: aws:grafana:Workspace
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args WorkspaceArgs
    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 WorkspaceArgs
    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 WorkspaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkspaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkspaceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Workspace Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Workspace resource accepts the following input properties:

    AccountAccessType string
    The 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.
    AuthenticationProviders List<string>
    The authentication providers for the workspace. Valid values are AWS_SSO, SAML, or both.
    PermissionType string

    The permission type of the workspace. If SERVICE_MANAGED is specified, the IAM roles and IAM policy attachments are generated automatically. If CUSTOMER_MANAGED is specified, the IAM roles and IAM policy attachments will not be created.

    The following arguments are optional:

    Configuration string
    The configuration string for the workspace that you create. For more information about the format and configuration options available, see Working in your Grafana workspace.
    DataSources List<string>
    The data sources for the workspace. Valid values are AMAZON_OPENSEARCH_SERVICE, ATHENA, CLOUDWATCH, PROMETHEUS, REDSHIFT, SITEWISE, TIMESTREAM, XRAY
    Description string
    The workspace description.
    GrafanaVersion string
    Specifies the version of Grafana to support in the new workspace. Supported values are 8.4 and 9.4. If not specified, defaults to 8.4.
    Name string
    The Grafana workspace name.
    NetworkAccessControl WorkspaceNetworkAccessControl
    Configuration for network access to your workspace.See Network Access Control below.
    NotificationDestinations List<string>
    The notification destinations. If a data source is specified here, Amazon Managed Grafana will create IAM roles and permissions needed to use these destinations. Must be set to SNS.
    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.
    RoleArn string
    The IAM role ARN that the workspace assumes.
    StackSetName string
    The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
    Tags Dictionary<string, string>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    VpcConfiguration WorkspaceVpcConfiguration
    The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. See VPC Configuration below.
    AccountAccessType string
    The 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.
    AuthenticationProviders []string
    The authentication providers for the workspace. Valid values are AWS_SSO, SAML, or both.
    PermissionType string

    The permission type of the workspace. If SERVICE_MANAGED is specified, the IAM roles and IAM policy attachments are generated automatically. If CUSTOMER_MANAGED is specified, the IAM roles and IAM policy attachments will not be created.

    The following arguments are optional:

    Configuration string
    The configuration string for the workspace that you create. For more information about the format and configuration options available, see Working in your Grafana workspace.
    DataSources []string
    The data sources for the workspace. Valid values are AMAZON_OPENSEARCH_SERVICE, ATHENA, CLOUDWATCH, PROMETHEUS, REDSHIFT, SITEWISE, TIMESTREAM, XRAY
    Description string
    The workspace description.
    GrafanaVersion string
    Specifies the version of Grafana to support in the new workspace. Supported values are 8.4 and 9.4. If not specified, defaults to 8.4.
    Name string
    The Grafana workspace name.
    NetworkAccessControl WorkspaceNetworkAccessControlArgs
    Configuration for network access to your workspace.See Network Access Control below.
    NotificationDestinations []string
    The notification destinations. If a data source is specified here, Amazon Managed Grafana will create IAM roles and permissions needed to use these destinations. Must be set to SNS.
    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.
    RoleArn string
    The IAM role ARN that the workspace assumes.
    StackSetName string
    The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
    Tags map[string]string
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    VpcConfiguration WorkspaceVpcConfigurationArgs
    The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. See VPC Configuration below.
    accountAccessType String
    The 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.
    authenticationProviders List<String>
    The authentication providers for the workspace. Valid values are AWS_SSO, SAML, or both.
    permissionType String

    The permission type of the workspace. If SERVICE_MANAGED is specified, the IAM roles and IAM policy attachments are generated automatically. If CUSTOMER_MANAGED is specified, the IAM roles and IAM policy attachments will not be created.

    The following arguments are optional:

    configuration String
    The configuration string for the workspace that you create. For more information about the format and configuration options available, see Working in your Grafana workspace.
    dataSources List<String>
    The data sources for the workspace. Valid values are AMAZON_OPENSEARCH_SERVICE, ATHENA, CLOUDWATCH, PROMETHEUS, REDSHIFT, SITEWISE, TIMESTREAM, XRAY
    description String
    The workspace description.
    grafanaVersion String
    Specifies the version of Grafana to support in the new workspace. Supported values are 8.4 and 9.4. If not specified, defaults to 8.4.
    name String
    The Grafana workspace name.
    networkAccessControl WorkspaceNetworkAccessControl
    Configuration for network access to your workspace.See Network Access Control below.
    notificationDestinations List<String>
    The notification destinations. If a data source is specified here, Amazon Managed Grafana will create IAM roles and permissions needed to use these destinations. Must be set to SNS.
    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.
    roleArn String
    The IAM role ARN that the workspace assumes.
    stackSetName String
    The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
    tags Map<String,String>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    vpcConfiguration WorkspaceVpcConfiguration
    The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. See VPC Configuration below.
    accountAccessType string
    The 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.
    authenticationProviders string[]
    The authentication providers for the workspace. Valid values are AWS_SSO, SAML, or both.
    permissionType string

    The permission type of the workspace. If SERVICE_MANAGED is specified, the IAM roles and IAM policy attachments are generated automatically. If CUSTOMER_MANAGED is specified, the IAM roles and IAM policy attachments will not be created.

    The following arguments are optional:

    configuration string
    The configuration string for the workspace that you create. For more information about the format and configuration options available, see Working in your Grafana workspace.
    dataSources string[]
    The data sources for the workspace. Valid values are AMAZON_OPENSEARCH_SERVICE, ATHENA, CLOUDWATCH, PROMETHEUS, REDSHIFT, SITEWISE, TIMESTREAM, XRAY
    description string
    The workspace description.
    grafanaVersion string
    Specifies the version of Grafana to support in the new workspace. Supported values are 8.4 and 9.4. If not specified, defaults to 8.4.
    name string
    The Grafana workspace name.
    networkAccessControl WorkspaceNetworkAccessControl
    Configuration for network access to your workspace.See Network Access Control below.
    notificationDestinations string[]
    The notification destinations. If a data source is specified here, Amazon Managed Grafana will create IAM roles and permissions needed to use these destinations. Must be set to SNS.
    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.
    roleArn string
    The IAM role ARN that the workspace assumes.
    stackSetName string
    The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
    tags {[key: string]: string}
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    vpcConfiguration WorkspaceVpcConfiguration
    The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. See VPC Configuration below.
    account_access_type str
    The 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.
    authentication_providers Sequence[str]
    The authentication providers for the workspace. Valid values are AWS_SSO, SAML, or both.
    permission_type str

    The permission type of the workspace. If SERVICE_MANAGED is specified, the IAM roles and IAM policy attachments are generated automatically. If CUSTOMER_MANAGED is specified, the IAM roles and IAM policy attachments will not be created.

    The following arguments are optional:

    configuration str
    The configuration string for the workspace that you create. For more information about the format and configuration options available, see Working in your Grafana workspace.
    data_sources Sequence[str]
    The data sources for the workspace. Valid values are AMAZON_OPENSEARCH_SERVICE, ATHENA, CLOUDWATCH, PROMETHEUS, REDSHIFT, SITEWISE, TIMESTREAM, XRAY
    description str
    The workspace description.
    grafana_version str
    Specifies the version of Grafana to support in the new workspace. Supported values are 8.4 and 9.4. If not specified, defaults to 8.4.
    name str
    The Grafana workspace name.
    network_access_control WorkspaceNetworkAccessControlArgs
    Configuration for network access to your workspace.See Network Access Control below.
    notification_destinations Sequence[str]
    The notification destinations. If a data source is specified here, Amazon Managed Grafana will create IAM roles and permissions needed to use these destinations. Must be set to SNS.
    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.
    role_arn str
    The IAM role ARN that the workspace assumes.
    stack_set_name str
    The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
    tags Mapping[str, str]
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    vpc_configuration WorkspaceVpcConfigurationArgs
    The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. See VPC Configuration below.
    accountAccessType String
    The 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.
    authenticationProviders List<String>
    The authentication providers for the workspace. Valid values are AWS_SSO, SAML, or both.
    permissionType String

    The permission type of the workspace. If SERVICE_MANAGED is specified, the IAM roles and IAM policy attachments are generated automatically. If CUSTOMER_MANAGED is specified, the IAM roles and IAM policy attachments will not be created.

    The following arguments are optional:

    configuration String
    The configuration string for the workspace that you create. For more information about the format and configuration options available, see Working in your Grafana workspace.
    dataSources List<String>
    The data sources for the workspace. Valid values are AMAZON_OPENSEARCH_SERVICE, ATHENA, CLOUDWATCH, PROMETHEUS, REDSHIFT, SITEWISE, TIMESTREAM, XRAY
    description String
    The workspace description.
    grafanaVersion String
    Specifies the version of Grafana to support in the new workspace. Supported values are 8.4 and 9.4. If not specified, defaults to 8.4.
    name String
    The Grafana workspace name.
    networkAccessControl Property Map
    Configuration for network access to your workspace.See Network Access Control below.
    notificationDestinations List<String>
    The notification destinations. If a data source is specified here, Amazon Managed Grafana will create IAM roles and permissions needed to use these destinations. Must be set to SNS.
    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.
    roleArn String
    The IAM role ARN that the workspace assumes.
    stackSetName String
    The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
    tags Map<String>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    vpcConfiguration Property Map
    The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. See VPC Configuration below.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Workspace resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) of the Grafana workspace.
    Endpoint string
    The endpoint of the Grafana workspace.
    Id string
    The provider-assigned unique ID for this managed resource.
    SamlConfigurationStatus string
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    Arn string
    The Amazon Resource Name (ARN) of the Grafana workspace.
    Endpoint string
    The endpoint of the Grafana workspace.
    Id string
    The provider-assigned unique ID for this managed resource.
    SamlConfigurationStatus string
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) of the Grafana workspace.
    endpoint String
    The endpoint of the Grafana workspace.
    id String
    The provider-assigned unique ID for this managed resource.
    samlConfigurationStatus String
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    arn string
    The Amazon Resource Name (ARN) of the Grafana workspace.
    endpoint string
    The endpoint of the Grafana workspace.
    id string
    The provider-assigned unique ID for this managed resource.
    samlConfigurationStatus string
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    arn str
    The Amazon Resource Name (ARN) of the Grafana workspace.
    endpoint str
    The endpoint of the Grafana workspace.
    id str
    The provider-assigned unique ID for this managed resource.
    saml_configuration_status str
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) of the Grafana workspace.
    endpoint String
    The endpoint of the Grafana workspace.
    id String
    The provider-assigned unique ID for this managed resource.
    samlConfigurationStatus String
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    Look up Existing Workspace Resource

    Get an existing Workspace resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: WorkspaceState, opts?: CustomResourceOptions): Workspace
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_access_type: Optional[str] = None,
            arn: Optional[str] = None,
            authentication_providers: Optional[Sequence[str]] = None,
            configuration: Optional[str] = None,
            data_sources: Optional[Sequence[str]] = None,
            description: Optional[str] = None,
            endpoint: Optional[str] = None,
            grafana_version: Optional[str] = None,
            name: Optional[str] = None,
            network_access_control: Optional[WorkspaceNetworkAccessControlArgs] = None,
            notification_destinations: Optional[Sequence[str]] = None,
            organization_role_name: Optional[str] = None,
            organizational_units: Optional[Sequence[str]] = None,
            permission_type: Optional[str] = None,
            role_arn: Optional[str] = None,
            saml_configuration_status: Optional[str] = None,
            stack_set_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            vpc_configuration: Optional[WorkspaceVpcConfigurationArgs] = None) -> Workspace
    func GetWorkspace(ctx *Context, name string, id IDInput, state *WorkspaceState, opts ...ResourceOption) (*Workspace, error)
    public static Workspace Get(string name, Input<string> id, WorkspaceState? state, CustomResourceOptions? opts = null)
    public static Workspace get(String name, Output<String> id, WorkspaceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountAccessType string
    The 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
    The Amazon Resource Name (ARN) of the Grafana workspace.
    AuthenticationProviders List<string>
    The authentication providers for the workspace. Valid values are AWS_SSO, SAML, or both.
    Configuration string
    The configuration string for the workspace that you create. For more information about the format and configuration options available, see Working in your Grafana workspace.
    DataSources List<string>
    The data sources for the workspace. Valid values are AMAZON_OPENSEARCH_SERVICE, ATHENA, CLOUDWATCH, PROMETHEUS, REDSHIFT, SITEWISE, TIMESTREAM, XRAY
    Description string
    The workspace description.
    Endpoint string
    The endpoint of the Grafana workspace.
    GrafanaVersion string
    Specifies the version of Grafana to support in the new workspace. Supported values are 8.4 and 9.4. If not specified, defaults to 8.4.
    Name string
    The Grafana workspace name.
    NetworkAccessControl WorkspaceNetworkAccessControl
    Configuration for network access to your workspace.See Network Access Control below.
    NotificationDestinations List<string>
    The notification destinations. If a data source is specified here, Amazon Managed Grafana will create IAM roles and permissions needed to use these destinations. Must be set to SNS.
    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

    The permission type of the workspace. If SERVICE_MANAGED is specified, the IAM roles and IAM policy attachments are generated automatically. If CUSTOMER_MANAGED is specified, the IAM roles and IAM policy attachments will not be created.

    The following arguments are optional:

    RoleArn string
    The IAM role ARN that the workspace assumes.
    SamlConfigurationStatus string
    StackSetName string
    The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
    Tags Dictionary<string, string>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    VpcConfiguration WorkspaceVpcConfiguration
    The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. See VPC Configuration below.
    AccountAccessType string
    The 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
    The Amazon Resource Name (ARN) of the Grafana workspace.
    AuthenticationProviders []string
    The authentication providers for the workspace. Valid values are AWS_SSO, SAML, or both.
    Configuration string
    The configuration string for the workspace that you create. For more information about the format and configuration options available, see Working in your Grafana workspace.
    DataSources []string
    The data sources for the workspace. Valid values are AMAZON_OPENSEARCH_SERVICE, ATHENA, CLOUDWATCH, PROMETHEUS, REDSHIFT, SITEWISE, TIMESTREAM, XRAY
    Description string
    The workspace description.
    Endpoint string
    The endpoint of the Grafana workspace.
    GrafanaVersion string
    Specifies the version of Grafana to support in the new workspace. Supported values are 8.4 and 9.4. If not specified, defaults to 8.4.
    Name string
    The Grafana workspace name.
    NetworkAccessControl WorkspaceNetworkAccessControlArgs
    Configuration for network access to your workspace.See Network Access Control below.
    NotificationDestinations []string
    The notification destinations. If a data source is specified here, Amazon Managed Grafana will create IAM roles and permissions needed to use these destinations. Must be set to SNS.
    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

    The permission type of the workspace. If SERVICE_MANAGED is specified, the IAM roles and IAM policy attachments are generated automatically. If CUSTOMER_MANAGED is specified, the IAM roles and IAM policy attachments will not be created.

    The following arguments are optional:

    RoleArn string
    The IAM role ARN that the workspace assumes.
    SamlConfigurationStatus string
    StackSetName string
    The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
    Tags map[string]string
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    VpcConfiguration WorkspaceVpcConfigurationArgs
    The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. See VPC Configuration below.
    accountAccessType String
    The 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
    The Amazon Resource Name (ARN) of the Grafana workspace.
    authenticationProviders List<String>
    The authentication providers for the workspace. Valid values are AWS_SSO, SAML, or both.
    configuration String
    The configuration string for the workspace that you create. For more information about the format and configuration options available, see Working in your Grafana workspace.
    dataSources List<String>
    The data sources for the workspace. Valid values are AMAZON_OPENSEARCH_SERVICE, ATHENA, CLOUDWATCH, PROMETHEUS, REDSHIFT, SITEWISE, TIMESTREAM, XRAY
    description String
    The workspace description.
    endpoint String
    The endpoint of the Grafana workspace.
    grafanaVersion String
    Specifies the version of Grafana to support in the new workspace. Supported values are 8.4 and 9.4. If not specified, defaults to 8.4.
    name String
    The Grafana workspace name.
    networkAccessControl WorkspaceNetworkAccessControl
    Configuration for network access to your workspace.See Network Access Control below.
    notificationDestinations List<String>
    The notification destinations. If a data source is specified here, Amazon Managed Grafana will create IAM roles and permissions needed to use these destinations. Must be set to SNS.
    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

    The permission type of the workspace. If SERVICE_MANAGED is specified, the IAM roles and IAM policy attachments are generated automatically. If CUSTOMER_MANAGED is specified, the IAM roles and IAM policy attachments will not be created.

    The following arguments are optional:

    roleArn String
    The IAM role ARN that the workspace assumes.
    samlConfigurationStatus String
    stackSetName String
    The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
    tags Map<String,String>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    vpcConfiguration WorkspaceVpcConfiguration
    The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. See VPC Configuration below.
    accountAccessType string
    The 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
    The Amazon Resource Name (ARN) of the Grafana workspace.
    authenticationProviders string[]
    The authentication providers for the workspace. Valid values are AWS_SSO, SAML, or both.
    configuration string
    The configuration string for the workspace that you create. For more information about the format and configuration options available, see Working in your Grafana workspace.
    dataSources string[]
    The data sources for the workspace. Valid values are AMAZON_OPENSEARCH_SERVICE, ATHENA, CLOUDWATCH, PROMETHEUS, REDSHIFT, SITEWISE, TIMESTREAM, XRAY
    description string
    The workspace description.
    endpoint string
    The endpoint of the Grafana workspace.
    grafanaVersion string
    Specifies the version of Grafana to support in the new workspace. Supported values are 8.4 and 9.4. If not specified, defaults to 8.4.
    name string
    The Grafana workspace name.
    networkAccessControl WorkspaceNetworkAccessControl
    Configuration for network access to your workspace.See Network Access Control below.
    notificationDestinations string[]
    The notification destinations. If a data source is specified here, Amazon Managed Grafana will create IAM roles and permissions needed to use these destinations. Must be set to SNS.
    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

    The permission type of the workspace. If SERVICE_MANAGED is specified, the IAM roles and IAM policy attachments are generated automatically. If CUSTOMER_MANAGED is specified, the IAM roles and IAM policy attachments will not be created.

    The following arguments are optional:

    roleArn string
    The IAM role ARN that the workspace assumes.
    samlConfigurationStatus string
    stackSetName string
    The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
    tags {[key: string]: string}
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    vpcConfiguration WorkspaceVpcConfiguration
    The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. See VPC Configuration below.
    account_access_type str
    The 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
    The Amazon Resource Name (ARN) of the Grafana workspace.
    authentication_providers Sequence[str]
    The authentication providers for the workspace. Valid values are AWS_SSO, SAML, or both.
    configuration str
    The configuration string for the workspace that you create. For more information about the format and configuration options available, see Working in your Grafana workspace.
    data_sources Sequence[str]
    The data sources for the workspace. Valid values are AMAZON_OPENSEARCH_SERVICE, ATHENA, CLOUDWATCH, PROMETHEUS, REDSHIFT, SITEWISE, TIMESTREAM, XRAY
    description str
    The workspace description.
    endpoint str
    The endpoint of the Grafana workspace.
    grafana_version str
    Specifies the version of Grafana to support in the new workspace. Supported values are 8.4 and 9.4. If not specified, defaults to 8.4.
    name str
    The Grafana workspace name.
    network_access_control WorkspaceNetworkAccessControlArgs
    Configuration for network access to your workspace.See Network Access Control below.
    notification_destinations Sequence[str]
    The notification destinations. If a data source is specified here, Amazon Managed Grafana will create IAM roles and permissions needed to use these destinations. Must be set to SNS.
    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

    The permission type of the workspace. If SERVICE_MANAGED is specified, the IAM roles and IAM policy attachments are generated automatically. If CUSTOMER_MANAGED is specified, the IAM roles and IAM policy attachments will not be created.

    The following arguments are optional:

    role_arn str
    The IAM role ARN that the workspace assumes.
    saml_configuration_status str
    stack_set_name str
    The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
    tags Mapping[str, str]
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    vpc_configuration WorkspaceVpcConfigurationArgs
    The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. See VPC Configuration below.
    accountAccessType String
    The 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
    The Amazon Resource Name (ARN) of the Grafana workspace.
    authenticationProviders List<String>
    The authentication providers for the workspace. Valid values are AWS_SSO, SAML, or both.
    configuration String
    The configuration string for the workspace that you create. For more information about the format and configuration options available, see Working in your Grafana workspace.
    dataSources List<String>
    The data sources for the workspace. Valid values are AMAZON_OPENSEARCH_SERVICE, ATHENA, CLOUDWATCH, PROMETHEUS, REDSHIFT, SITEWISE, TIMESTREAM, XRAY
    description String
    The workspace description.
    endpoint String
    The endpoint of the Grafana workspace.
    grafanaVersion String
    Specifies the version of Grafana to support in the new workspace. Supported values are 8.4 and 9.4. If not specified, defaults to 8.4.
    name String
    The Grafana workspace name.
    networkAccessControl Property Map
    Configuration for network access to your workspace.See Network Access Control below.
    notificationDestinations List<String>
    The notification destinations. If a data source is specified here, Amazon Managed Grafana will create IAM roles and permissions needed to use these destinations. Must be set to SNS.
    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

    The permission type of the workspace. If SERVICE_MANAGED is specified, the IAM roles and IAM policy attachments are generated automatically. If CUSTOMER_MANAGED is specified, the IAM roles and IAM policy attachments will not be created.

    The following arguments are optional:

    roleArn String
    The IAM role ARN that the workspace assumes.
    samlConfigurationStatus String
    stackSetName String
    The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
    tags Map<String>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    vpcConfiguration Property Map
    The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. See VPC Configuration below.

    Supporting Types

    WorkspaceNetworkAccessControl, WorkspaceNetworkAccessControlArgs

    PrefixListIds List<string>
    An array of prefix list IDs.
    VpceIds List<string>
    An array of Amazon VPC endpoint IDs for the workspace. The only VPC endpoints that can be specified here are interface VPC endpoints for Grafana workspaces (using the com.amazonaws.[region].grafana-workspace service endpoint). Other VPC endpoints will be ignored.
    PrefixListIds []string
    An array of prefix list IDs.
    VpceIds []string
    An array of Amazon VPC endpoint IDs for the workspace. The only VPC endpoints that can be specified here are interface VPC endpoints for Grafana workspaces (using the com.amazonaws.[region].grafana-workspace service endpoint). Other VPC endpoints will be ignored.
    prefixListIds List<String>
    An array of prefix list IDs.
    vpceIds List<String>
    An array of Amazon VPC endpoint IDs for the workspace. The only VPC endpoints that can be specified here are interface VPC endpoints for Grafana workspaces (using the com.amazonaws.[region].grafana-workspace service endpoint). Other VPC endpoints will be ignored.
    prefixListIds string[]
    An array of prefix list IDs.
    vpceIds string[]
    An array of Amazon VPC endpoint IDs for the workspace. The only VPC endpoints that can be specified here are interface VPC endpoints for Grafana workspaces (using the com.amazonaws.[region].grafana-workspace service endpoint). Other VPC endpoints will be ignored.
    prefix_list_ids Sequence[str]
    An array of prefix list IDs.
    vpce_ids Sequence[str]
    An array of Amazon VPC endpoint IDs for the workspace. The only VPC endpoints that can be specified here are interface VPC endpoints for Grafana workspaces (using the com.amazonaws.[region].grafana-workspace service endpoint). Other VPC endpoints will be ignored.
    prefixListIds List<String>
    An array of prefix list IDs.
    vpceIds List<String>
    An array of Amazon VPC endpoint IDs for the workspace. The only VPC endpoints that can be specified here are interface VPC endpoints for Grafana workspaces (using the com.amazonaws.[region].grafana-workspace service endpoint). Other VPC endpoints will be ignored.

    WorkspaceVpcConfiguration, WorkspaceVpcConfigurationArgs

    SecurityGroupIds List<string>
    The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.
    SubnetIds List<string>
    The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
    SecurityGroupIds []string
    The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.
    SubnetIds []string
    The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
    securityGroupIds List<String>
    The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.
    subnetIds List<String>
    The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
    securityGroupIds string[]
    The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.
    subnetIds string[]
    The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
    security_group_ids Sequence[str]
    The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.
    subnet_ids Sequence[str]
    The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
    securityGroupIds List<String>
    The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.
    subnetIds List<String>
    The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.

    Import

    Using pulumi import, import Grafana Workspace using the workspace’s id. For example:

     $ pulumi import aws:grafana/workspace:Workspace example g-2054c75a02
    

    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

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.24.0 published on Tuesday, Feb 27, 2024 by Pulumi