Package software.amazon.awscdk.services.grafana

Interface CfnWorkspaceProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnWorkspaceProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-12-27T17:02:02.834Z") @Stability(Stable) public interface CfnWorkspaceProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnWorkspace.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.grafana.*;
 CfnWorkspaceProps cfnWorkspaceProps = CfnWorkspaceProps.builder()
         .accountAccessType("accountAccessType")
         .authenticationProviders(List.of("authenticationProviders"))
         .permissionType("permissionType")
         // the properties below are optional
         .clientToken("clientToken")
         .dataSources(List.of("dataSources"))
         .description("description")
         .grafanaVersion("grafanaVersion")
         .name("name")
         .networkAccessControl(NetworkAccessControlProperty.builder()
                 .prefixListIds(List.of("prefixListIds"))
                 .vpceIds(List.of("vpceIds"))
                 .build())
         .notificationDestinations(List.of("notificationDestinations"))
         .organizationalUnits(List.of("organizationalUnits"))
         .organizationRoleName("organizationRoleName")
         .pluginAdminEnabled(false)
         .roleArn("roleArn")
         .samlConfiguration(SamlConfigurationProperty.builder()
                 .idpMetadata(IdpMetadataProperty.builder()
                         .url("url")
                         .xml("xml")
                         .build())
                 // the properties below are optional
                 .allowedOrganizations(List.of("allowedOrganizations"))
                 .assertionAttributes(AssertionAttributesProperty.builder()
                         .email("email")
                         .groups("groups")
                         .login("login")
                         .name("name")
                         .org("org")
                         .role("role")
                         .build())
                 .loginValidityDuration(123)
                 .roleValues(RoleValuesProperty.builder()
                         .admin(List.of("admin"))
                         .editor(List.of("editor"))
                         .build())
                 .build())
         .stackSetName("stackSetName")
         .vpcConfiguration(VpcConfigurationProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnetIds(List.of("subnetIds"))
                 .build())
         .build();

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    CfnWorkspaceProps.Builder
    A builder for CfnWorkspaceProps
    static final class 
    CfnWorkspaceProps.Jsii$Proxy
    An implementation for CfnWorkspaceProps

  • Method Summary

    Modifier and Type
    Method
    Description
    static CfnWorkspaceProps.Builder
    builder()
     
    String
    getAccountAccessType()
    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.
    List<String>
    getAuthenticationProviders()
    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.
    default String
    getClientToken()
    A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
    default List<String>
    getDataSources()
    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.
    default String
    getDescription()
    The user-defined description of the workspace.
    default String
    getGrafanaVersion()
    Specifies the version of Grafana to support in the workspace.
    default String
    getName()
    The name of the workspace.
    default Object
    getNetworkAccessControl()
    The configuration settings for network access to your workspace.
    default List<String>
    getNotificationDestinations()
    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.
    default List<String>
    getOrganizationalUnits()
    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.
    default String
    getOrganizationRoleName()
    The name of the IAM role that is used to access resources through Organizations.
    String
    getPermissionType()
    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.
    default Object
    getPluginAdminEnabled()
    Whether plugin administration is enabled in the workspace.
    default String
    getRoleArn()
    The IAM role that grants permissions to the AWS resources that the workspace will view data from.
    default Object
    getSamlConfiguration()
    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.
    default String
    getStackSetName()
    The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
    default Object
    getVpcConfiguration()
    The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson