GetWorkspaceResult

data class GetWorkspaceResult(val accountAccessType: WorkspaceAccountAccessType? = null, val authenticationProviders: List<WorkspaceAuthenticationProviderTypes>? = null, val creationTimestamp: String? = null, val dataSources: List<WorkspaceDataSourceType>? = null, val description: String? = null, val endpoint: String? = null, val grafanaVersion: String? = null, val id: String? = null, val modificationTimestamp: String? = null, val name: String? = null, val networkAccessControl: WorkspaceNetworkAccessControl? = null, val notificationDestinations: List<WorkspaceNotificationDestinationType>? = null, val organizationRoleName: String? = null, val organizationalUnits: List<String>? = null, val permissionType: WorkspacePermissionType? = null, val pluginAdminEnabled: Boolean? = null, val roleArn: String? = null, val samlConfiguration: WorkspaceSamlConfiguration? = null, val samlConfigurationStatus: WorkspaceSamlConfigurationStatus? = null, val ssoClientId: String? = null, val stackSetName: String? = null, val status: WorkspaceStatus? = null, val vpcConfiguration: WorkspaceVpcConfiguration? = null)

Constructors

Link copied to clipboard
constructor(accountAccessType: WorkspaceAccountAccessType? = null, authenticationProviders: List<WorkspaceAuthenticationProviderTypes>? = null, creationTimestamp: String? = null, dataSources: List<WorkspaceDataSourceType>? = null, description: String? = null, endpoint: String? = null, grafanaVersion: String? = null, id: String? = null, modificationTimestamp: String? = null, name: String? = null, networkAccessControl: WorkspaceNetworkAccessControl? = null, notificationDestinations: List<WorkspaceNotificationDestinationType>? = null, organizationRoleName: String? = null, organizationalUnits: List<String>? = null, permissionType: WorkspacePermissionType? = null, pluginAdminEnabled: Boolean? = null, roleArn: String? = null, samlConfiguration: WorkspaceSamlConfiguration? = null, samlConfigurationStatus: WorkspaceSamlConfigurationStatus? = null, ssoClientId: String? = null, stackSetName: String? = null, status: WorkspaceStatus? = null, vpcConfiguration: WorkspaceVpcConfiguration? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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 OrganizationalUnits parameter specifies which organizational units the workspace can access.

Link copied to clipboard

List of authentication providers to enable.

Link copied to clipboard

Timestamp when the workspace was created.

Link copied to clipboard

List of data sources on the service managed IAM role.

Link copied to clipboard
val description: String? = null

Description of a workspace.

Link copied to clipboard
val endpoint: String? = null

Endpoint for the Grafana workspace.

Link copied to clipboard
val grafanaVersion: String? = null

The version of Grafana to support in your workspace.

Link copied to clipboard
val id: String? = null

The id that uniquely identifies a Grafana workspace.

Link copied to clipboard

Timestamp when the workspace was last modified

Link copied to clipboard
val name: String? = null

The user friendly name of a workspace.

Link copied to clipboard

The configuration settings for network access to your workspace.

Link copied to clipboard

List of notification destinations on the customers service managed IAM role that the Grafana workspace can query.

Link copied to clipboard

List of Organizational Units containing AWS accounts the Grafana workspace can pull data from.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Allow workspace admins to install plugins

Link copied to clipboard
val roleArn: String? = null

IAM Role that will be used to grant the Grafana workspace access to a customers AWS resources.

Link copied to clipboard

If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the Admin and Editor roles in the workspace.

Link copied to clipboard

Specifies whether the workspace's SAML configuration is complete. Valid values: CONFIGURED | NOT_CONFIGURED Type: String

Link copied to clipboard
val ssoClientId: String? = null

The client ID of the AWS SSO Managed Application.

Link copied to clipboard
val stackSetName: String? = null

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

Link copied to clipboard
val status: WorkspaceStatus? = null

The current status of the workspace. Valid values: ACTIVE | CREATING | DELETING | FAILED | UPDATING | UPGRADING | DELETION_FAILED | CREATION_FAILED | UPDATE_FAILED | UPGRADE_FAILED | LICENSE_REMOVAL_FAILED Type: String

Link copied to clipboard

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