@robhan-cdk-lib/aws_grafana 0.0.1 → 0.0.2

package/.jsii

@@ -4418,7 +4418,7 @@
       "kind": "enum",
       "locationInModule": {
         "filename": "src/workspace.ts",
-        "line": 362
+        "line": 399
       },
       "members": [
         {
@@ -4566,7 +4566,7 @@
       "kind": "enum",
       "locationInModule": {
         "filename": "src/workspace.ts",
-        "line": 377
+        "line": 414
       },
       "members": [
         {
@@ -4716,46 +4716,33 @@
       "assembly": "@robhan-cdk-lib/aws_grafana",
       "base": "constructs.Construct",
       "docs": {
-        "remarks": "This class provides a high-level abstraction for creating and managing\nAmazon Managed Grafana workspaces using AWS CDK.",
+        "remarks": "In a workspace, you can create Grafana dashboards and visualizations to\nanalyze your metrics, logs, and traces. You don't have to build, package, or deploy any hardware\nto run the Grafana server.",
         "stability": "stable",
-        "summary": "Represents an Amazon Managed Grafana workspace."
+        "summary": "Specifies a workspace."
       },
       "fqn": "@robhan-cdk-lib/aws_grafana.Workspace",
       "initializer": {
         "docs": {
-          "custom": {
-            "throws": "Error if any of the provided properties fail validation"
-          },
-          "stability": "stable",
-          "summary": "Creates a new Amazon Managed Grafana workspace."
+          "stability": "stable"
         },
         "locationInModule": {
           "filename": "src/workspace.ts",
-          "line": 1152
+          "line": 1206
         },
         "parameters": [
           {
-            "docs": {
-              "summary": "- The scope in which to define this construct."
-            },
             "name": "scope",
             "type": {
               "fqn": "constructs.Construct"
             }
           },
           {
-            "docs": {
-              "summary": "- The scoped construct ID."
-            },
             "name": "id",
             "type": {
               "primitive": "string"
             }
           },
           {
-            "docs": {
-              "summary": "- Configuration properties for the workspace."
-            },
             "name": "props",
             "type": {
               "fqn": "@robhan-cdk-lib/aws_grafana.WorkspaceProps"
@@ -4766,19 +4753,20 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/workspace.ts",
-        "line": 440
+        "line": 476
       },
       "name": "Workspace",
       "properties": [
         {
           "docs": {
+            "remarks": "If this is\nORGANIZATION, the OrganizationalUnits parameter specifies which organizational units the\nworkspace can access.",
             "stability": "stable",
-            "summary": "The type of account access for the workspace."
+            "summary": "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."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 1021
+            "line": 1060
           },
           "name": "accountAccessType",
           "type": {
@@ -4788,12 +4776,12 @@
         {
           "docs": {
             "stability": "stable",
-            "summary": "Authentication providers enabled for the workspace."
+            "summary": "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."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 1026
+            "line": 1066
           },
           "name": "authenticationProviders",
           "type": {
@@ -4808,12 +4796,12 @@
         {
           "docs": {
             "stability": "stable",
-            "summary": "Timestamp when the workspace was created."
+            "summary": "The date that the workspace was created."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 1106
+            "line": 1168
           },
           "name": "creationTimestamp",
           "type": {
@@ -4823,12 +4811,12 @@
         {
           "docs": {
             "stability": "stable",
-            "summary": "Endpoint URL for the Grafana workspace."
+            "summary": "The URL that users can use to access the Grafana console in the workspace."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 1111
+            "line": 1173
           },
           "name": "endpoint",
           "type": {
@@ -4838,12 +4826,12 @@
         {
           "docs": {
             "stability": "stable",
-            "summary": "Grafana version running in the workspace."
+            "summary": "Specifies the version of Grafana supported by this workspace."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 1116
+            "line": 1178
           },
           "name": "grafanaVersion",
           "type": {
@@ -4853,12 +4841,12 @@
         {
           "docs": {
             "stability": "stable",
-            "summary": "Unique identifier for the workspace."
+            "summary": "The unique ID of this workspace."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 1121
+            "line": 1183
           },
           "name": "id",
           "type": {
@@ -4868,12 +4856,12 @@
         {
           "docs": {
             "stability": "stable",
-            "summary": "Timestamp when the workspace was last modified."
+            "summary": "The most recent date that the workspace was modified."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 1126
+            "line": 1188
           },
           "name": "modificationTimestamp",
           "type": {
@@ -4882,13 +4870,14 @@
         },
         {
           "docs": {
+            "remarks": "If this is CUSTOMER_MANAGED, you must manage those roles and permissions yourself.\n\nIf you are working with a workspace in a member account of an organization and that account is\nnot a delegated administrator account, and you want the workspace to access data sources in\nother AWS accounts in the organization, this parameter must be set to CUSTOMER_MANAGED.",
             "stability": "stable",
-            "summary": "Permission type for the workspace."
+            "summary": "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."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 1071
+            "line": 1125
           },
           "name": "permissionType",
           "type": {
@@ -4898,12 +4887,12 @@
         {
           "docs": {
             "stability": "stable",
-            "summary": "Status of SAML configuration for the workspace."
+            "summary": "Specifies whether the workspace's SAML configuration is complete."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 1131
+            "line": 1193
           },
           "name": "samlConfigurationStatus",
           "type": {
@@ -4913,12 +4902,12 @@
         {
           "docs": {
             "stability": "stable",
-            "summary": "SSO client ID for the workspace."
+            "summary": "The ID of the IAM Identity Center-managed application that is created by Amazon Managed Grafana."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 1136
+            "line": 1199
           },
           "name": "ssoClientId",
           "type": {
@@ -4928,12 +4917,12 @@
         {
           "docs": {
             "stability": "stable",
-            "summary": "Current status of the workspace."
+            "summary": "The current status of the workspace."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 1141
+            "line": 1204
           },
           "name": "status",
           "type": {
@@ -4943,12 +4932,12 @@
         {
           "docs": {
             "stability": "stable",
-            "summary": "Client token used for idempotent workspace creation."
+            "summary": "A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 1031
+            "line": 1071
           },
           "name": "clientToken",
           "optional": true,
@@ -4958,13 +4947,14 @@
         },
         {
           "docs": {
+            "remarks": "This list is only used when the workspace was created through the AWS console, and the\npermissionType is SERVICE_MANAGED.",
             "stability": "stable",
-            "summary": "Data sources enabled for the workspace."
+            "summary": "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."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 1036
+            "line": 1080
           },
           "name": "dataSources",
           "optional": true,
@@ -4980,12 +4970,12 @@
         {
           "docs": {
             "stability": "stable",
-            "summary": "Description of the workspace."
+            "summary": "The user-defined description of the workspace."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 1041
+            "line": 1085
           },
           "name": "description",
           "optional": true,
@@ -4996,12 +4986,12 @@
         {
           "docs": {
             "stability": "stable",
-            "summary": "Name of the workspace."
+            "summary": "The name of the workspace."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 1046
+            "line": 1090
           },
           "name": "name",
           "optional": true,
@@ -5012,12 +5002,12 @@
         {
           "docs": {
             "stability": "stable",
-            "summary": "Network access control configuration for the workspace."
+            "summary": "The configuration settings for network access to your workspace."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 1051
+            "line": 1095
           },
           "name": "networkAccessControl",
           "optional": true,
@@ -5028,12 +5018,12 @@
         {
           "docs": {
             "stability": "stable",
-            "summary": "Notification destinations enabled for the workspace."
+            "summary": "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."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 1056
+            "line": 1101
           },
           "name": "notificationDestinations",
           "optional": true,
@@ -5049,12 +5039,12 @@
         {
           "docs": {
             "stability": "stable",
-            "summary": "Organizational units included in the workspace."
+            "summary": "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."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 1061
+            "line": 1107
           },
           "name": "organizationalUnits",
           "optional": true,
@@ -5070,12 +5060,12 @@
         {
           "docs": {
             "stability": "stable",
-            "summary": "Name of the IAM role used for the organization."
+            "summary": "The name of the IAM role that is used to access resources through Organizations."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 1066
+            "line": 1112
           },
           "name": "organizationRoleName",
           "optional": true,
@@ -5085,13 +5075,14 @@
         },
         {
           "docs": {
+            "remarks": "Setting to true allows workspace\nadmins to install, uninstall, and update plugins from within the Grafana workspace.\n\nThis option is only valid for workspaces that support Grafana version 9 or newer.",
             "stability": "stable",
-            "summary": "Whether the Grafana plugin admin page is enabled."
+            "summary": "Whether plugin administration is enabled in the workspace."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 1076
+            "line": 1133
           },
           "name": "pluginAdminEnabled",
           "optional": true,
@@ -5102,12 +5093,12 @@
         {
           "docs": {
             "stability": "stable",
-            "summary": "IAM role used for the workspace."
+            "summary": "The IAM role that grants permissions to the AWS resources that the workspace will view data from."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 1081
+            "line": 1139
           },
           "name": "role",
           "optional": true,
@@ -5118,12 +5109,12 @@
         {
           "docs": {
             "stability": "stable",
-            "summary": "SAML configuration for the workspace."
+            "summary": "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."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 1086
+            "line": 1146
           },
           "name": "samlConfiguration",
           "optional": true,
@@ -5134,12 +5125,12 @@
         {
           "docs": {
             "stability": "stable",
-            "summary": "Name of the CloudFormation stack set used."
+            "summary": "The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 1091
+            "line": 1152
           },
           "name": "stackSetName",
           "optional": true,
@@ -5150,12 +5141,12 @@
         {
           "docs": {
             "stability": "stable",
-            "summary": "VPC configuration for the workspace."
+            "summary": "The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 1096
+            "line": 1158
           },
           "name": "vpcConfiguration",
           "optional": true,
@@ -5184,14 +5175,14 @@
         {
           "abstract": true,
           "docs": {
-            "remarks": "Required field.",
+            "remarks": "If this is\nORGANIZATION, the OrganizationalUnits parameter specifies which organizational units the\nworkspace can access.\n\nRequired field.",
             "stability": "stable",
-            "summary": "Type of account access for the workspace."
+            "summary": "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."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 268
+            "line": 272
           },
           "name": "accountAccessType",
           "type": {
@@ -5203,12 +5194,12 @@
           "docs": {
             "remarks": "Required field.",
             "stability": "stable",
-            "summary": "Authentication providers to enable for the workspace."
+            "summary": "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."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 274
+            "line": 280
           },
           "name": "authenticationProviders",
           "type": {
@@ -5223,14 +5214,14 @@
         {
           "abstract": true,
           "docs": {
-            "remarks": "Required field.",
+            "remarks": "If this is CUSTOMER_MANAGED, you must manage those roles and permissions yourself.\n\nIf you are working with a workspace in a member account of an organization and that account is\nnot a delegated administrator account, and you want the workspace to access data sources in\nother AWS accounts in the organization, this parameter must be set to CUSTOMER_MANAGED.\n\nRequired field.",
             "stability": "stable",
-            "summary": "Permission type for the workspace."
+            "summary": "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."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 330
+            "line": 358
           },
           "name": "permissionType",
           "type": {
@@ -5242,12 +5233,12 @@
           "docs": {
             "remarks": "Must be 1-64 characters long and contain only printable ASCII characters.",
             "stability": "stable",
-            "summary": "Client token for idempotent workspace creation."
+            "summary": "A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 280
+            "line": 287
           },
           "name": "clientToken",
           "optional": true,
@@ -5258,13 +5249,14 @@
         {
           "abstract": true,
           "docs": {
+            "remarks": "This list is only used when the workspace was created through the AWS console, and the\npermissionType is SERVICE_MANAGED.",
             "stability": "stable",
-            "summary": "List of data sources to enable for the workspace."
+            "summary": "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."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 285
+            "line": 295
           },
           "name": "dataSources",
           "optional": true,
@@ -5282,12 +5274,12 @@
           "docs": {
             "remarks": "Maximum length of 2048 characters.",
             "stability": "stable",
-            "summary": "Description of the workspace."
+            "summary": "The user-defined description of the workspace."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 291
+            "line": 302
           },
           "name": "description",
           "optional": true,
@@ -5298,14 +5290,14 @@
         {
           "abstract": true,
           "docs": {
-            "remarks": "Must be 1-255 characters long.",
+            "remarks": "Defaults to the latest version\non create (for example, 9.4), or the current version of the workspace on update.\nCan only be used to upgrade (for example, from 8.4 to 9.4), not downgrade (for example, from\n9.4 to 8.4).\n\nMust be 1-255 characters long.",
             "stability": "stable",
-            "summary": "Grafana version for the workspace."
+            "summary": "Specifies the version of Grafana to support in the workspace."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 297
+            "line": 312
           },
           "name": "grafanaVersion",
           "optional": true,
@@ -5316,14 +5308,14 @@
         {
           "abstract": true,
           "docs": {
-            "remarks": "Must be 1-255 characters long and contain only alphanumeric characters, hyphens, dots, underscores, and tildes.",
+            "remarks": "Must be 1-255 characters long and contain only alphanumeric characters, hyphens, dots,\nunderscores, and tildes.",
             "stability": "stable",
-            "summary": "Name of the workspace."
+            "summary": "The name of the workspace."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 303
+            "line": 320
           },
           "name": "name",
           "optional": true,
@@ -5335,12 +5327,12 @@
           "abstract": true,
           "docs": {
             "stability": "stable",
-            "summary": "Network access control configuration for the workspace."
+            "summary": "The configuration settings for network access to your workspace."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 308
+            "line": 325
           },
           "name": "networkAccessControl",
           "optional": true,
@@ -5352,12 +5344,12 @@
           "abstract": true,
           "docs": {
             "stability": "stable",
-            "summary": "Notification destinations to enable for the workspace."
+            "summary": "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."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 313
+            "line": 331
           },
           "name": "notificationDestinations",
           "optional": true,
@@ -5374,12 +5366,12 @@
           "abstract": true,
           "docs": {
             "stability": "stable",
-            "summary": "List of organizational units to include in the workspace."
+            "summary": "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."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 318
+            "line": 337
           },
           "name": "organizationalUnits",
           "optional": true,
@@ -5402,7 +5394,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 324
+            "line": 343
           },
           "name": "organizationRoleName",
           "optional": true,
@@ -5413,14 +5405,14 @@
         {
           "abstract": true,
           "docs": {
-            "remarks": "Default: false",
+            "remarks": "Setting to true allows workspace\nadmins to install, uninstall, and update plugins from within the Grafana workspace.\n\nThis option is only valid for workspaces that support Grafana version 9 or newer.\n\nDefault: false",
             "stability": "stable",
-            "summary": "Whether to enable the Grafana plugin admin page."
+            "summary": "Whether plugin administration is enabled in the workspace."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 336
+            "line": 368
           },
           "name": "pluginAdminEnabled",
           "optional": true,
@@ -5432,12 +5424,12 @@
           "abstract": true,
           "docs": {
             "stability": "stable",
-            "summary": "IAM role to use for the workspace."
+            "summary": "The IAM role that grants permissions to the AWS resources that the workspace will view data from."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 341
+            "line": 374
           },
           "name": "role",
           "optional": true,
@@ -5449,12 +5441,12 @@
           "abstract": true,
           "docs": {
             "stability": "stable",
-            "summary": "SAML configuration for the workspace."
+            "summary": "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."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 346
+            "line": 381
           },
           "name": "samlConfiguration",
           "optional": true,
@@ -5466,12 +5458,12 @@
           "abstract": true,
           "docs": {
             "stability": "stable",
-            "summary": "Name of the CloudFormation stack set to use."
+            "summary": "The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 351
+            "line": 387
           },
           "name": "stackSetName",
           "optional": true,
@@ -5483,12 +5475,12 @@
           "abstract": true,
           "docs": {
             "stability": "stable",
-            "summary": "VPC configuration for the workspace."
+            "summary": "The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/workspace.ts",
-            "line": 356
+            "line": 393
           },
           "name": "vpcConfiguration",
           "optional": true,
@@ -5500,6 +5492,6 @@
       "symbolId": "src/workspace:WorkspaceProps"
     }
   },
-  "version": "0.0.1",
-  "fingerprint": "Hq3auGM1GsxLzqQnSbhddJh/wbaROJ9Jo+UyaqtAhZI="
+  "version": "0.0.2",
+  "fingerprint": "sdTJyPlwHSgR2hoVTe2r9y5X54eciu+qFiECmYItUMQ="
 }