Try AWS Native preview for resources not in the classic version.
aws.grafana.Workspace
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
Provides an Amazon Managed Grafana workspace resource.
Example Usage
Basic configuration
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const assume = new aws.iam.Role("assume", {
name: "grafana-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,
});
import pulumi
import json
import pulumi_aws as aws
assume = aws.iam.Role("assume",
name="grafana-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)
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{
Name: pulumi.String("grafana-assume"),
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
})
}
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()
{
Name = "grafana-assume",
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 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()
.name("grafana-assume")
.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());
}
}
resources:
example:
type: aws:grafana:Workspace
properties:
accountAccessType: CURRENT_ACCOUNT
authenticationProviders:
- SAML
permissionType: SERVICE_MANAGED
roleArn: ${assume.arn}
assume:
type: aws:iam:Role
properties:
name: grafana-assume
assumeRolePolicy:
fn::toJSON:
Version: 2012-10-17
Statement:
- Action: sts:AssumeRole
Effect: Allow
Sid:
Principal:
Service: grafana.amazonaws.com
Create Workspace Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Workspace(name: string, args: WorkspaceArgs, opts?: CustomResourceOptions);
@overload
def Workspace(resource_name: str,
args: WorkspaceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Workspace(resource_name: str,
opts: Optional[ResourceOptions] = None,
account_access_type: Optional[str] = None,
authentication_providers: Optional[Sequence[str]] = None,
permission_type: Optional[str] = None,
notification_destinations: Optional[Sequence[str]] = None,
description: Optional[str] = None,
grafana_version: Optional[str] = None,
name: Optional[str] = None,
network_access_control: Optional[WorkspaceNetworkAccessControlArgs] = None,
data_sources: Optional[Sequence[str]] = None,
organization_role_name: Optional[str] = None,
organizational_units: Optional[Sequence[str]] = None,
configuration: 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)
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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var awsWorkspaceResource = new Aws.Grafana.Workspace("awsWorkspaceResource", new()
{
AccountAccessType = "string",
AuthenticationProviders = new[]
{
"string",
},
PermissionType = "string",
NotificationDestinations = new[]
{
"string",
},
Description = "string",
GrafanaVersion = "string",
Name = "string",
NetworkAccessControl = new Aws.Grafana.Inputs.WorkspaceNetworkAccessControlArgs
{
PrefixListIds = new[]
{
"string",
},
VpceIds = new[]
{
"string",
},
},
DataSources = new[]
{
"string",
},
OrganizationRoleName = "string",
OrganizationalUnits = new[]
{
"string",
},
Configuration = "string",
RoleArn = "string",
StackSetName = "string",
Tags =
{
{ "string", "string" },
},
VpcConfiguration = new Aws.Grafana.Inputs.WorkspaceVpcConfigurationArgs
{
SecurityGroupIds = new[]
{
"string",
},
SubnetIds = new[]
{
"string",
},
},
});
example, err := grafana.NewWorkspace(ctx, "awsWorkspaceResource", &grafana.WorkspaceArgs{
AccountAccessType: pulumi.String("string"),
AuthenticationProviders: pulumi.StringArray{
pulumi.String("string"),
},
PermissionType: pulumi.String("string"),
NotificationDestinations: pulumi.StringArray{
pulumi.String("string"),
},
Description: pulumi.String("string"),
GrafanaVersion: pulumi.String("string"),
Name: pulumi.String("string"),
NetworkAccessControl: &grafana.WorkspaceNetworkAccessControlArgs{
PrefixListIds: pulumi.StringArray{
pulumi.String("string"),
},
VpceIds: pulumi.StringArray{
pulumi.String("string"),
},
},
DataSources: pulumi.StringArray{
pulumi.String("string"),
},
OrganizationRoleName: pulumi.String("string"),
OrganizationalUnits: pulumi.StringArray{
pulumi.String("string"),
},
Configuration: pulumi.String("string"),
RoleArn: pulumi.String("string"),
StackSetName: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
VpcConfiguration: &grafana.WorkspaceVpcConfigurationArgs{
SecurityGroupIds: pulumi.StringArray{
pulumi.String("string"),
},
SubnetIds: pulumi.StringArray{
pulumi.String("string"),
},
},
})
var awsWorkspaceResource = new Workspace("awsWorkspaceResource", WorkspaceArgs.builder()
.accountAccessType("string")
.authenticationProviders("string")
.permissionType("string")
.notificationDestinations("string")
.description("string")
.grafanaVersion("string")
.name("string")
.networkAccessControl(WorkspaceNetworkAccessControlArgs.builder()
.prefixListIds("string")
.vpceIds("string")
.build())
.dataSources("string")
.organizationRoleName("string")
.organizationalUnits("string")
.configuration("string")
.roleArn("string")
.stackSetName("string")
.tags(Map.of("string", "string"))
.vpcConfiguration(WorkspaceVpcConfigurationArgs.builder()
.securityGroupIds("string")
.subnetIds("string")
.build())
.build());
aws_workspace_resource = aws.grafana.Workspace("awsWorkspaceResource",
account_access_type="string",
authentication_providers=["string"],
permission_type="string",
notification_destinations=["string"],
description="string",
grafana_version="string",
name="string",
network_access_control={
"prefixListIds": ["string"],
"vpceIds": ["string"],
},
data_sources=["string"],
organization_role_name="string",
organizational_units=["string"],
configuration="string",
role_arn="string",
stack_set_name="string",
tags={
"string": "string",
},
vpc_configuration={
"securityGroupIds": ["string"],
"subnetIds": ["string"],
})
const awsWorkspaceResource = new aws.grafana.Workspace("awsWorkspaceResource", {
accountAccessType: "string",
authenticationProviders: ["string"],
permissionType: "string",
notificationDestinations: ["string"],
description: "string",
grafanaVersion: "string",
name: "string",
networkAccessControl: {
prefixListIds: ["string"],
vpceIds: ["string"],
},
dataSources: ["string"],
organizationRoleName: "string",
organizationalUnits: ["string"],
configuration: "string",
roleArn: "string",
stackSetName: "string",
tags: {
string: "string",
},
vpcConfiguration: {
securityGroupIds: ["string"],
subnetIds: ["string"],
},
});
type: aws:grafana:Workspace
properties:
accountAccessType: string
authenticationProviders:
- string
configuration: string
dataSources:
- string
description: string
grafanaVersion: string
name: string
networkAccessControl:
prefixListIds:
- string
vpceIds:
- string
notificationDestinations:
- string
organizationRoleName: string
organizationalUnits:
- string
permissionType: string
roleArn: string
stackSetName: string
tags:
string: string
vpcConfiguration:
securityGroupIds:
- string
subnetIds:
- string
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:
- Account
Access stringType - The type of account access for the workspace. Valid values are
CURRENT_ACCOUNT
andORGANIZATION
. IfORGANIZATION
is specified, thenorganizational_units
must also be present. - Authentication
Providers List<string> - The authentication providers for the workspace. Valid values are
AWS_SSO
,SAML
, or both. - Permission
Type string The permission type of the workspace. If
SERVICE_MANAGED
is specified, the IAM roles and IAM policy attachments are generated automatically. IfCUSTOMER_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.
- Data
Sources 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.
- string
- Specifies the version of Grafana to support in the new workspace. Supported values are
8.4
,9.4
and10.4
. If not specified, defaults to9.4
. - Name string
- The Grafana workspace name.
- Network
Access WorkspaceControl Network Access Control - Configuration for network access to your workspace.See Network Access Control below.
- Notification
Destinations 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
. - Organization
Role stringName - The role name that the workspace uses to access resources through Amazon Organizations.
- Organizational
Units List<string> - The Amazon Organizations organizational units that the workspace is authorized to use data sources from.
- Role
Arn string - The IAM role ARN that the workspace assumes.
- Stack
Set stringName - The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
- 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 - Vpc
Configuration WorkspaceVpc Configuration - The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. See VPC Configuration below.
- Account
Access stringType - The type of account access for the workspace. Valid values are
CURRENT_ACCOUNT
andORGANIZATION
. IfORGANIZATION
is specified, thenorganizational_units
must also be present. - Authentication
Providers []string - The authentication providers for the workspace. Valid values are
AWS_SSO
,SAML
, or both. - Permission
Type string The permission type of the workspace. If
SERVICE_MANAGED
is specified, the IAM roles and IAM policy attachments are generated automatically. IfCUSTOMER_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.
- Data
Sources []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.
- string
- Specifies the version of Grafana to support in the new workspace. Supported values are
8.4
,9.4
and10.4
. If not specified, defaults to9.4
. - Name string
- The Grafana workspace name.
- Network
Access WorkspaceControl Network Access Control Args - Configuration for network access to your workspace.See Network Access Control below.
- Notification
Destinations []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
. - Organization
Role stringName - The role name that the workspace uses to access resources through Amazon Organizations.
- Organizational
Units []string - The Amazon Organizations organizational units that the workspace is authorized to use data sources from.
- Role
Arn string - The IAM role ARN that the workspace assumes.
- Stack
Set stringName - The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
- 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 - Vpc
Configuration WorkspaceVpc Configuration Args - The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. See VPC Configuration below.
- account
Access StringType - The type of account access for the workspace. Valid values are
CURRENT_ACCOUNT
andORGANIZATION
. IfORGANIZATION
is specified, thenorganizational_units
must also be present. - authentication
Providers List<String> - The authentication providers for the workspace. Valid values are
AWS_SSO
,SAML
, or both. - permission
Type String The permission type of the workspace. If
SERVICE_MANAGED
is specified, the IAM roles and IAM policy attachments are generated automatically. IfCUSTOMER_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.
- data
Sources 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.
- String
- Specifies the version of Grafana to support in the new workspace. Supported values are
8.4
,9.4
and10.4
. If not specified, defaults to9.4
. - name String
- The Grafana workspace name.
- network
Access WorkspaceControl Network Access Control - Configuration for network access to your workspace.See Network Access Control below.
- notification
Destinations 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
. - organization
Role StringName - The role name that the workspace uses to access resources through Amazon Organizations.
- organizational
Units List<String> - The Amazon Organizations organizational units that the workspace is authorized to use data sources from.
- role
Arn String - The IAM role ARN that the workspace assumes.
- stack
Set StringName - The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
- 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 - vpc
Configuration WorkspaceVpc Configuration - The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. See VPC Configuration below.
- account
Access stringType - The type of account access for the workspace. Valid values are
CURRENT_ACCOUNT
andORGANIZATION
. IfORGANIZATION
is specified, thenorganizational_units
must also be present. - authentication
Providers string[] - The authentication providers for the workspace. Valid values are
AWS_SSO
,SAML
, or both. - permission
Type string The permission type of the workspace. If
SERVICE_MANAGED
is specified, the IAM roles and IAM policy attachments are generated automatically. IfCUSTOMER_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.
- data
Sources 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.
- string
- Specifies the version of Grafana to support in the new workspace. Supported values are
8.4
,9.4
and10.4
. If not specified, defaults to9.4
. - name string
- The Grafana workspace name.
- network
Access WorkspaceControl Network Access Control - Configuration for network access to your workspace.See Network Access Control below.
- notification
Destinations 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
. - organization
Role stringName - The role name that the workspace uses to access resources through Amazon Organizations.
- organizational
Units string[] - The Amazon Organizations organizational units that the workspace is authorized to use data sources from.
- role
Arn string - The IAM role ARN that the workspace assumes.
- stack
Set stringName - The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
- {[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 - vpc
Configuration WorkspaceVpc Configuration - The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. See VPC Configuration below.
- account_
access_ strtype - The type of account access for the workspace. Valid values are
CURRENT_ACCOUNT
andORGANIZATION
. IfORGANIZATION
is specified, thenorganizational_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. IfCUSTOMER_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
,9.4
and10.4
. If not specified, defaults to9.4
. - name str
- The Grafana workspace name.
- network_
access_ Workspacecontrol Network Access Control Args - 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_ strname - 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_ strname - The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
- 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 WorkspaceVpc Configuration Args - The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. See VPC Configuration below.
- account
Access StringType - The type of account access for the workspace. Valid values are
CURRENT_ACCOUNT
andORGANIZATION
. IfORGANIZATION
is specified, thenorganizational_units
must also be present. - authentication
Providers List<String> - The authentication providers for the workspace. Valid values are
AWS_SSO
,SAML
, or both. - permission
Type String The permission type of the workspace. If
SERVICE_MANAGED
is specified, the IAM roles and IAM policy attachments are generated automatically. IfCUSTOMER_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.
- data
Sources 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.
- String
- Specifies the version of Grafana to support in the new workspace. Supported values are
8.4
,9.4
and10.4
. If not specified, defaults to9.4
. - name String
- The Grafana workspace name.
- network
Access Property MapControl - Configuration for network access to your workspace.See Network Access Control below.
- notification
Destinations 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
. - organization
Role StringName - The role name that the workspace uses to access resources through Amazon Organizations.
- organizational
Units List<String> - The Amazon Organizations organizational units that the workspace is authorized to use data sources from.
- role
Arn String - The IAM role ARN that the workspace assumes.
- stack
Set StringName - The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
- 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 - vpc
Configuration 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.
- Saml
Configuration stringStatus - Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- 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.
- Saml
Configuration stringStatus - map[string]string
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- 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.
- saml
Configuration StringStatus - Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- 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.
- saml
Configuration stringStatus - {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- 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_ strstatus - Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- 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.
- saml
Configuration StringStatus - Map<String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
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.
- Account
Access stringType - The type of account access for the workspace. Valid values are
CURRENT_ACCOUNT
andORGANIZATION
. IfORGANIZATION
is specified, thenorganizational_units
must also be present. - Arn string
- The Amazon Resource Name (ARN) of the Grafana workspace.
- Authentication
Providers 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.
- Data
Sources 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.
- string
- Specifies the version of Grafana to support in the new workspace. Supported values are
8.4
,9.4
and10.4
. If not specified, defaults to9.4
. - Name string
- The Grafana workspace name.
- Network
Access WorkspaceControl Network Access Control - Configuration for network access to your workspace.See Network Access Control below.
- Notification
Destinations 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
. - Organization
Role stringName - The role name that the workspace uses to access resources through Amazon Organizations.
- Organizational
Units List<string> - The Amazon Organizations organizational units that the workspace is authorized to use data sources from.
- Permission
Type string The permission type of the workspace. If
SERVICE_MANAGED
is specified, the IAM roles and IAM policy attachments are generated automatically. IfCUSTOMER_MANAGED
is specified, the IAM roles and IAM policy attachments will not be created.The following arguments are optional:
- Role
Arn string - The IAM role ARN that the workspace assumes.
- Saml
Configuration stringStatus - Stack
Set stringName - The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
- 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 - Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Vpc
Configuration WorkspaceVpc Configuration - The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. See VPC Configuration below.
- Account
Access stringType - The type of account access for the workspace. Valid values are
CURRENT_ACCOUNT
andORGANIZATION
. IfORGANIZATION
is specified, thenorganizational_units
must also be present. - Arn string
- The Amazon Resource Name (ARN) of the Grafana workspace.
- Authentication
Providers []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.
- Data
Sources []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.
- string
- Specifies the version of Grafana to support in the new workspace. Supported values are
8.4
,9.4
and10.4
. If not specified, defaults to9.4
. - Name string
- The Grafana workspace name.
- Network
Access WorkspaceControl Network Access Control Args - Configuration for network access to your workspace.See Network Access Control below.
- Notification
Destinations []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
. - Organization
Role stringName - The role name that the workspace uses to access resources through Amazon Organizations.
- Organizational
Units []string - The Amazon Organizations organizational units that the workspace is authorized to use data sources from.
- Permission
Type string The permission type of the workspace. If
SERVICE_MANAGED
is specified, the IAM roles and IAM policy attachments are generated automatically. IfCUSTOMER_MANAGED
is specified, the IAM roles and IAM policy attachments will not be created.The following arguments are optional:
- Role
Arn string - The IAM role ARN that the workspace assumes.
- Saml
Configuration stringStatus - Stack
Set stringName - The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
- 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 - map[string]string
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Vpc
Configuration WorkspaceVpc Configuration Args - The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. See VPC Configuration below.
- account
Access StringType - The type of account access for the workspace. Valid values are
CURRENT_ACCOUNT
andORGANIZATION
. IfORGANIZATION
is specified, thenorganizational_units
must also be present. - arn String
- The Amazon Resource Name (ARN) of the Grafana workspace.
- authentication
Providers 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.
- data
Sources 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.
- String
- Specifies the version of Grafana to support in the new workspace. Supported values are
8.4
,9.4
and10.4
. If not specified, defaults to9.4
. - name String
- The Grafana workspace name.
- network
Access WorkspaceControl Network Access Control - Configuration for network access to your workspace.See Network Access Control below.
- notification
Destinations 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
. - organization
Role StringName - The role name that the workspace uses to access resources through Amazon Organizations.
- organizational
Units List<String> - The Amazon Organizations organizational units that the workspace is authorized to use data sources from.
- permission
Type String The permission type of the workspace. If
SERVICE_MANAGED
is specified, the IAM roles and IAM policy attachments are generated automatically. IfCUSTOMER_MANAGED
is specified, the IAM roles and IAM policy attachments will not be created.The following arguments are optional:
- role
Arn String - The IAM role ARN that the workspace assumes.
- saml
Configuration StringStatus - stack
Set StringName - The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
- 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 - Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - vpc
Configuration WorkspaceVpc Configuration - The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. See VPC Configuration below.
- account
Access stringType - The type of account access for the workspace. Valid values are
CURRENT_ACCOUNT
andORGANIZATION
. IfORGANIZATION
is specified, thenorganizational_units
must also be present. - arn string
- The Amazon Resource Name (ARN) of the Grafana workspace.
- authentication
Providers 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.
- data
Sources 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.
- string
- Specifies the version of Grafana to support in the new workspace. Supported values are
8.4
,9.4
and10.4
. If not specified, defaults to9.4
. - name string
- The Grafana workspace name.
- network
Access WorkspaceControl Network Access Control - Configuration for network access to your workspace.See Network Access Control below.
- notification
Destinations 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
. - organization
Role stringName - The role name that the workspace uses to access resources through Amazon Organizations.
- organizational
Units string[] - The Amazon Organizations organizational units that the workspace is authorized to use data sources from.
- permission
Type string The permission type of the workspace. If
SERVICE_MANAGED
is specified, the IAM roles and IAM policy attachments are generated automatically. IfCUSTOMER_MANAGED
is specified, the IAM roles and IAM policy attachments will not be created.The following arguments are optional:
- role
Arn string - The IAM role ARN that the workspace assumes.
- saml
Configuration stringStatus - stack
Set stringName - The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
- {[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 - {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - vpc
Configuration WorkspaceVpc Configuration - The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. See VPC Configuration below.
- account_
access_ strtype - The type of account access for the workspace. Valid values are
CURRENT_ACCOUNT
andORGANIZATION
. IfORGANIZATION
is specified, thenorganizational_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
,9.4
and10.4
. If not specified, defaults to9.4
. - name str
- The Grafana workspace name.
- network_
access_ Workspacecontrol Network Access Control Args - 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_ strname - 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. IfCUSTOMER_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_ strstatus - stack_
set_ strname - The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
- 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 - Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - vpc_
configuration WorkspaceVpc Configuration Args - The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. See VPC Configuration below.
- account
Access StringType - The type of account access for the workspace. Valid values are
CURRENT_ACCOUNT
andORGANIZATION
. IfORGANIZATION
is specified, thenorganizational_units
must also be present. - arn String
- The Amazon Resource Name (ARN) of the Grafana workspace.
- authentication
Providers 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.
- data
Sources 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.
- String
- Specifies the version of Grafana to support in the new workspace. Supported values are
8.4
,9.4
and10.4
. If not specified, defaults to9.4
. - name String
- The Grafana workspace name.
- network
Access Property MapControl - Configuration for network access to your workspace.See Network Access Control below.
- notification
Destinations 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
. - organization
Role StringName - The role name that the workspace uses to access resources through Amazon Organizations.
- organizational
Units List<String> - The Amazon Organizations organizational units that the workspace is authorized to use data sources from.
- permission
Type String The permission type of the workspace. If
SERVICE_MANAGED
is specified, the IAM roles and IAM policy attachments are generated automatically. IfCUSTOMER_MANAGED
is specified, the IAM roles and IAM policy attachments will not be created.The following arguments are optional:
- role
Arn String - The IAM role ARN that the workspace assumes.
- saml
Configuration StringStatus - stack
Set StringName - The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
- 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 - Map<String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - vpc
Configuration 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
- Prefix
List List<string>Ids - An array of prefix list IDs.
- Vpce
Ids 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.
- Prefix
List []stringIds - An array of prefix list IDs.
- Vpce
Ids []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 List<String>Ids - An array of prefix list IDs.
- vpce
Ids 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.
- prefix
List string[]Ids - An array of prefix list IDs.
- vpce
Ids 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_ Sequence[str]ids - 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.
- prefix
List List<String>Ids - An array of prefix list IDs.
- vpce
Ids 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
- Security
Group List<string>Ids - The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.
- Subnet
Ids List<string> - The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
- Security
Group []stringIds - The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.
- Subnet
Ids []string - The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
- security
Group List<String>Ids - The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.
- subnet
Ids List<String> - The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
- security
Group string[]Ids - The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.
- subnet
Ids string[] - The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
- security_
group_ Sequence[str]ids - 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.
- security
Group List<String>Ids - The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.
- subnet
Ids 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
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.
Try AWS Native preview for resources not in the classic version.