WorkspaceApiKey class

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/v7/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
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_grafana_workspaceapikey" "key" {
  key_name        = "test-key"
  key_role        = "VIEWER"
  seconds_to_live = 3600
  workspace_id    = test.id
}
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.ArrayList;
import java.util.Arrays;
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}

Constructors

WorkspaceApiKey(String name, {WorkspaceApiKeyArgs? args, CustomResourceOptions? options})
Creates a new WorkspaceApiKey. name The Pulumi resource name. args Arguments used to configure this WorkspaceApiKey. The set of arguments for WorkspaceApiKey. options Resource options controlling this resource's behavior.
WorkspaceApiKey.reference(String urn)
Creates a typed reference to an existing WorkspaceApiKey resource.

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
key ↔ Output<String>
The key token in JSON format. Use this value as a bearer token to authenticate HTTP requests to the workspace.
latefinal
keyName ↔ Output<String>
Specifies the name of the API key. Key names must be unique to the workspace.
latefinal
keyRole ↔ Output<String>
Specifies the permission level of the API key. Valid values are VIEWER, EDITOR, or ADMIN.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
secondsToLive ↔ Output<int>
Specifies the time in seconds until the API key expires. Keys can be valid for up to 30 days.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
workspaceId ↔ Output<String>
The ID of the workspace that the API key is valid for.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {WorkspaceApiKeyState? state, CustomResourceOptions? options}) → WorkspaceApiKey
Gets an existing WorkspaceApiKey resource's state with the given name and id.