Skip to content

Create Workspace

prometheusservice_create_workspace R Documentation

Creates a Prometheus workspace

Description

Creates a Prometheus workspace. A workspace is a logical space dedicated to the storage and querying of Prometheus metrics. You can have one or more workspaces in each Region in your account.

Usage

prometheusservice_create_workspace(alias, clientToken, kmsKeyArn, tags)

Arguments

alias

An alias that you assign to this workspace to help you identify it. It does not need to be unique.

Blank spaces at the beginning or end of the alias that you specify will be trimmed from the value used.

clientToken

A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

kmsKeyArn

(optional) The ARN for a customer managed KMS key to use for encrypting data within your workspace. For more information about using your own key in your workspace, see Encryption at rest in the Amazon Managed Service for Prometheus User Guide.

tags

The list of tag keys and values to associate with the workspace.

Value

A list with the following syntax: 

list(
  arn = "string",
  kmsKeyArn = "string",
  status = list(
    statusCode = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|"CREATION_FAILED"
  ),
  tags = list(
    "string"
  ),
  workspaceId = "string"
)

Request syntax

svc$create_workspace(
  alias = "string",
  clientToken = "string",
  kmsKeyArn = "string",
  tags = list(
    "string"
  )
)