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

Class CfnWorkspacePropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.grafana.CfnWorkspacePropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:59.773Z")
@Stability(Stable)
public class CfnWorkspacePropsMixin
extends Mixin
implements software.constructs.IMixin

Specifies a workspace .

In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces. You don't have to build, package, or deploy any hardware to run the Grafana server.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.grafana.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnWorkspacePropsMixin cfnWorkspacePropsMixin = CfnWorkspacePropsMixin.Builder.create(CfnWorkspaceMixinProps.builder()
         .accountAccessType("accountAccessType")
         .authenticationProviders(List.of("authenticationProviders"))
         .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")
         .permissionType("permissionType")
         .pluginAdminEnabled(false)
         .roleArn("roleArn")
         .samlConfiguration(SamlConfigurationProperty.builder()
                 .allowedOrganizations(List.of("allowedOrganizations"))
                 .assertionAttributes(AssertionAttributesProperty.builder()
                         .email("email")
                         .groups("groups")
                         .login("login")
                         .name("name")
                         .org("org")
                         .role("role")
                         .build())
                 .idpMetadata(IdpMetadataProperty.builder()
                         .url("url")
                         .xml("xml")
                         .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())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnWorkspacePropsMixin.AssertionAttributesProperty	A structure that defines which attributes in the IdP assertion are to be used to define information about the users authenticated by the IdP to use the workspace.
static final class	CfnWorkspacePropsMixin.Builder	A fluent builder for CfnWorkspacePropsMixin.
static interface	CfnWorkspacePropsMixin.IdpMetadataProperty	A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.
static interface	CfnWorkspacePropsMixin.NetworkAccessControlProperty	The configuration settings for in-bound network access to your workspace.
static interface	CfnWorkspacePropsMixin.RoleValuesProperty	This structure defines which groups defined in the SAML assertion attribute are to be mapped to the Grafana Admin and Editor roles in the workspace.
static interface	CfnWorkspacePropsMixin.SamlConfigurationProperty	A structure containing information about how this workspace works with SAML.
static interface	CfnWorkspacePropsMixin.VpcConfigurationProperty	The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnWorkspacePropsMixin(CfnWorkspaceMixinProps props)	Create a mixin to apply properties to AWS::Grafana::Workspace.
	CfnWorkspacePropsMixin(CfnWorkspaceMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::Grafana::Workspace.
protected	CfnWorkspacePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnWorkspacePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnWorkspaceMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnWorkspacePropsMixin

protected CfnWorkspacePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnWorkspacePropsMixin

protected CfnWorkspacePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnWorkspacePropsMixin

@Stability(Stable)
public CfnWorkspacePropsMixin(@NotNull
 CfnWorkspaceMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::Grafana::Workspace.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnWorkspacePropsMixin

@Stability(Stable)
public CfnWorkspacePropsMixin(@NotNull
 CfnWorkspaceMixinProps props)

Create a mixin to apply properties to AWS::Grafana::Workspace.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnWorkspaceMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()