WorkspaceDescription - AWS Managed Grafana

WorkspaceDescription

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

Contents

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

authentication

A structure that describes whether the workspace uses SAML, AWS SSO, 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.

Type: Array of strings

Valid Values: AMAZON_OPENSEARCH_SERVICE | CLOUDWATCH | PROMETHEUS | XRAY | TIMESTREAM | SITEWISE

Required: Yes

description

The user-defined description of the workspace.

Type: String

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

Required: No

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

freeTrialConsumed

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

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.

Type: Timestamp

Required: No

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

licenseExpiration

If this workspace has a full Grafana Enterprise license, this specifies when the license ends and will need to be renewed.

Type: Timestamp

Required: No

licenseType

Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.

Type: String

Valid Values: ENTERPRISE | ENTERPRISE_FREE_TRIAL

Required: No

modified

The most recent date that the workspace was modified.

Type: Timestamp

Required: Yes

name

The name of the workspace.

Type: String

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

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, 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 manage those roles and permissions yourself. If you are creating this 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, you must choose CUSTOMER_MANAGED.

For more information, 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

status

The current status of the workspace.

Type: String

Valid Values: ACTIVE | CREATING | DELETING | FAILED | UPDATING | UPGRADING | DELETION_FAILED | CREATION_FAILED | UPDATE_FAILED | UPGRADE_FAILED | LICENSE_REMOVAL_FAILED

Required: Yes

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: