grafana/aws.sdk.kotlin.services.grafana.model/CreateWorkspaceRequest/Builder

Builder

class Builder

Properties

Link copied to clipboard
var accountAccessType: AccountAccessType?

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 you specify ORGANIZATION, you must specify which organizational units the workspace can access in the workspaceOrganizationalUnits parameter.

Link copied to clipboard
var authenticationProviders: List<AuthenticationProviderTypes>?

Specifies whether this workspace uses SAML 2.0, IAM Identity Center (successor to Single Sign-On), or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.

Link copied to clipboard
var clientToken: String?

A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

Link copied to clipboard
var configuration: String?

The configuration string for the workspace that you create. For more information about the format and configuration options available, see Working in your Grafana workspace.

Link copied to clipboard
var grafanaVersion: String?

Specifies the version of Grafana to support in the new workspace.

Link copied to clipboard
var networkAccessControl: NetworkAccessConfiguration?

Configuration for network access to your workspace.

Link copied to clipboard
var organizationRoleName: String?

The name of an IAM role that already exists to use with Organizations to access Amazon Web Services data sources and notification channels in other accounts in an organization.

Link copied to clipboard
var permissionType: PermissionType?

When creating a workspace through the Amazon Web Services API, CLI or Amazon Web Services CloudFormation, you must manage IAM roles and provision the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.

Link copied to clipboard
var stackSetName: String?

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

Link copied to clipboard
var tags: Map<String, String>?

The list of tags associated with the workspace.

Link copied to clipboard
var vpcConfiguration: VpcConfiguration?

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

Link copied to clipboard
var workspaceDataSources: List<DataSourceType>?

This parameter is for internal use only, and should not be used.

Link copied to clipboard
var workspaceDescription: String?

A description for the workspace. This is used only to help you identify this workspace.

Link copied to clipboard
var workspaceName: String?

The name for the workspace. It does not have to be unique.

Link copied to clipboard
var workspaceNotificationDestinations: List<NotificationDestinationType>?

Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to use these channels.

Link copied to clipboard
var workspaceOrganizationalUnits: List<String>?

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.

Link copied to clipboard
var workspaceRoleArn: String?

Specified the IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from, including both data sources and notification channels. You are responsible for managing the permissions for this role as new data sources or notification channels are added.