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.66.tar.gz (83.8 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.66-py3-none-any.whl (82.0 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for robhan_cdk_lib_aws_grafana-0.0.66.tar.gz
Algorithm Hash digest
SHA256 5c9323a12b5226569d96e236ce66bf48448c77644d60a7dce3dda6f8a5791942
MD5 1454fbee507b4ea479ff696b0c806c15
BLAKE2b-256 7e4190f55eec684d7288e8898e7ec30e4e9b4d39f65aaf8851aba808f73a0fa5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for robhan_cdk_lib_aws_grafana-0.0.66-py3-none-any.whl
Algorithm Hash digest
SHA256 1aab2c8108e68c56e8b1320ec07448ca08403192342c9c48e35fa6561eb8983a
MD5 8e7d61a05f83109eec54d2cd1b59225e
BLAKE2b-256 238134b4c0e2575a8ed0c02917bd9ef2ec793a7cd1c08b5a14a00b4b9b2eff96

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