pulumi-aws-kotlin/com.pulumi.aws.grafana.kotlin/Workspace

Workspace

class Workspace : KotlinCustomResource

Provides an Amazon Managed Grafana workspace resource.

Example Usage

Basic configuration

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

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

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

Properties

accountAccessType

val accountAccessType: Output<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

val arn: Output<String>

The Amazon Resource Name (ARN) of the Grafana workspace.

authenticationProviders

val authenticationProviders: Output<List<String>>

The authentication providers for the workspace. Valid values are AWS_SSO, SAML, or both.

configuration

val configuration: Output<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

val dataSources: Output<List<String>>?

The data sources for the workspace. Valid values are AMAZON_OPENSEARCH_SERVICE, ATHENA, CLOUDWATCH, PROMETHEUS, REDSHIFT, SITEWISE, TIMESTREAM, XRAY

description

val description: Output<String>?

The workspace description.

endpoint

val endpoint: Output<String>

The endpoint of the Grafana workspace.

grafanaVersion

val grafanaVersion: Output<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.

val id: Output<String>

name

val name: Output<String>

The Grafana workspace name.

networkAccessControl

val networkAccessControl: Output<WorkspaceNetworkAccessControl>?

Configuration for network access to your workspace.See Network Access Control below.

notificationDestinations

val notificationDestinations: Output<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.

organizationalUnits

val organizationalUnits: Output<List<String>>?

The Amazon Organizations organizational units that the workspace is authorized to use data sources from.

organizationRoleName

val organizationRoleName: Output<String>?

The role name that the workspace uses to access resources through Amazon Organizations.

permissionType

val permissionType: Output<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:

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

roleArn

val roleArn: Output<String>?

The IAM role ARN that the workspace assumes.

samlConfigurationStatus

val samlConfigurationStatus: Output<String>

stackSetName

val stackSetName: Output<String>?

The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.