Skip to content

Update Workspace

managedgrafana_update_workspace R Documentation

Modifies an existing Amazon Managed Grafana workspace

Description

Modifies an existing Amazon Managed Grafana workspace. If you use this operation and omit any optional parameters, the existing values of those parameters are not changed.

To modify the user authentication methods that the workspace uses, such as SAML or IAM Identity Center, use update_workspace_authentication.

To modify which users in the workspace have the Admin and Editor Grafana roles, use update_permissions.

Usage

managedgrafana_update_workspace(accountAccessType, networkAccessControl,
  organizationRoleName, permissionType, removeNetworkAccessConfiguration,
  removeVpcConfiguration, stackSetName, vpcConfiguration,
  workspaceDataSources, workspaceDescription, workspaceId, workspaceName,
  workspaceNotificationDestinations, workspaceOrganizationalUnits,
  workspaceRoleArn)

Arguments

accountAccessType

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.

networkAccessControl

The configuration settings 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 to access resources through Organizations. This can only be used with a workspace that has the permissionType set to CUSTOMER_MANAGED.

permissionType

Use this parameter if you want to change a workspace from SERVICE_MANAGED to CUSTOMER_MANAGED. This allows you to manage the permissions that the workspace uses to access datasources and notification channels. If the workspace is in a member Amazon Web Services account of an organization, and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, you must choose CUSTOMER_MANAGED.

If you specify this as CUSTOMER_MANAGED, you must also specify a workspaceRoleArn that the workspace will use for accessing Amazon Web Services resources.

For more information on the role and permissions needed, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels

Do not use this to convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED. Do not include this parameter if you want to leave the workspace as SERVICE_MANAGED.

You can convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED using the Amazon Managed Grafana console. For more information, see Managing permissions for data sources and notification channels.

removeNetworkAccessConfiguration

Whether to remove the network access configuration from the workspace.

Setting this to true and providing a networkAccessControl to set will return an error.

If you remove this configuration by setting this to true, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.

removeVpcConfiguration

Whether to remove the VPC configuration from the workspace.

Setting this to true and providing a vpcConfiguration to set will return an error.

stackSetName

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

vpcConfiguration

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

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.

workspaceId

[required] The ID of the workspace to update.

workspaceName

A new name for the workspace to update.

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

Specifies an IAM role that grants permissions to Amazon Web Services resources that the workspace accesses, such as data sources and notification channels. If this workspace has permissionType CUSTOMER_MANAGED, then this role is required.

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$update_workspace(
  accountAccessType = "CURRENT_ACCOUNT"|"ORGANIZATION",
  networkAccessControl = list(
    prefixListIds = list(
      "string"
    ),
    vpceIds = list(
      "string"
    )
  ),
  organizationRoleName = "string",
  permissionType = "CUSTOMER_MANAGED"|"SERVICE_MANAGED",
  removeNetworkAccessConfiguration = TRUE|FALSE,
  removeVpcConfiguration = TRUE|FALSE,
  stackSetName = "string",
  vpcConfiguration = list(
    securityGroupIds = list(
      "string"
    ),
    subnetIds = list(
      "string"
    )
  ),
  workspaceDataSources = list(
    "AMAZON_OPENSEARCH_SERVICE"|"CLOUDWATCH"|"PROMETHEUS"|"XRAY"|"TIMESTREAM"|"SITEWISE"|"ATHENA"|"REDSHIFT"|"TWINMAKER"
  ),
  workspaceDescription = "string",
  workspaceId = "string",
  workspaceName = "string",
  workspaceNotificationDestinations = list(
    "SNS"
  ),
  workspaceOrganizationalUnits = list(
    "string"
  ),
  workspaceRoleArn = "string"
)