Never Post Memes

    @aws-solutions-konstruk/aws-lambda-s3
    TypeScript icon, indicating that this package has built-in type declarations

    0.8.1 • Public • Published

    aws-lambda-s3 module


    Stability: Experimental

    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-s3/
    Language Package
    Python Logo{: style="height:16px;width:16px"} Python aws_solutions_konstruk.aws_lambda_s3
    Typescript Logo{: style="height:16px;width:16px"} Typescript @aws-solutions-konstruk/aws-lambda-s3

    This AWS Solutions Konstruk implements an AWS Lambda function connected to an Amazon S3 bucket.

    Here is a minimal deployable pattern definition:

    const { LambdaToS3 } = require('@aws-solutions-konstruk/aws-lambda-s3');
    
    new LambdaToS3(stack, 'LambdaToS3Pattern', {
        deployLambda: true,
        lambdaFunctionProps: {
            runtime: lambda.Runtime.NODEJS_10_X,
            handler: 'index.handler',
            code: lambda.Code.asset(`${__dirname}/lambda`)
        }
    });

    Initializer

    new LambdaToS3(scope: Construct, id: string, props: LambdaToS3Props);
    

    Parameters

    Pattern Construct Props

    Name Type Description
    deployLambda boolean Whether to create a new Lambda function or use an existing Lambda function.
    existingLambdaObj? lambda.Function An optional, existing Lambda function.
    lambdaFunctionProps? lambda.FunctionProps Optional user-provided props to override the default props for the Lambda function.
    deployBucket? boolean Whether to create a S3 Bucket or use an existing S3 Bucket
    existingBucketObj? s3.Bucket Existing instance of S3 Bucket object
    bucketProps? s3.BucketProps Optional user provided props to override the default props for S3 Bucket
    bucketPermissions? string[] Optional bucket permissions to grant to the Lambda function. One or more of the following may be specified: Delete, Put, Read, ReadWrite, Write.

    |lambdaFunction()|lambda.Function|Returns an instance of the Lambda function created by the pattern.| |s3Bucket()|s3.Bucket|Returns an instance of the S3 bucket created by the pattern.|

    Architecture

    Architecture Diagram


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

    Keywords

    none

    Install

    npm i @aws-solutions-konstruk/aws-lambda-s3

    DownloadsWeekly Downloads

    4

    Version

    0.8.1

    License

    Apache-2.0

    Unpacked Size

    255 kB

    Total Files

    17

    Last publish

    Collaborators

    • aws-solutions-konstruk-support