Package software.amazon.awscdk.cfnpropertymixins.services.grafana

Class CfnWorkspaceMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.grafana.CfnWorkspaceMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnWorkspaceMixinProps>

Enclosing interface:

CfnWorkspaceMixinProps

@Stability(Stable)
public static final class CfnWorkspaceMixinProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnWorkspaceMixinProps>

A builder for CfnWorkspaceMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnWorkspaceMixinProps.Builder	accountAccessType(String accountAccessType)	Sets the value of CfnWorkspaceMixinProps.getAccountAccessType()
CfnWorkspaceMixinProps.Builder	authenticationProviders(List<String> authenticationProviders)	Sets the value of CfnWorkspaceMixinProps.getAuthenticationProviders()
CfnWorkspaceMixinProps	build()	Builds the configured instance.
CfnWorkspaceMixinProps.Builder	clientToken(String clientToken)	Sets the value of CfnWorkspaceMixinProps.getClientToken()
CfnWorkspaceMixinProps.Builder	dataSources(List<String> dataSources)	Sets the value of CfnWorkspaceMixinProps.getDataSources()
CfnWorkspaceMixinProps.Builder	description(String description)	Sets the value of CfnWorkspaceMixinProps.getDescription()
CfnWorkspaceMixinProps.Builder	grafanaVersion(String grafanaVersion)	Sets the value of CfnWorkspaceMixinProps.getGrafanaVersion()
CfnWorkspaceMixinProps.Builder	name(String name)	Sets the value of CfnWorkspaceMixinProps.getName()
CfnWorkspaceMixinProps.Builder	networkAccessControl(CfnWorkspacePropsMixin.NetworkAccessControlProperty networkAccessControl)	Sets the value of CfnWorkspaceMixinProps.getNetworkAccessControl()
CfnWorkspaceMixinProps.Builder	networkAccessControl(IResolvable networkAccessControl)	Sets the value of CfnWorkspaceMixinProps.getNetworkAccessControl()
CfnWorkspaceMixinProps.Builder	notificationDestinations(List<String> notificationDestinations)	Sets the value of CfnWorkspaceMixinProps.getNotificationDestinations()
CfnWorkspaceMixinProps.Builder	organizationalUnits(List<String> organizationalUnits)	Sets the value of CfnWorkspaceMixinProps.getOrganizationalUnits()
CfnWorkspaceMixinProps.Builder	organizationRoleName(String organizationRoleName)	Sets the value of CfnWorkspaceMixinProps.getOrganizationRoleName()
CfnWorkspaceMixinProps.Builder	permissionType(String permissionType)	Sets the value of CfnWorkspaceMixinProps.getPermissionType()
CfnWorkspaceMixinProps.Builder	pluginAdminEnabled(Boolean pluginAdminEnabled)	Sets the value of CfnWorkspaceMixinProps.getPluginAdminEnabled()
CfnWorkspaceMixinProps.Builder	pluginAdminEnabled(IResolvable pluginAdminEnabled)	Sets the value of CfnWorkspaceMixinProps.getPluginAdminEnabled()
CfnWorkspaceMixinProps.Builder	roleArn(String roleArn)	Sets the value of CfnWorkspaceMixinProps.getRoleArn()
CfnWorkspaceMixinProps.Builder	roleArn(IRoleRef roleArn)	Sets the value of CfnWorkspaceMixinProps.getRoleArn()
CfnWorkspaceMixinProps.Builder	samlConfiguration(CfnWorkspacePropsMixin.SamlConfigurationProperty samlConfiguration)	Sets the value of CfnWorkspaceMixinProps.getSamlConfiguration()
CfnWorkspaceMixinProps.Builder	samlConfiguration(IResolvable samlConfiguration)	Sets the value of CfnWorkspaceMixinProps.getSamlConfiguration()
CfnWorkspaceMixinProps.Builder	stackSetName(String stackSetName)	Sets the value of CfnWorkspaceMixinProps.getStackSetName()
CfnWorkspaceMixinProps.Builder	vpcConfiguration(CfnWorkspacePropsMixin.VpcConfigurationProperty vpcConfiguration)	Sets the value of CfnWorkspaceMixinProps.getVpcConfiguration()
CfnWorkspaceMixinProps.Builder	vpcConfiguration(IResolvable vpcConfiguration)	Sets the value of CfnWorkspaceMixinProps.getVpcConfiguration()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

accountAccessType

@Stability(Stable)
public CfnWorkspaceMixinProps.Builder accountAccessType(String accountAccessType)

Sets the value of CfnWorkspaceMixinProps.getAccountAccessType()

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. If this is ORGANIZATION , the OrganizationalUnits parameter specifies which organizational units the workspace can access.

Returns:

this

authenticationProviders

@Stability(Stable)
public CfnWorkspaceMixinProps.Builder authenticationProviders(List<String> authenticationProviders)

Sets the value of CfnWorkspaceMixinProps.getAuthenticationProviders()

Parameters:

authenticationProviders - Specifies whether this workspace uses SAML 2.0, SSOlong , 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

Returns:

this

clientToken

@Stability(Stable)
public CfnWorkspaceMixinProps.Builder clientToken(String clientToken)

Sets the value of CfnWorkspaceMixinProps.getClientToken()

Parameters:

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

Returns:

this

dataSources

@Stability(Stable)
public CfnWorkspaceMixinProps.Builder dataSources(List<String> dataSources)

Sets the value of CfnWorkspaceMixinProps.getDataSources()

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 list is only used when the workspace was created through the AWS console, and the permissionType is SERVICE_MANAGED .

Returns:

this

description

@Stability(Stable)
public CfnWorkspaceMixinProps.Builder description(String description)

Sets the value of CfnWorkspaceMixinProps.getDescription()

Parameters:

description - The user-defined description of the workspace.

Returns:

this

grafanaVersion

@Stability(Stable)
public CfnWorkspaceMixinProps.Builder grafanaVersion(String grafanaVersion)

Sets the value of CfnWorkspaceMixinProps.getGrafanaVersion()

Parameters:

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.

Returns:

this

name

@Stability(Stable)
public CfnWorkspaceMixinProps.Builder name(String name)

Sets the value of CfnWorkspaceMixinProps.getName()

Parameters:

name - The name of the workspace.

Returns:

this

networkAccessControl

@Stability(Stable)
public CfnWorkspaceMixinProps.Builder networkAccessControl(IResolvable networkAccessControl)

Sets the value of CfnWorkspaceMixinProps.getNetworkAccessControl()

Parameters:

networkAccessControl - The configuration settings for network access to your workspace.

Returns:

this

networkAccessControl

@Stability(Stable)
public CfnWorkspaceMixinProps.Builder networkAccessControl(CfnWorkspacePropsMixin.NetworkAccessControlProperty networkAccessControl)

Sets the value of CfnWorkspaceMixinProps.getNetworkAccessControl()

Parameters:

networkAccessControl - The configuration settings for network access to your workspace.

Returns:

this

notificationDestinations

@Stability(Stable)
public CfnWorkspaceMixinProps.Builder notificationDestinations(List<String> notificationDestinations)

Sets the value of CfnWorkspaceMixinProps.getNotificationDestinations()

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. AllowedValues : SNS

Returns:

this

organizationalUnits

@Stability(Stable)
public CfnWorkspaceMixinProps.Builder organizationalUnits(List<String> organizationalUnits)

Sets the value of CfnWorkspaceMixinProps.getOrganizationalUnits()

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.

Returns:

this

organizationRoleName

@Stability(Stable)
public CfnWorkspaceMixinProps.Builder organizationRoleName(String organizationRoleName)

Sets the value of CfnWorkspaceMixinProps.getOrganizationRoleName()

Parameters:

organizationRoleName - The name of the IAM role that is used to access resources through Organizations.

Returns:

this

permissionType

@Stability(Stable)
public CfnWorkspaceMixinProps.Builder permissionType(String permissionType)

Sets the value of CfnWorkspaceMixinProps.getPermissionType()

Parameters:

permissionType - 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

Returns:

this

pluginAdminEnabled

@Stability(Stable)
public CfnWorkspaceMixinProps.Builder pluginAdminEnabled(Boolean pluginAdminEnabled)

Sets the value of CfnWorkspaceMixinProps.getPluginAdminEnabled()

Parameters:

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.

Returns:

this

pluginAdminEnabled

@Stability(Stable)
public CfnWorkspaceMixinProps.Builder pluginAdminEnabled(IResolvable pluginAdminEnabled)

Sets the value of CfnWorkspaceMixinProps.getPluginAdminEnabled()

Parameters:

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.

Returns:

this

roleArn

@Stability(Stable)
public CfnWorkspaceMixinProps.Builder roleArn(String roleArn)

Sets the value of CfnWorkspaceMixinProps.getRoleArn()

Parameters:

roleArn - The IAM role that grants permissions to the AWS resources that the workspace will view data from. This role must already exist.

Returns:

this

roleArn

@Stability(Stable)
public CfnWorkspaceMixinProps.Builder roleArn(IRoleRef roleArn)

Sets the value of CfnWorkspaceMixinProps.getRoleArn()

Parameters:

roleArn - The IAM role that grants permissions to the AWS resources that the workspace will view data from. This role must already exist.

Returns:

this

samlConfiguration

@Stability(Stable)
public CfnWorkspaceMixinProps.Builder samlConfiguration(IResolvable samlConfiguration)

Sets the value of CfnWorkspaceMixinProps.getSamlConfiguration()

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 the Admin and Editor roles in the workspace.

Returns:

this

samlConfiguration

@Stability(Stable)
public CfnWorkspaceMixinProps.Builder samlConfiguration(CfnWorkspacePropsMixin.SamlConfigurationProperty samlConfiguration)

Sets the value of CfnWorkspaceMixinProps.getSamlConfiguration()

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 the Admin and Editor roles in the workspace.

Returns:

this

stackSetName

@Stability(Stable)
public CfnWorkspaceMixinProps.Builder stackSetName(String stackSetName)

Sets the value of CfnWorkspaceMixinProps.getStackSetName()

Parameters:

stackSetName - The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace.

Returns:

this

vpcConfiguration

@Stability(Stable)
public CfnWorkspaceMixinProps.Builder vpcConfiguration(IResolvable vpcConfiguration)

Sets the value of CfnWorkspaceMixinProps.getVpcConfiguration()

Parameters:

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).

Returns:

this

vpcConfiguration

@Stability(Stable)
public CfnWorkspaceMixinProps.Builder vpcConfiguration(CfnWorkspacePropsMixin.VpcConfigurationProperty vpcConfiguration)

Sets the value of CfnWorkspaceMixinProps.getVpcConfiguration()

Parameters:

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).

Returns:

this

build

@Stability(Stable)
public CfnWorkspaceMixinProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnWorkspaceMixinProps>

Returns:

a new instance of CfnWorkspaceMixinProps

Throws:

NullPointerException - if any required attribute was not provided