CDK Constructs for AWS Lambda to AWS Elasticsearch with Kibana integration
Project description
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 |
---|---|
aws_solutions_constructs.aws_lambda_elasticsearch_kibana |
|
@aws-solutions-constructs/aws-lambda-elasticsearch-kibana |
|
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.
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
Hashes for aws-solutions-constructs.aws-lambda-elasticsearch-kibana-1.108.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9c8bcb123e0e82798849fdc382dafce960423bf0a2991a87069533a260a6ffd3 |
|
MD5 | cf5028f2ef09ad07c2c9e571c8ed4c1f |
|
BLAKE2b-256 | b280a6ed106691d8ac9f20133fcee7da6fbb1e6581dd7f68b1ac185546551740 |
Hashes for aws_solutions_constructs.aws_lambda_elasticsearch_kibana-1.108.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 83a669706ceaf47671a5246d69fc222b3cc5c64f035daa4f6c1311fcebe98202 |
|
MD5 | 9ce6eac60c6d6a0c1c86f25ea2636d7b |
|
BLAKE2b-256 | 96240cb4b317db8b3abeb00e5e5fafc0689b1736cc7d54216d0579e74f4f1c41 |