Skip to main content

AWS CDK Construct Library for Grafana

Project description

@robhan-cdk-lib/aws_grafana

AWS Cloud Development Kit (CDK) constructs for Amazon Managed Grafana.

In aws-cdk-lib.aws_grafana, there currently only exist L1 constructs for Amazon Managed Grafana.

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.

The CDK maintainers explain that 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.

It is not supported by AWS and is not endorsed by them. Please file issues in the GitHub repository if you find any.

Example use

import * as cdk from "aws-cdk-lib";
import { Construct } from "constructs";
import {
  AccountAccessType,
  AuthenticationProviders,
  PermissionTypes,
  Workspace,
} from "@robhan-cdk-lib/aws_grafana";
import { Role, ServicePrincipal } from "aws-cdk-lib/aws-iam";

export class AwsGrafanaCdkStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    const grafanaRole = new Role(this, "GrafanaWorkspaceRole", {
      assumedBy: new ServicePrincipal("grafana.amazonaws.com"),
      description: "Role for Amazon Managed Grafana Workspace",
    });

    const workspace = new Workspace(this, "Workspace", {
      accountAccessType: AccountAccessType.CURRENT_ACCOUNT,
      authenticationProviders: [AuthenticationProviders.AWS_SSO],
      permissionType: PermissionTypes.SERVICE_MANAGED,
      role: grafanaRole,
    });
  }
}

License

MIT

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

robhan_cdk_lib_aws_grafana-0.0.62.tar.gz (84.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

robhan_cdk_lib_aws_grafana-0.0.62-py3-none-any.whl (82.3 kB view details)

Uploaded Python 3

File details

Details for the file robhan_cdk_lib_aws_grafana-0.0.62.tar.gz.

File metadata

File hashes

Hashes for robhan_cdk_lib_aws_grafana-0.0.62.tar.gz
Algorithm Hash digest
SHA256 873127daa2856ad274ac3946b8c387edc524a137fd606ba57666563e7a344b4c
MD5 5308f93330bd7faf02f931a0deb17b14
BLAKE2b-256 acdf36fcd9775afe6ab6c3b0735d3a22e2cdbed28a4cd69bef2d80f78fc03a91

See more details on using hashes here.

File details

Details for the file robhan_cdk_lib_aws_grafana-0.0.62-py3-none-any.whl.

File metadata

File hashes

Hashes for robhan_cdk_lib_aws_grafana-0.0.62-py3-none-any.whl
Algorithm Hash digest
SHA256 498e2ae88714a245cf86707767715ac0725d55613c60658561a1fa88cafcad25
MD5 05ac8e960b602a388bc6c4c0e109da38
BLAKE2b-256 dd65d8402c3eb066177f4c29ec381fd0c0a8505f9a57e8766b81d0ed3a52272d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page