aws-solutions-constructs.aws-lambda-elasticsearch-kibana 2.0.0rc1

CDK Constructs for AWS Lambda to AWS Elasticsearch with Kibana integration

aws-lambda-elasticsearch-kibana module

---

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	aws_solutions_constructs.aws_lambda_elasticsearch_kibana
Typescript	@aws-solutions-constructs/aws-lambda-elasticsearch-kibana
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

• scope Construct
• id string
• props LambdaToElasticSearchAndKibanaProps

Pattern Construct Props

Name	Type	Description
existingLambdaObj?	lambda.Function	Existing instance of Lambda Function object, providing both this and lambdaFunctionProps will cause an error.
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
domainEndpointEnvironmentVariableName?	string	Optional Name for the ElasticSearch domain endpoint environment variable set for the Lambda function.

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

• Set Environment Variables

  • (default) DOMAIN_ENDPOINT
  • AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)

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

---

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