WorkspaceDescription

A structure containing information about an Amazon Managed Grafana workspace in your account.

authentication

A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.

Type: AuthenticationSummary object

Required: Yes

created

The date that the workspace was created.

Type: Timestamp

Required: Yes

dataSources

Specifies the AWS data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.

This list is only used when the workspace was created through the AWS console, and the permissionType is SERVICE_MANAGED.

Type: Array of strings

Required: Yes

endpoint

The URL that users can use to access the Grafana console in the workspace.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: Yes

grafanaVersion

The version of Grafana supported in this workspace.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

id

The unique ID of this workspace.

Type: String

Pattern: g-[0-9a-f]{10}

Required: Yes

modified

The most recent date that the workspace was modified.

Type: Timestamp

Required: Yes

status

The current status of the workspace.

Type: String

Required: Yes

accountAccessType

Specifies whether the workspace can access AWS resources in this AWS account only, or whether it can also access AWS resources in other accounts in the same organization. If this is ORGANIZATION, the workspaceOrganizationalUnits parameter specifies which organizational units the workspace can access.

Type: String

Valid Values: CURRENT_ACCOUNT | ORGANIZATION

Required: No

description

The user-defined description of the workspace.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Required: No

freeTrialConsumed

Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.

Note

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

Type: Boolean

Required: No

freeTrialExpiration

If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.

Note

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

Type: Timestamp

Required: No

grafanaToken

The token that ties this workspace to a Grafana Labs account. For more information, see Link your account with Grafana Labs.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

Required: No

licenseExpiration

If this workspace has a full Grafana Enterprise license purchased through AWS Marketplace, this specifies when the license ends and will need to be renewed. Purchasing the Enterprise plugins option through Amazon Managed Grafana does not have an expiration. It is valid until the license is removed.

Type: Timestamp

Required: No

licenseType

Specifies whether this workspace has a full Grafana Enterprise license.

Note

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

Type: String

Valid Values: ENTERPRISE | ENTERPRISE_FREE_TRIAL

Required: No

name

The name of the workspace.

Type: String

Pattern: [a-zA-Z0-9-._~]{1,255}

Required: No

networkAccessControl

The configuration settings for network access to your workspace.

Type: NetworkAccessConfiguration object

Required: No

notificationDestinations

The AWS notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, to allow Amazon Managed Grafana to use these channels.

Type: Array of strings

Valid Values: SNS

Required: No

organizationalUnits

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.

Type: Array of strings

Required: No

organizationRoleName

The name of the IAM role that is used to access resources through Organizations.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

permissionType

If this is SERVICE_MANAGED, and the workplace was created through the Amazon Managed Grafana console, then Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use AWS data sources and notification channels.

If this is CUSTOMER_MANAGED, you must manage those roles and permissions yourself.

If you are working with a workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other AWS accounts in the organization, this parameter must be set to CUSTOMER_MANAGED.

For more information about converting between customer and service managed, see Managing permissions for data sources and notification channels. For more information about the roles and permissions that must be managed for customer managed workspaces, see Amazon Managed Grafana permissions and policies for AWS data sources and notification channels

Type: String

Valid Values: CUSTOMER_MANAGED | SERVICE_MANAGED

Required: No

stackSetName

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

Type: String

Required: No

tags

The list of tags associated with the workspace.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

vpcConfiguration

The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).

Type: VpcConfiguration object

Required: No

workspaceRoleArn

The IAM role that grants permissions to the AWS resources that the workspace will view data from. This role must already exist.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

WorkspaceDescription

Contents

Note

Note

Note

See Also