@robhan-cdk-lib/aws_grafana 0.1.0 → 0.1.1

package/.jsii

@@ -9404,7 +9404,7 @@
   },
   "name": "@robhan-cdk-lib/aws_grafana",
   "readme": {
-    "markdown": "# @robhan-cdk-lib/aws_grafana\n\nAWS Cloud Development Kit (CDK) constructs for Amazon Managed Grafana.\n\nIn [aws-cdk-lib.aws_grafana](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_grafana-readme.html), there currently only exist L1 constructs for Amazon Managed Grafana.\n\nWhile helpful, they miss convenience like:\n\n- advanced parameter checking (min/max number values, string lengths, array lengths...) before CloudFormation deployment\n- proper parameter typing, e.g. enum values instead of strings\n- simply referencing other constructs instead of e.g. ARN strings\n\nThose features are implemented here.\n\nThe CDK maintainers explain that [publishing your own package](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md#publishing-your-own-package) is \"by far the strongest signal you can give to the CDK team that a feature should be included within the core aws-cdk packages\".\n\nThis project aims to develop aws_grafana constructs to a maturity that can potentially be accepted to the CDK core.\n\nIt is not supported by AWS and is not endorsed by them. Please file issues in the [GitHub repository](https://github.com/robert-hanuschke/cdk-aws_grafana/issues) if you find any.\n\n## Example use\n\n```typescript\nimport * as cdk from \"aws-cdk-lib\";\nimport { Construct } from \"constructs\";\nimport {\n  AccountAccessType,\n  AuthenticationProviders,\n  PermissionTypes,\n  Workspace,\n} from \"@robhan-cdk-lib/aws_grafana\";\nimport { Role, ServicePrincipal } from \"aws-cdk-lib/aws-iam\";\n\nexport class AwsGrafanaCdkStack extends cdk.Stack {\n  constructor(scope: Construct, id: string, props?: cdk.StackProps) {\n    super(scope, id, props);\n\n    const grafanaRole = new Role(this, \"GrafanaWorkspaceRole\", {\n      assumedBy: new ServicePrincipal(\"grafana.amazonaws.com\"),\n      description: \"Role for Amazon Managed Grafana Workspace\",\n    });\n\n    const workspace = new Workspace(this, \"Workspace\", {\n      accountAccessType: AccountAccessType.CURRENT_ACCOUNT,\n      authenticationProviders: [AuthenticationProviders.AWS_SSO],\n      permissionType: PermissionTypes.SERVICE_MANAGED,\n      role: grafanaRole,\n    });\n  }\n}\n```\n\n## License\n\nMIT\n"
+    "markdown": "# @robhan-cdk-lib/aws_grafana\n\nAWS Cloud Development Kit (CDK) constructs for Amazon Managed Grafana.\n\nIn [aws-cdk-lib.aws_grafana](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_grafana-readme.html), there currently only exist L1 constructs for Amazon Managed Grafana.\n\nWhile helpful, they miss convenience like:\n\n- proper parameter typing, e.g. enum values instead of strings\n- simply referencing other constructs instead of e.g. ARN strings\n\nThose features are implemented here.\n\nParameter constraints (string lengths, allowed patterns, array sizes, etc.)\nare validated by CloudFormation at deploy time.\n\nThe CDK maintainers explain that [publishing your own package](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md#publishing-your-own-package) is \"by far the strongest signal you can give to the CDK team that a feature should be included within the core aws-cdk packages\".\n\nThis project aims to develop aws_grafana constructs to a maturity that can potentially be accepted to the CDK core.\n\nIt is not supported by AWS and is not endorsed by them. Please file issues in the [GitHub repository](https://github.com/robert-hanuschke/cdk-aws_grafana/issues) if you find any.\n\n## Example use\n\n```typescript\nimport * as cdk from \"aws-cdk-lib\";\nimport { Construct } from \"constructs\";\nimport {\n  AccountAccessType,\n  AuthenticationProviders,\n  PermissionTypes,\n  Workspace,\n} from \"@robhan-cdk-lib/aws_grafana\";\nimport { Role, ServicePrincipal } from \"aws-cdk-lib/aws-iam\";\n\nexport class AwsGrafanaCdkStack extends cdk.Stack {\n  constructor(scope: Construct, id: string, props?: cdk.StackProps) {\n    super(scope, id, props);\n\n    const grafanaRole = new Role(this, \"GrafanaWorkspaceRole\", {\n      assumedBy: new ServicePrincipal(\"grafana.amazonaws.com\"),\n      description: \"Role for Amazon Managed Grafana Workspace\",\n    });\n\n    const workspace = new Workspace(this, \"Workspace\", {\n      accountAccessType: AccountAccessType.CURRENT_ACCOUNT,\n      authenticationProviders: [AuthenticationProviders.AWS_SSO],\n      permissionType: PermissionTypes.SERVICE_MANAGED,\n      role: grafanaRole,\n    });\n  }\n}\n```\n\n## License\n\nMIT\n"
   },
   "repository": {
     "type": "git",
@@ -12656,6 +12656,6 @@
       "symbolId": "src/workspace:WorkspaceProps"
     }
   },
-  "version": "0.1.0",
-  "fingerprint": "bWz0CxkQxbFPKjJAYmap6lfTY+PHsKnFJHrNz8LFAW0="
+  "version": "0.1.1",
+  "fingerprint": "wmnTdO0ac+MxOOgPzmL06QD28m/pEedo4nEV9d8HAHc="
 }

package/README.md

@@ -6,12 +6,14 @@ In [aws-cdk-lib.aws_grafana](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk
 
 While helpful, they miss convenience like:
 
-- advanced parameter checking (min/max number values, string lengths, array lengths...) before CloudFormation deployment
 - proper parameter typing, e.g. enum values instead of strings
 - simply referencing other constructs instead of e.g. ARN strings
 
 Those features are implemented here.
 
+Parameter constraints (string lengths, allowed patterns, array sizes, etc.)
+are validated by CloudFormation at deploy time.
+
 The CDK maintainers explain that [publishing your own package](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md#publishing-your-own-package) is "by far the strongest signal you can give to the CDK team that a feature should be included within the core aws-cdk packages".
 
 This project aims to develop aws_grafana constructs to a maturity that can potentially be accepted to the CDK core.

package/lib/workspace-base.js

@@ -139,7 +139,7 @@ var Status;
     Status["LICENSE_REMOVAL_FAILED"] = "LICENSE_REMOVAL_FAILED";
 })(Status || (exports.Status = Status = {}));
 class WorkspaceBase extends aws_cdk_lib_1.Resource {
-    static [JSII_RTTI_SYMBOL_1] = { fqn: "@robhan-cdk-lib/aws_grafana.WorkspaceBase", version: "0.1.0" };
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "@robhan-cdk-lib/aws_grafana.WorkspaceBase", version: "0.1.1" };
     getWorkspaceArn(workspaceId) {
         return this.stack.formatArn({
             service: 'grafana',

package/lib/workspace.js

@@ -12,7 +12,7 @@ const IS_WORKSPACE = Symbol.for('@robhan-cdk-lib/aws_grafana.Workspace');
  * to run the Grafana server.
  */
 class Workspace extends workspace_base_1.WorkspaceBase {
-    static [JSII_RTTI_SYMBOL_1] = { fqn: "@robhan-cdk-lib/aws_grafana.Workspace", version: "0.1.0" };
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "@robhan-cdk-lib/aws_grafana.Workspace", version: "0.1.1" };
     static isWorkspace(x) {
         return IS_WORKSPACE in x;
     }

package/package.json

@@ -82,7 +82,7 @@
   "main": "lib/index.js",
   "license": "MIT",
   "stability": "stable",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "jest": {
     "coverageProvider": "v8",
     "testMatch": [