@aws-solutions-konstruk/aws-lambda-elasticsearch-kibana
v0.8.1
Published
CDK Constructs for AWS Lambda to AWS Elasticsearch with Kibana integration
Downloads
11
Readme
aws-lambda-elasticsearch-kibana module
This is a developer preview (public beta) 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.
| API Reference:| http://docs.awssolutionsbuilder.com/aws-solutions-konstruk/latest/api/aws-lambda-elasticsearch-kibana/| |:-------------|:-------------|
| Language | Package |
|:-------------|-----------------|
|{: style="height:16px;width:16px"} Python|aws_solutions_konstruk.aws_lambda_elasticsearch_kibana
|
|{: style="height:16px;width:16px"} Typescript|@aws-solutions-konstruk/aws-lambda-elasticsearch-kibana
|
This AWS Solutions Konstruk implements the AWS Lambda function and Amazon Elasticsearch Service with the least privileged permissions.
Here is a minimal deployable pattern definition:
const { LambdaToElasticSearchAndKibana } = require('@aws-solutions-konstruk/aws-lambda-elasticsearch-kibana');
const lambdaProps: lambda.FunctionProps = {
code: lambda.Code.asset(`${__dirname}/lambda`),
runtime: lambda.Runtime.NODEJS_12_X,
handler: 'index.handler'
};
new LambdaToElasticSearchAndKibana(stack, 'test-lambda-elasticsearch-kibana', {
lambdaFunctionProps: lambdaProps,
deployLambda: true,
domainName: 'test-domain'
});
Initializer
new LambdaToElasticSearchAndKibana(scope: Construct, id: string, props: LambdaToElasticSearchAndKibanaProps);
Parameters
- scope
Construct
- id
string
- props
LambdaToElasticSearchAndKibanaProps
Pattern Construct Props
| Name | Type | Description |
|:-------------|:----------------|-----------------|
|deployLambda|boolean
|Whether to create a new Lambda function or use an existing Lambda function|
|existingLambdaObj?|lambda.Function
|Existing instance of Lambda Function object|
|lambdaFunctionProps?|lambda.FunctionProps
|Optional user provided props to override the default props for 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|
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|
|cloudwatchAlarms()|cloudwatch.Alarm[]
|Returns a list of cloudwatch.Alarm created by the construct|
Architecture
© Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.