Skip to content

The CreateRuleGroupsNamespace operation creates a rule groups namespace within a workspace

Description

The create_rule_groups_namespace operation creates a rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.

The combined length of a rule group namespace and a rule group name cannot exceed 721 UTF-8 bytes.

Use this operation only to create new rule groups namespaces. To update an existing rule groups namespace, use put_rule_groups_namespace.

Usage

prometheusservice_create_rule_groups_namespace(workspaceId, name, data,
  clientToken, tags)

Arguments

  • workspaceId

    [required] The ID of the workspace to add the rule groups namespace.

  • name

    [required] The name for the new rule groups namespace.

  • data

    [required] The rules file to use in the new namespace.

    Contains the base64-encoded version of the YAML rules file.

    For details about the rule groups namespace structure, see RuleGroupsNamespaceData.

  • clientToken

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

  • tags

    The list of tag keys and values to associate with the rule groups namespace.

Value

A list with the following syntax:

list(
  name = "string",
  arn = "string",
  status = list(
    statusCode = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|"CREATION_FAILED"|"UPDATE_FAILED",
    statusReason = "string"
  ),
  tags = list(
    "string"
  )
)

Request syntax

svc$create_rule_groups_namespace(
  workspaceId = "string",
  name = "string",
  data = raw,
  clientToken = "string",
  tags = list(
    "string"
  )
)