Create Workspace

managedgrafana_create_workspace

R Documentation

Creates a workspace

Description

Creates a workspace. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces. You don't have to build, package, or deploy any hardware to run the Grafana server.

Don't use create_workspace to modify an existing workspace. Instead, use update_workspace.

Usage

managedgrafana_create_workspace(accountAccessType,
  authenticationProviders, clientToken, configuration, grafanaVersion,
  networkAccessControl, organizationRoleName, permissionType,
  stackSetName, tags, vpcConfiguration, workspaceDataSources,
  workspaceDescription, workspaceName, workspaceNotificationDestinations,
  workspaceOrganizationalUnits, workspaceRoleArn)

Arguments

accountAccessType

[required] Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account only, or whether it can also access Amazon Web Services resources in other accounts in the same organization. If you specify ORGANIZATION, you must specify which organizational units the workspace can access in the workspaceOrganizationalUnits parameter.

authenticationProviders

[required] Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.

clientToken

A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

configuration

The configuration string for the workspace that you create. For more information about the format and configuration options available, see Working in your Grafana workspace.

grafanaVersion

Specifies the version of Grafana to support in the new workspace. If not specified, defaults to the latest version (for example, 10.4).

To get a list of supported versions, use the list_versions operation.

networkAccessControl

Configuration for network access to your workspace.

When this is configured, only listed IP addresses and VPC endpoints will be able to access your workspace. Standard Grafana authentication and authorization will still be required.

If this is not configured, or is removed, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.

organizationRoleName

The name of an IAM role that already exists to use with Organizations to access Amazon Web Services data sources and notification channels in other accounts in an organization.

permissionType

[required] When creating a workspace through the Amazon Web Services API, CLI or Amazon Web Services CloudFormation, you must manage IAM roles and provision the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.

You must also specify a workspaceRoleArn for a role that you will manage for the workspace to use when accessing those datasources and notification channels.

The ability for Amazon Managed Grafana to create and update IAM roles on behalf of the user is supported only in the Amazon Managed Grafana console, where this value may be set to SERVICE_MANAGED.

Use only the CUSTOMER_MANAGED permission type when creating a workspace with the API, CLI or Amazon Web Services CloudFormation.

For more information, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels.

stackSetName

The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.

tags

The list of tags associated with the workspace.

vpcConfiguration

The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.

Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2).

workspaceDataSources

This parameter is for internal use only, and should not be used.

workspaceDescription

A description for the workspace. This is used only to help you identify this workspace.

Pattern: ⁠^[\\p{L}\\p{Z}\\p{N}\\p{P}]{0,2048}$⁠

workspaceName

The name for the workspace. It does not have to be unique.

workspaceNotificationDestinations

Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to use these channels.

workspaceOrganizationalUnits

Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.

workspaceRoleArn

Specified the IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from, including both data sources and notification channels. You are responsible for managing the permissions for this role as new data sources or notification channels are added.

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$create_workspace(
  accountAccessType = "CURRENT_ACCOUNT"|"ORGANIZATION",
  authenticationProviders = list(
    "AWS_SSO"|"SAML"
  ),
  clientToken = "string",
  configuration = "string",
  grafanaVersion = "string",
  networkAccessControl = list(
    prefixListIds = list(
      "string"
    ),
    vpceIds = list(
      "string"
    )
  ),
  organizationRoleName = "string",
  permissionType = "CUSTOMER_MANAGED"|"SERVICE_MANAGED",
  stackSetName = "string",
  tags = list(
    "string"
  ),
  vpcConfiguration = list(
    securityGroupIds = list(
      "string"
    ),
    subnetIds = list(
      "string"
    )
  ),
  workspaceDataSources = list(
    "AMAZON_OPENSEARCH_SERVICE"|"CLOUDWATCH"|"PROMETHEUS"|"XRAY"|"TIMESTREAM"|"SITEWISE"|"ATHENA"|"REDSHIFT"|"TWINMAKER"
  ),
  workspaceDescription = "string",
  workspaceName = "string",
  workspaceNotificationDestinations = list(
    "SNS"
  ),
  workspaceOrganizationalUnits = list(
    "string"
  ),
  workspaceRoleArn = "string"
)