Nearly Perfect Mediocracy

    @aws-solutions-constructs/aws-lambda-elasticsearch-kibana
    TypeScript icon, indicating that this package has built-in type declarations

    2.12.0 • Public • Published

    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

    Overview

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

    Some cluster configurations (e.g VPC access) require the existence of the AWSServiceRoleForAmazonElasticsearchService Service-Linked Role in your account.

    You will need to create the service-linked role using the AWS CLI once in any account using this construct (it may have already been run to support other stacks):

    aws iam create-service-linked-role --aws-service-name es.amazonaws.com
    

    Here is a minimal deployable pattern definition:

    Typescript

    import { Construct } from 'constructs';
    import { Stack, StackProps, Aws } from 'aws-cdk-lib';
    import { LambdaToElasticSearchAndKibana } from '@aws-solutions-constructs/aws-lambda-elasticsearch-kibana';
    import * as lambda from "aws-cdk-lib/aws-lambda";
    
    const lambdaProps: lambda.FunctionProps = {
      code: lambda.Code.fromAsset(`lambda`),
      runtime: lambda.Runtime.NODEJS_14_X,
      handler: 'index.handler'
    };
    
    new LambdaToElasticSearchAndKibana(this, 'sample', {
      lambdaFunctionProps: lambdaProps,
      domainName: 'testdomain',
      // TODO: Ensure the Cognito domain name is globally unique
      cognitoDomainName: 'globallyuniquedomain' + Aws.ACCOUNT_ID
    });

    Python

    from aws_solutions_constructs.aws_lambda_elasticsearch_kibana import LambdaToElasticSearchAndKibana
    from aws_cdk import (
        aws_lambda as _lambda,
        Aws,
        Stack
    )
    from constructs import Construct
    
    lambda_props = _lambda.FunctionProps(
        code=_lambda.Code.from_asset('lambda'),
        runtime=_lambda.Runtime.PYTHON_3_9,
        handler='index.handler'
    )
    
    LambdaToElasticSearchAndKibana(self, 'sample',
                                lambda_function_props=lambda_props,
                                domain_name='testdomain',
                                # TODO: Ensure the Cognito domain name is globally unique
                                cognito_domain_name='globallyuniquedomain' + Aws.ACCOUNT_ID
                                )

    Java

    import software.constructs.Construct;
    
    import software.amazon.awscdk.Stack;
    import software.amazon.awscdk.StackProps;
    import software.amazon.awscdk.Aws;
    import software.amazon.awscdk.services.lambda.*;
    import software.amazon.awscdk.services.lambda.Runtime;
    import software.amazon.awsconstructs.services.lambdaelasticsearchkibana.*;
    
    new LambdaToElasticSearchAndKibana(this, "sample",
            new LambdaToElasticSearchAndKibanaProps.Builder()
                    .lambdaFunctionProps(new FunctionProps.Builder()
                            .runtime(Runtime.NODEJS_14_X)
                            .code(Code.fromAsset("lambda"))
                            .handler("index.handler")
                            .build())
                    .domainName("testdomain")
                    // TODO: Ensure the Cognito domain name is globally unique
                    .cognitoDomainName("globallyuniquedomain" + Aws.ACCOUNT_ID)
                    .build());

    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.
    existingVpc? ec2.IVpc An optional, existing VPC into which this pattern should be deployed. When deployed in a VPC, the Lambda function will use ENIs in the VPC to access network resources. If an existing VPC is provided, the deployVpc property cannot be true. This uses ec2.IVpc to allow clients to supply VPCs that exist outside the stack using the ec2.Vpc.fromLookup() method.
    vpcProps? ec2.VpcProps Optional user provided properties to override the default properties for the new VPC. enableDnsHostnames, enableDnsSupport, natGateways and subnetConfiguration are set by the pattern, so any values for those properties supplied here will be overrriden. If deployVpc is not true then this property will be ignored.
    deployVpc? boolean Whether to create a new VPC based on vpcProps into which to deploy this pattern. Setting this to true will deploy the minimal, most private VPC to run the pattern:
    • One isolated subnet in each Availability Zone used by the CDK program
    • enableDnsHostnames and enableDnsSupport will both be set to true
    If this property is true then existingVpc cannot be specified. Defaults to false.

    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
    vpc? ec2.IVpc Returns an interface on the VPC used by the pattern (if any). This may be a VPC created by the pattern or the VPC supplied to the pattern constructor.

    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

    Architecture Diagram


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

    Install

    npm i @aws-solutions-constructs/aws-lambda-elasticsearch-kibana

    DownloadsWeekly Downloads

    3,155

    Version

    2.12.0

    License

    Apache-2.0

    Unpacked Size

    539 kB

    Total Files

    31

    Last publish

    Collaborators

    • aws-solutions-constructs-team