Package software.amazon.awscdk.services.grafana

Class CfnWorkspaceProps.Builder

java.lang.Object

software.amazon.awscdk.services.grafana.CfnWorkspaceProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnWorkspaceProps>

Enclosing interface:

CfnWorkspaceProps

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

A builder for CfnWorkspaceProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

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

Returns:

this

authenticationProviders

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

Sets the value of CfnWorkspaceProps.getAuthenticationProviders()

Parameters:

authenticationProviders - Specifies whether this workspace uses SAML 2.0, AWS IAM Identity Center (successor to AWS 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 . This parameter is required.

Returns:

this

permissionType

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

Sets the value of CfnWorkspaceProps.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. This parameter is required. 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

clientToken

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

Sets the value of CfnWorkspaceProps.getClientToken()

Parameters:

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

Returns:

this

dataSources

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

Sets the value of CfnWorkspaceProps.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 CfnWorkspaceProps.Builder description(String description)

Sets the value of CfnWorkspaceProps.getDescription()

Parameters:

description - The user-defined description of the workspace.

Returns:

this

grafanaVersion

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

Sets the value of CfnWorkspaceProps.getGrafanaVersion()

Parameters:

grafanaVersion - Specifies the version of Grafana to support in the new workspace. Supported values are 8.4 and 9.4 .

Returns:

this

name

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

Sets the value of CfnWorkspaceProps.getName()

Parameters:

name - The name of the workspace.

Returns:

this

networkAccessControl

@Stability(Stable)
public CfnWorkspaceProps.Builder networkAccessControl(CfnWorkspace.NetworkAccessControlProperty networkAccessControl)

Sets the value of CfnWorkspaceProps.getNetworkAccessControl()

Parameters:

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

Returns:

this

networkAccessControl

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

Sets the value of CfnWorkspaceProps.getNetworkAccessControl()

Parameters:

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

Returns:

this

notificationDestinations

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

Sets the value of CfnWorkspaceProps.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.

Returns:

this

organizationalUnits

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

Sets the value of CfnWorkspaceProps.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 CfnWorkspaceProps.Builder organizationRoleName(String organizationRoleName)

Sets the value of CfnWorkspaceProps.getOrganizationRoleName()

Parameters:

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

Returns:

this

roleArn

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

Sets the value of CfnWorkspaceProps.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 CfnWorkspaceProps.Builder samlConfiguration(IResolvable samlConfiguration)

Sets the value of CfnWorkspaceProps.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 CfnWorkspaceProps.Builder samlConfiguration(CfnWorkspace.SamlConfigurationProperty samlConfiguration)

Sets the value of CfnWorkspaceProps.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 CfnWorkspaceProps.Builder stackSetName(String stackSetName)

Sets the value of CfnWorkspaceProps.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 CfnWorkspaceProps.Builder vpcConfiguration(IResolvable vpcConfiguration)

Sets the value of CfnWorkspaceProps.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 CfnWorkspaceProps.Builder vpcConfiguration(CfnWorkspace.VpcConfigurationProperty vpcConfiguration)

Sets the value of CfnWorkspaceProps.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 CfnWorkspaceProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnWorkspaceProps

Throws:

NullPointerException - if any required attribute was not provided