awssolutionsconstructsawsdynamodbstreamslambdaelasticsearchkibana

package module
v2.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 1, 2022 License: Apache-2.0 Imports: 13 Imported by: 0

README

aws-dynamodbstreams-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 Logo Python aws_solutions_constructs.aws_dynamodbstreams_elasticsearch_kibana
Typescript Logo Typescript @aws-solutions-constructs/aws-dynamodbstreams-lambda-elasticsearch-kibana
Java Logo Java software.amazon.awsconstructs.services.dynamodbstreamslambdaelasticsearchkibana

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

Here is a minimal deployable pattern definition in Typescript:

import { DynamoDBStreamsToLambdaToElasticSearchAndKibana, DynamoDBStreamsToLambdaToElasticSearchAndKibanaProps } from '@aws-solutions-constructs/aws-dynamodbstreams-lambda-elasticsearch-kibana';
import { Aws } from "@aws-cdk/core";

const props: DynamoDBStreamsToLambdaToElasticSearchAndKibanaProps = {
  lambdaFunctionProps: {
      code: lambda.Code.fromAsset(`${__dirname}/lambda`),
      runtime: lambda.Runtime.NODEJS_14_X,
      handler: 'index.handler'
  },
  domainName: 'test-domain',
  // TODO: Ensure the Cognito domain name is globally unique
  cognitoDomainName: 'globallyuniquedomain' + Aws.ACCOUNT_ID;
};

new DynamoDBStreamsToLambdaToElasticSearchAndKibana(this, 'test-dynamodbstreams-lambda-elasticsearch-kibana', props);

Initializer

new DynamoDBStreamsToLambdaToElasticSearchAndKibana(scope: Construct, id: string, props: DynamoDBStreamsToLambdaToElasticSearchAndKibanaProps);

Parameters

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.
dynamoTableProps? dynamodb.TableProps Optional user provided props to override the default props for DynamoDB Table
existingTableInterface? dynamodb.ITable Existing instance of DynamoDB table object or interface, providing both this and dynamoTableProps will cause an error.
dynamoEventSourceProps? aws-lambda-event-sources.DynamoEventSourceProps Optional user provided props to override the default props for DynamoDB Event Source
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
createCloudWatchAlarms boolean Whether to create recommended CloudWatch alarms

Pattern Properties

Name Type Description
dynamoTableInterface dynamodb.ITable Returns an instance of dynamodb.ITable created by the construct
dynamoTable? dynamodb.Table Returns an instance of dynamodb.Table created by the construct. IMPORTANT: If existingTableInterface was provided in Pattern Construct Props, this property will be undefined
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 from DynamoDB stream. A sample function is provided here.

Default settings

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

Amazon DynamoDB Table
  • Set the billing mode for DynamoDB Table to On-Demand (Pay per request)
  • Enable server-side encryption for DynamoDB Table using AWS managed KMS Key
  • Creates a partition key called 'id' for DynamoDB Table
  • Retain the Table when deleting the CloudFormation stack
  • Enable continuous backups and point-in-time recovery
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
  • Enable Failure-Handling features like enable bisect on function Error, set defaults for Maximum Record Age (24 hours) & Maximum Retry Attempts (500) and deploy SQS dead-letter queue as destination on failure
  • Set Environment Variables
    • 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 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.

Documentation

Overview

CDK Constructs for Amazon Dynamodb streams to AWS Lambda to AWS Elasticsearch with Kibana integration

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DynamoDBStreamsToLambdaToElasticSearchAndKibana_IsConstruct 

func DynamoDBStreamsToLambdaToElasticSearchAndKibana_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewDynamoDBStreamsToLambdaToElasticSearchAndKibana_Override 

func NewDynamoDBStreamsToLambdaToElasticSearchAndKibana_Override(d DynamoDBStreamsToLambdaToElasticSearchAndKibana, scope constructs.Construct, id *string, props *DynamoDBStreamsToLambdaToElasticSearchAndKibanaProps)

Types

type DynamoDBStreamsToLambdaToElasticSearchAndKibana 

type DynamoDBStreamsToLambdaToElasticSearchAndKibana interface {
	constructs.Construct
	CloudwatchAlarms() *[]awscloudwatch.Alarm
	DynamoTable() awsdynamodb.Table
	DynamoTableInterface() awsdynamodb.ITable
	ElasticsearchDomain() awselasticsearch.CfnDomain
	ElasticsearchRole() awsiam.Role
	IdentityPool() awscognito.CfnIdentityPool
	LambdaFunction() awslambda.Function
	Node() constructs.Node
	UserPool() awscognito.UserPool
	UserPoolClient() awscognito.UserPoolClient
	ToString() *string
}

func NewDynamoDBStreamsToLambdaToElasticSearchAndKibana 

func NewDynamoDBStreamsToLambdaToElasticSearchAndKibana(scope constructs.Construct, id *string, props *DynamoDBStreamsToLambdaToElasticSearchAndKibanaProps) DynamoDBStreamsToLambdaToElasticSearchAndKibana

type DynamoDBStreamsToLambdaToElasticSearchAndKibanaProps 

type DynamoDBStreamsToLambdaToElasticSearchAndKibanaProps struct {
	// Cognito & ES Domain Name.
	DomainName *string `json:"domainName"`
	// Optional Cognito Domain Name, if provided it will be used for Cognito Domain, and domainName will be used for the Elasticsearch Domain.
	CognitoDomainName *string `json:"cognitoDomainName"`
	// Whether to create recommended CloudWatch alarms.
	CreateCloudWatchAlarms *bool `json:"createCloudWatchAlarms"`
	// Whether to deploy a SQS dead letter queue when a data record reaches the Maximum Retry Attempts or Maximum Record Age, its metadata like shard ID and stream ARN will be sent to an SQS queue.
	DeploySqsDlqQueue *bool `json:"deploySqsDlqQueue"`
	// Optional user provided props to override the default props.
	DynamoEventSourceProps *awslambdaeventsources.DynamoEventSourceProps `json:"dynamoEventSourceProps"`
	// Optional user provided props to override the default props.
	DynamoTableProps *awsdynamodb.TableProps `json:"dynamoTableProps"`
	// Optional user provided props to override the default props for the API Gateway.
	EsDomainProps *awselasticsearch.CfnDomainProps `json:"esDomainProps"`
	// Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.
	ExistingLambdaObj awslambda.Function `json:"existingLambdaObj"`
	// Existing instance of DynamoDB table object, providing both this and `dynamoTableProps` will cause an error.
	ExistingTableInterface awsdynamodb.ITable `json:"existingTableInterface"`
	// User provided props to override the default props for the Lambda function.
	LambdaFunctionProps *awslambda.FunctionProps `json:"lambdaFunctionProps"`
	// Optional user provided properties for the SQS dead letter queue.
	SqsDlqQueueProps *awssqs.QueueProps `json:"sqsDlqQueueProps"`
}

Source Files

View all Source files

Directories

Path Synopsis
Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.
 Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.