Interface CfnWorkspaceProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnWorkspaceProps.Jsii$Proxy
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 ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnWorkspaceProps
static final class
An implementation forCfnWorkspaceProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnWorkspaceProps.Builder
builder()
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.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
A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.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
The user-defined description of the workspace.default String
Specifies the version of Grafana to support in the workspace.default String
getName()
The name of the workspace.default Object
The configuration settings for network access to your workspace.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.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
The name of the IAM role that is used to access resources through Organizations.If this isSERVICE_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
Whether plugin administration is enabled in the workspace.default String
The IAM role that grants permissions to the AWS resources that the workspace will view data from.default Object
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 theAdmin
andEditor
roles in the workspace.default String
The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace.default Object
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
-
Method Details
-
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.If this is
ORGANIZATION
, theOrganizationalUnits
parameter specifies which organizational units the workspace can access.- See Also:
-
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. For more information, see User authentication in Amazon Managed Grafana .Allowed Values :
AWS_SSO | SAML
- See Also:
-
getPermissionType
If this isSERVICE_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
- See Also:
-
getClientToken
A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.- See Also:
-
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.This list is only used when the workspace was created through the AWS console, and the
permissionType
isSERVICE_MANAGED
.- See Also:
-
getDescription
The user-defined description of the workspace.- See Also:
-
getGrafanaVersion
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.
- See Also:
-
getName
The name of the workspace.- See Also:
-
getNetworkAccessControl
The configuration settings for network access to your workspace.- See Also:
-
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.AllowedValues :
SNS
- See Also:
-
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.- See Also:
-
getOrganizationRoleName
The name of the IAM role that is used to access resources through Organizations.- See Also:
-
getPluginAdminEnabled
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.
- See Also:
-
getRoleArn
The IAM role that grants permissions to the AWS resources that the workspace will view data from.This role must already exist.
- See Also:
-
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 theAdmin
andEditor
roles in the workspace.- See Also:
-
getStackSetName
The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace.- See Also:
-
getVpcConfiguration
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).
- See Also:
-
builder
- Returns:
- a
CfnWorkspaceProps.Builder
ofCfnWorkspaceProps
-