WorkspaceApiKey

class WorkspaceApiKey : KotlinCustomResource

Provides an Amazon Managed Grafana workspace API Key resource.

Example Usage

Basic configuration

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const key = new aws.grafana.WorkspaceApiKey("key", {
keyName: "test-key",
keyRole: "VIEWER",
secondsToLive: 3600,
workspaceId: test.id,
});
import pulumi
import pulumi_aws as aws
key = aws.grafana.WorkspaceApiKey("key",
key_name="test-key",
key_role="VIEWER",
seconds_to_live=3600,
workspace_id=test["id"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var key = new Aws.Grafana.WorkspaceApiKey("key", new()
{
KeyName = "test-key",
KeyRole = "VIEWER",
SecondsToLive = 3600,
WorkspaceId = test.Id,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/grafana"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := grafana.NewWorkspaceApiKey(ctx, "key", &grafana.WorkspaceApiKeyArgs{
KeyName: pulumi.String("test-key"),
KeyRole: pulumi.String("VIEWER"),
SecondsToLive: pulumi.Int(3600),
WorkspaceId: pulumi.Any(test.Id),
})
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.grafana.WorkspaceApiKey;
import com.pulumi.aws.grafana.WorkspaceApiKeyArgs;
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 key = new WorkspaceApiKey("key", WorkspaceApiKeyArgs.builder()
.keyName("test-key")
.keyRole("VIEWER")
.secondsToLive(3600)
.workspaceId(test.id())
.build());
}
}
resources:
key:
type: aws:grafana:WorkspaceApiKey
properties:
keyName: test-key
keyRole: VIEWER
secondsToLive: 3600
workspaceId: ${test.id}

Properties

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val key: Output<String>

The key token in JSON format. Use this value as a bearer token to authenticate HTTP requests to the workspace.

Link copied to clipboard
val keyName: Output<String>

Specifies the name of the API key. Key names must be unique to the workspace.

Link copied to clipboard
val keyRole: Output<String>

Specifies the permission level of the API key. Valid values are VIEWER, EDITOR, or ADMIN.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val secondsToLive: Output<Int>

Specifies the time in seconds until the API key expires. Keys can be valid for up to 30 days.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val workspaceId: Output<String>

The ID of the workspace that the API key is valid for.