workspaces_list_only

Lists workspaces in a region or regions, for all properties use workspaces

Overview

Name	workspaces_list_only
Type	Resource
Description	Definition of AWS::Grafana::Workspace Resource Type
Id	aws.grafana.workspaces_list_only

Fields

Name	Datatype	Description
authentication_providers	array	List of authentication providers to enable.
sso_client_id	string	The client ID of the AWS SSO Managed Application.
saml_configuration	object	SAML configuration data associated with an AMG workspace.
network_access_control	object	The configuration settings for Network Access Control.
vpc_configuration	object	The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
saml_configuration_status	string	Valid SAML configuration statuses.
client_token	string	A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
status	string	These enums represent the status of a workspace.
creation_timestamp	string	Timestamp when the workspace was created.
modification_timestamp	string	Timestamp when the workspace was last modified
grafana_version	string	The version of Grafana to support in your workspace.
endpoint	string	Endpoint for the Grafana workspace.
account_access_type	string	These enums represent valid account access types. Specifically these enums determine whether the workspace can access AWS resources in the AWS account only, or whether it can also access resources in other accounts in the same organization. If the value CURRENT_ACCOUNT is used, a workspace role ARN must be provided. If the value is ORGANIZATION, a list of organizational units must be provided.
organization_role_name	string	The name of an IAM role that already exists to use with AWS Organizations to access AWS data sources and notification channels in other accounts in an organization.
permission_type	string	These enums represent valid permission types to use when creating or configuring a Grafana workspace. The SERVICE_MANAGED permission type means the Managed Grafana service will create a workspace IAM role on your behalf. The CUSTOMER_MANAGED permission type means that the customer is expected to provide an IAM role that the Grafana workspace can use to query data sources.
stack_set_name	string	The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
data_sources	array	List of data sources on the service managed IAM role.
description	string	Description of a workspace.
id	string	The id that uniquely identifies a Grafana workspace.
name	string	The user friendly name of a workspace.
notification_destinations	array	List of notification destinations on the customers service managed IAM role that the Grafana workspace can query.
organizational_units	array	List of Organizational Units containing AWS accounts the Grafana workspace can pull data from.
role_arn	string	IAM Role that will be used to grant the Grafana workspace access to a customers AWS resources.
plugin_admin_enabled	boolean	Allow workspace admins to install plugins
region	string	AWS region.

Methods

Name	Accessible by	Required Params
list_resources	SELECT	region

SELECT examples

Lists all workspaces in a region.

SELECT
region,
id
FROM aws.grafana.workspaces_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the workspaces_list_only resource, see workspaces