Class CfnWorkspace.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnWorkspace>
- Enclosing class:
CfnWorkspace
CfnWorkspace
.-
Method Summary
Modifier and TypeMethodDescriptionaccountAccessType
(String 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.authenticationProviders
(List<String> authenticationProviders) Specifies whether this workspace uses SAML 2.0, AWS IAM Identity Center , or both to authenticate users for using the Grafana console within a workspace.build()
clientToken
(String clientToken) A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.static CfnWorkspace.Builder
dataSources
(List<String> 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.description
(String description) The user-defined description of the workspace.grafanaVersion
(String grafanaVersion) Specifies the version of Grafana to support in the workspace.The name of the workspace.networkAccessControl
(IResolvable networkAccessControl) The configuration settings for network access to your workspace.networkAccessControl
(CfnWorkspace.NetworkAccessControlProperty networkAccessControl) The configuration settings for network access to your workspace.notificationDestinations
(List<String> 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.organizationalUnits
(List<String> 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.organizationRoleName
(String organizationRoleName) The name of the IAM role that is used to access resources through Organizations.permissionType
(String permissionType) If this isSERVICE_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.pluginAdminEnabled
(Boolean pluginAdminEnabled) Whether plugin administration is enabled in the workspace.pluginAdminEnabled
(IResolvable pluginAdminEnabled) Whether plugin administration is enabled in the workspace.The IAM role that grants permissions to the AWS resources that the workspace will view data from.samlConfiguration
(IResolvable samlConfiguration) 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 theAdmin
andEditor
roles in the workspace.samlConfiguration
(CfnWorkspace.SamlConfigurationProperty samlConfiguration) 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 theAdmin
andEditor
roles in the workspace.stackSetName
(String stackSetName) The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace.vpcConfiguration
(IResolvable vpcConfiguration) The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.vpcConfiguration
(CfnWorkspace.VpcConfigurationProperty vpcConfiguration) The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
-
Method Details
-
create
@Stability(Stable) public static CfnWorkspace.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.- Returns:
- a new instance of
CfnWorkspace.Builder
.
-
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
, theOrganizationalUnits
parameter specifies which organizational units the workspace can access.- Parameters:
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. This parameter is required.- Returns:
this
- See Also:
-
authenticationProviders
@Stability(Stable) public CfnWorkspace.Builder authenticationProviders(List<String> authenticationProviders) Specifies whether this workspace uses SAML 2.0, AWS IAM Identity Center , or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana .Allowed Values :
AWS_SSO | SAML
- Parameters:
authenticationProviders
- Specifies whether this workspace uses SAML 2.0, AWS IAM Identity Center , or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana . This parameter is required.- Returns:
this
- See Also:
-
permissionType
If this isSERVICE_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
- Parameters:
permissionType
- If this isSERVICE_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. This parameter is required.- Returns:
this
- See Also:
-
clientToken
A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.- Parameters:
clientToken
- A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request. This parameter is required.- Returns:
this
- See Also:
-
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.This list is only used when the workspace was created through the AWS console, and the
permissionType
isSERVICE_MANAGED
.- Parameters:
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. This parameter is required.- Returns:
this
- See Also:
-
description
The user-defined description of the workspace.- Parameters:
description
- The user-defined description of the workspace. This parameter is required.- Returns:
this
- See Also:
-
grafanaVersion
Specifies the version of Grafana to support in the workspace.Defaults to the latest version on create (for example, 9.4), or the current version of the workspace on update.
Can only be used to upgrade (for example, from 8.4 to 9.4), not downgrade (for example, from 9.4 to 8.4).
To know what versions are available to upgrade to for a specific workspace, see the ListVersions operation.
- Parameters:
grafanaVersion
- Specifies the version of Grafana to support in the workspace. This parameter is required.- Returns:
this
- See Also:
-
name
The name of the workspace.- Parameters:
name
- The name of the workspace. This parameter is required.- Returns:
this
- See Also:
-
networkAccessControl
@Stability(Stable) public CfnWorkspace.Builder networkAccessControl(IResolvable networkAccessControl) The configuration settings for network access to your workspace.- Parameters:
networkAccessControl
- The configuration settings for network access to your workspace. This parameter is required.- Returns:
this
- See Also:
-
networkAccessControl
@Stability(Stable) public CfnWorkspace.Builder networkAccessControl(CfnWorkspace.NetworkAccessControlProperty networkAccessControl) The configuration settings for network access to your workspace.- Parameters:
networkAccessControl
- The configuration settings for network access to your workspace. This parameter is required.- Returns:
this
- See Also:
-
notificationDestinations
@Stability(Stable) public CfnWorkspace.Builder notificationDestinations(List<String> 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.AllowedValues :
SNS
- Parameters:
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. This parameter is required.- Returns:
this
- See Also:
-
organizationalUnits
@Stability(Stable) public CfnWorkspace.Builder organizationalUnits(List<String> 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.- Parameters:
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. This parameter is required.- Returns:
this
- See Also:
-
organizationRoleName
The name of the IAM role that is used to access resources through Organizations.- Parameters:
organizationRoleName
- The name of the IAM role that is used to access resources through Organizations. This parameter is required.- Returns:
this
- See Also:
-
pluginAdminEnabled
Whether plugin administration is enabled in the workspace.Setting to
true
allows workspace admins to install, uninstall, and update plugins from within the Grafana workspace.This option is only valid for workspaces that support Grafana version 9 or newer.
- Parameters:
pluginAdminEnabled
- Whether plugin administration is enabled in the workspace. This parameter is required.- Returns:
this
- See Also:
-
pluginAdminEnabled
Whether plugin administration is enabled in the workspace.Setting to
true
allows workspace admins to install, uninstall, and update plugins from within the Grafana workspace.This option is only valid for workspaces that support Grafana version 9 or newer.
- Parameters:
pluginAdminEnabled
- Whether plugin administration is enabled in the workspace. This parameter is required.- Returns:
this
- See Also:
-
roleArn
The IAM role that grants permissions to the AWS resources that the workspace will view data from.This role must already exist.
- Parameters:
roleArn
- The IAM role that grants permissions to the AWS resources that the workspace will view data from. This parameter is required.- Returns:
this
- See Also:
-
samlConfiguration
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 theAdmin
andEditor
roles in the workspace.- Parameters:
samlConfiguration
- 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 theAdmin
andEditor
roles in the workspace. This parameter is required.- Returns:
this
- See Also:
-
samlConfiguration
@Stability(Stable) public CfnWorkspace.Builder samlConfiguration(CfnWorkspace.SamlConfigurationProperty samlConfiguration) 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 theAdmin
andEditor
roles in the workspace.- Parameters:
samlConfiguration
- 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 theAdmin
andEditor
roles in the workspace. This parameter is required.- Returns:
this
- See Also:
-
stackSetName
The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace.- Parameters:
stackSetName
- The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace. This parameter is required.- Returns:
this
- See Also:
-
vpcConfiguration
The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2).
- Parameters:
vpcConfiguration
- The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. This parameter is required.- Returns:
this
- See Also:
-
vpcConfiguration
@Stability(Stable) public CfnWorkspace.Builder vpcConfiguration(CfnWorkspace.VpcConfigurationProperty vpcConfiguration) The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2).
- Parameters:
vpcConfiguration
- The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. This parameter is required.- Returns:
this
- See Also:
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnWorkspace>
- Returns:
- a newly built instance of
CfnWorkspace
.
-