Skip to main content

CDK Constructs for AWS Lambda to AWS Elasticsearch with Kibana integration

Project description

aws-lambda-elasticsearch-kibana module

---

Stability: Experimental

All classes are under active development and subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.


Reference Documentation: https://docs.aws.amazon.com/solutions/latest/constructs/
Language Package
Python Logo Python aws_solutions_constructs.aws_lambda_elasticsearch_kibana
Typescript Logo Typescript @aws-solutions-constructs/aws-lambda-elasticsearch-kibana
Java Logo Java software.amazon.awsconstructs.services.lambdaelasticsearchkibana

This AWS Solutions Construct implements the AWS Lambda function and Amazon Elasticsearch Service with the least privileged permissions.

Here is a minimal deployable pattern definition in Typescript:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
from aws_solutions_constructs.aws_lambda_elasticsearch_kibana import LambdaToElasticSearchAndKibana
from aws_cdk.core import Aws

lambda_props = {
    "code": lambda_.Code.from_asset(f"{__dirname}/lambda"),
    "runtime": lambda_.Runtime.NODEJS_12_X,
    "handler": "index.handler"
}

LambdaToElasticSearchAndKibana(self, "test-lambda-elasticsearch-kibana",
    lambda_function_props=lambda_props,
    domain_name="test-domain",
    # TODO: Ensure the Cognito domain name is globally unique
    cognito_domain_name="globallyuniquedomain" + Aws.ACCOUNT_ID
)

Initializer

new LambdaToElasticSearchAndKibana(scope: Construct, id: string, props: LambdaToElasticSearchAndKibanaProps);

Parameters

Pattern Construct Props

Name Type Description
existingLambdaObj? lambda.Function Existing instance of Lambda Function object, if this is set then the lambdaFunctionProps is ignored.
lambdaFunctionProps? lambda.FunctionProps User provided props to override the default props for the Lambda function.
esDomainProps? elasticsearch.CfnDomainProps Optional user provided props to override the default props for the Elasticsearch Service
domainName string Domain name for the Cognito and the Elasticsearch Service
cognitoDomainName? string Optional Cognito Domain Name, if provided it will be used for Cognito Domain, and domainName will be used for the Elasticsearch Domain
createCloudWatchAlarms boolean Whether to create recommended CloudWatch alarms

Pattern Properties

Name Type Description
lambdaFunction lambda.Function Returns an instance of lambda.Function created by the construct
userPool cognito.UserPool Returns an instance of cognito.UserPool created by the construct
userPoolClient cognito.UserPoolClient Returns an instance of cognito.UserPoolClient created by the construct
identityPool cognito.CfnIdentityPool Returns an instance of cognito.CfnIdentityPool created by the construct
elasticsearchDomain elasticsearch.CfnDomain Returns an instance of elasticsearch.CfnDomain created by the construct
elasticsearchDomain iam.Role Returns an instance of iam.Role created by the construct for elasticsearch.CfnDomain
cloudwatchAlarms? cloudwatch.Alarm[] Returns a list of cloudwatch.Alarm created by the construct

Lambda Function

This pattern requires a lambda function that can post data into the Elasticsearch. A sample function is provided here.

Default settings

Out of the box implementation of the Construct without any override will set the following defaults:

AWS Lambda Function

  • Configure limited privilege access IAM role for Lambda function
  • Enable reusing connections with Keep-Alive for NodeJs Lambda function
  • Enable X-Ray Tracing

Amazon Cognito

  • Set password policy for User Pools
  • Enforce the advanced security mode for User Pools

Amazon Elasticsearch Service

  • Deploy best practices CloudWatch Alarms for the Elasticsearch Domain
  • Secure the Kibana dashboard access with Cognito User Pools
  • Enable server-side encryption for Elasticsearch Domain using AWS managed KMS Key
  • Enable node-to-node encryption for Elasticsearch Domain
  • Configure the cluster for the Amazon ES domain

Architecture

Architecture Diagram


© Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.

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

Built Distribution

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

File details

Details for the file aws-solutions-constructs.aws-lambda-elasticsearch-kibana-1.72.0.tar.gz.

File metadata

File hashes

Hashes for aws-solutions-constructs.aws-lambda-elasticsearch-kibana-1.72.0.tar.gz
Algorithm Hash digest
SHA256 db1cf9846bd3f7014455e57111c75b8bc563815f44b90131738a0a9127139855
MD5 602f32e033d9a1337a3b2f1f2a755042
BLAKE2b-256 5326b7800f7391bd8d0994807c1f48ba55278bc83b6e75974e12c1474616a371

See more details on using hashes here.

File details

Details for the file aws_solutions_constructs.aws_lambda_elasticsearch_kibana-1.72.0-py3-none-any.whl.

File metadata

File hashes

Hashes for aws_solutions_constructs.aws_lambda_elasticsearch_kibana-1.72.0-py3-none-any.whl
Algorithm Hash digest
SHA256 65d7f9898eff8493d1b6512d25cb8d1739d344bc1ebd5d642dab1dd4249e04ae
MD5 b967704710cc23bf7de2d95b26d73198
BLAKE2b-256 05001b93a2142c79a4c8b2e7bf351c83a57b453fa569a9c7c8c8d8fd84bf7a01

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