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.69.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.69-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.69.tar.gz.

File metadata

File hashes

Hashes for robhan_cdk_lib_aws_grafana-0.0.69.tar.gz
Algorithm Hash digest
SHA256 261ce2a0b5ee73c976ccff91ea12eead12856f694311080d899b313c335566ef
MD5 673984971b2fbbb24812f387fb1f279b
BLAKE2b-256 079d139d7e243b2c04b6072a88627d9b30d32058210e93657089947eede2b8c3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for robhan_cdk_lib_aws_grafana-0.0.69-py3-none-any.whl
Algorithm Hash digest
SHA256 a048c9a6962c0a353d054f9afc8ee6f4bf3334300403fb578b95266303240bd1
MD5 46d0408b93730fbbfb2f6ed6dfd1c984
BLAKE2b-256 3d1232e7b1596a4225e84a5d180d071a03a63ff142e414ea4a8cf402feaa51e9

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