Associate License

managedgrafana_associate_license

R Documentation

Assigns a Grafana Enterprise license to a workspace

Description

Assigns a Grafana Enterprise license to a workspace. To upgrade, you must use ENTERPRISE for the licenseType, and pass in a valid Grafana Labs token for the grafanaToken. Upgrading to Grafana Enterprise incurs additional fees. For more information, see Upgrade a workspace to Grafana Enterprise.

Usage

managedgrafana_associate_license(grafanaToken, licenseType, workspaceId)

Arguments

grafanaToken

A token from Grafana Labs that ties your Amazon Web Services account with a Grafana Labs account. For more information, see Link your account with Grafana Labs.

licenseType

[required] The type of license to associate with the workspace.

Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

workspaceId

[required] The ID of the workspace to associate the license with.

Value

A list with the following syntax:

list(
  workspace = list(
    accountAccessType = "CURRENT_ACCOUNT"|"ORGANIZATION",
    authentication = list(
      providers = list(
        "AWS_SSO"|"SAML"
      ),
      samlConfigurationStatus = "CONFIGURED"|"NOT_CONFIGURED"
    ),
    created = as.POSIXct(
      "2015-01-01"
    ),
    dataSources = list(
      "AMAZON_OPENSEARCH_SERVICE"|"CLOUDWATCH"|"PROMETHEUS"|"XRAY"|"TIMESTREAM"|"SITEWISE"|"ATHENA"|"REDSHIFT"|"TWINMAKER"
    ),
    description = "string",
    endpoint = "string",
    freeTrialConsumed = TRUE|FALSE,
    freeTrialExpiration = as.POSIXct(
      "2015-01-01"
    ),
    grafanaToken = "string",
    grafanaVersion = "string",
    id = "string",
    licenseExpiration = as.POSIXct(
      "2015-01-01"
    ),
    licenseType = "ENTERPRISE"|"ENTERPRISE_FREE_TRIAL",
    modified = as.POSIXct(
      "2015-01-01"
    ),
    name = "string",
    networkAccessControl = list(
      prefixListIds = list(
        "string"
      ),
      vpceIds = list(
        "string"
      )
    ),
    notificationDestinations = list(
      "SNS"
    ),
    organizationRoleName = "string",
    organizationalUnits = list(
      "string"
    ),
    permissionType = "CUSTOMER_MANAGED"|"SERVICE_MANAGED",
    stackSetName = "string",
    status = "ACTIVE"|"CREATING"|"DELETING"|"FAILED"|"UPDATING"|"UPGRADING"|"DELETION_FAILED"|"CREATION_FAILED"|"UPDATE_FAILED"|"UPGRADE_FAILED"|"LICENSE_REMOVAL_FAILED"|"VERSION_UPDATING"|"VERSION_UPDATE_FAILED",
    tags = list(
      "string"
    ),
    vpcConfiguration = list(
      securityGroupIds = list(
        "string"
      ),
      subnetIds = list(
        "string"
      )
    ),
    workspaceRoleArn = "string"
  )
)

Request syntax

svc$associate_license(
  grafanaToken = "string",
  licenseType = "ENTERPRISE"|"ENTERPRISE_FREE_TRIAL",
  workspaceId = "string"
)