class Aws::ManagedGrafana::Types::WorkspaceDescription

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

@!attribute [rw] account_access_type

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 this is `ORGANIZATION`, the
`workspaceOrganizationalUnits` parameter specifies which
organizational units the workspace can access.
@return [String]

@!attribute [rw] authentication

A structure that describes whether the workspace uses SAML, Amazon
Web Services SSO, or both methods for user authentication.
@return [Types::AuthenticationSummary]

@!attribute [rw] created

The date that the workspace was created.
@return [Time]

@!attribute [rw] data_sources

Specifies the Amazon Web Services data sources that have been
configured to have IAM roles and permissions created to allow Amazon
Managed Grafana to read data from these sources.
@return [Array<String>]

@!attribute [rw] description

The user-defined description of the workspace.
@return [String]

@!attribute [rw] endpoint

The URL that users can use to access the Grafana console in the
workspace.
@return [String]

@!attribute [rw] free_trial_consumed

Specifies whether this workspace has already fully used its free
trial for Grafana Enterprise.
@return [Boolean]

@!attribute [rw] free_trial_expiration

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

@!attribute [rw] grafana_version

The version of Grafana supported in this workspace.
@return [String]

@!attribute [rw] id

The unique ID of this workspace.
@return [String]

@!attribute [rw] license_expiration

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

@!attribute [rw] license_type

Specifies whether this workspace has a full Grafana Enterprise
license or a free trial license.
@return [String]

@!attribute [rw] modified

The most recent date that the workspace was modified.
@return [Time]

@!attribute [rw] name

The name of the workspace.
@return [String]

@!attribute [rw] notification_destinations

The Amazon Web Services notification channels that Amazon Managed
Grafana can automatically create IAM roles and permissions for, to
allow Amazon Managed Grafana to use these channels.
@return [Array<String>]

@!attribute [rw] organization_role_name

The name of the IAM role that is used to access resources through
Organizations.
@return [String]

@!attribute [rw] organizational_units

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.
@return [Array<String>]

@!attribute [rw] permission_type

If this is `Service Managed`, Amazon Managed Grafana automatically
creates the IAM roles and provisions the permissions that the
workspace needs to use Amazon Web Services 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 Amazon Web Services accounts in the organization,
you must choose `CUSTOMER_MANAGED`.

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

[1]: https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html
@return [String]

@!attribute [rw] stack_set_name

The name of the CloudFormation stack set that is used to generate
IAM roles to be used for this workspace.
@return [String]

@!attribute [rw] status

The current status of the workspace.
@return [String]

@!attribute [rw] tags

The list of tags associated with the workspace.
@return [Hash<String,String>]

@!attribute [rw] workspace_role_arn

The IAM role that grants permissions to the Amazon Web Services
resources that the workspace will view data from. This role must
already exist.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/WorkspaceDescription AWS API Documentation

Constants

SENSITIVE