Package software.amazon.awscdk.services.grafana

Class CfnWorkspace.Builder

java.lang.Object
software.amazon.awscdk.services.grafana.CfnWorkspace.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnWorkspace>
Enclosing class:
CfnWorkspace
@Stability(Stable) public static final class CfnWorkspace.Builder extends Object implements software.amazon.jsii.Builder<CfnWorkspace>
A fluent builder for CfnWorkspace.

  • Method Details

    • create

      @Stability(Stable) public static CfnWorkspace.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnWorkspace.Builder.

    • accountAccessType

      @Stability(Stable) public CfnWorkspace.Builder accountAccessType(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.

      If this is ORGANIZATION , the OrganizationalUnits 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

    • authenticationProviders

      @Stability(Stable) public CfnWorkspace.Builder authenticationProviders(List<String> 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 .

      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 CfnWorkspace.Builder permissionType(String 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

      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.
      Returns:
      this

    • clientToken

      @Stability(Stable) public CfnWorkspace.Builder clientToken(String 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

    • dataSources

      @Stability(Stable) public 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.

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

    • description

      @Stability(Stable) public CfnWorkspace.Builder description(String description)
      The user-defined description of the workspace.

      Parameters:
      description - The user-defined description of the workspace. This parameter is required.
      Returns:
      this

    • grafanaVersion

      @Stability(Stable) public CfnWorkspace.Builder grafanaVersion(String grafanaVersion)
      Specifies the version of Grafana to support in the new workspace.

      Supported values are 8.4 and 9.4 .

      Parameters:
      grafanaVersion - Specifies the version of Grafana to support in the new workspace. This parameter is required.
      Returns:
      this

    • name

      @Stability(Stable) public CfnWorkspace.Builder name(String name)
      The name of the workspace.

      Parameters:
      name - The name of the workspace. This parameter is required.
      Returns:
      this

    • 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

    • 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

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

      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

    • 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

    • organizationRoleName

      @Stability(Stable) public CfnWorkspace.Builder organizationRoleName(String 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

    • roleArn

      @Stability(Stable) public CfnWorkspace.Builder roleArn(String 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

    • samlConfiguration

      @Stability(Stable) public CfnWorkspace.Builder 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 the Admin and Editor 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 the Admin and Editor roles in the workspace. This parameter is required.
      Returns:
      this

    • 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 the Admin and Editor 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 the Admin and Editor roles in the workspace. This parameter is required.
      Returns:
      this

    • stackSetName

      @Stability(Stable) public CfnWorkspace.Builder stackSetName(String 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

    • vpcConfiguration

      @Stability(Stable) public CfnWorkspace.Builder vpcConfiguration(IResolvable 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

    • 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

    • build

      @Stability(Stable) public CfnWorkspace build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnWorkspace>
      Returns:
      a newly built instance of CfnWorkspace.