Skip to main content

CDK constructs for defining an interaction between an AWS Lambda function and Amazon Transcribe with S3 buckets.

Project description

aws-lambda-transcribe module

---

Stability: Experimental


Reference Documentation: https://docs.aws.amazon.com/solutions/latest/constructs/
Language Package
Python Logo Python aws_solutions_constructs.aws_lambda_transcribe
Typescript Logo Typescript @aws-solutions-constructs/aws-lambda-transcribe
Java Logo Java software.amazon.awsconstructs.services.lambdatranscribe

Overview

This AWS Solutions Construct implements an AWS Lambda function connected to Amazon S3 buckets for use with Amazon Transcribe.

Here is a minimal deployable pattern definition:

Typescript

import { Construct } from 'constructs';
import { Stack, StackProps } from 'aws-cdk-lib';
import { LambdaToTranscribe } from '@aws-solutions-constructs/aws-lambda-transcribe';
import * as lambda from 'aws-cdk-lib/aws-lambda';

new LambdaToTranscribe(this, 'LambdaToTranscribePattern', {
    lambdaFunctionProps: {
        runtime: lambda.Runtime.NODEJS_20_X,
        handler: 'index.handler',
        code: lambda.Code.fromAsset(`lambda`)
    }
});

Python

from aws_solutions_constructs.aws_lambda_transcribe import LambdaToTranscribe
from aws_cdk import (
    aws_lambda as _lambda,
    Stack
)
from constructs import Construct

LambdaToTranscribe(self, 'LambdaToTranscribePattern',
        lambda_function_props=_lambda.FunctionProps(
            code=_lambda.Code.from_asset('lambda'),
            runtime=_lambda.Runtime.PYTHON_3_11,
            handler='index.handler'
        )
        )

Java

import software.constructs.Construct;

import software.amazon.awscdk.Stack;
import software.amazon.awscdk.StackProps;
import software.amazon.awscdk.services.lambda.*;
import software.amazon.awscdk.services.lambda.Runtime;
import software.amazon.awsconstructs.services.lambdatranscribe.*;

new LambdaToTranscribe(this, "LambdaToTranscribePattern", new LambdaToTranscribeProps.Builder()
        .lambdaFunctionProps(new FunctionProps.Builder()
                .runtime(Runtime.NODEJS_20_X)
                .code(Code.fromAsset("lambda"))
                .handler("index.handler")
                .build())
        .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 Optional user provided props to override the default props for the Lambda function.
existingSourceBucketObj? s3.IBucket Existing instance of S3 Bucket object for source audio files.
sourceBucketProps? s3.BucketProps Optional user provided props to override the default props for the source S3 Bucket.
existingDestinationBucketObj? s3.IBucket Existing instance of S3 Bucket object for transcription results.
destinationBucketProps? s3.BucketProps Optional user provided props to override the default props for the destination S3 Bucket.
useSameBucket? boolean Whether to use the same S3 bucket for both source and destination files. Default: false

Pattern Properties

Name Type Description
lambdaFunction lambda.Function Returns an instance of the Lambda function created by the pattern.
sourceBucket? s3.Bucket Returns an instance of the source S3 bucket created by the pattern.
destinationBucket? s3.Bucket Returns an instance of the destination S3 bucket created by the pattern.

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

    • SOURCE_BUCKET_NAME
    • DESTINATION_BUCKET_NAME
    • AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)
  • Grant permissions to use Amazon Transcribe service, write to source bucket, and read from destination bucket

Amazon S3 Buckets

  • Configure Access logging for both S3 Buckets
  • Enable server-side encryption for both S3 Buckets using AWS managed KMS Key
  • Enforce encryption of data in transit
  • Turn on the versioning for both S3 Buckets
  • Don't allow public access for both S3 Buckets
  • Retain the S3 Buckets when deleting the CloudFormation stack

Amazon Transcribe Service

  • The Transcribe service will have read access to the source bucket and write permissions to the destination bucket
  • Lambda function will have permissions to start transcription jobs, get job status, and list transcription jobs

Architecture

Architecture Diagram


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

Project details


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

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file aws_solutions_constructs_aws_lambda_transcribe-2.95.0.tar.gz.

File metadata

File hashes

Hashes for aws_solutions_constructs_aws_lambda_transcribe-2.95.0.tar.gz
Algorithm Hash digest
SHA256 4e1f69be323631e3f8715db5904e5cb3e25ee27b16cfe5f1560d278cffe9fc7c
MD5 f9c3351b4cabf676b72199d167ac25fd
BLAKE2b-256 35f8d141283e3cef1aa9e53c36dbb0835d69a6a215c7800ab040c616ee857f5d

See more details on using hashes here.

File details

Details for the file aws_solutions_constructs_aws_lambda_transcribe-2.95.0-py3-none-any.whl.

File metadata

File hashes

Hashes for aws_solutions_constructs_aws_lambda_transcribe-2.95.0-py3-none-any.whl
Algorithm Hash digest
SHA256 30115754b4c8cd9da6678b74de415d5d4647ab7b419c8756e1ace52794ae00a3
MD5 5c1c72cdaed0bbe8e5b3f6d72ff4b81d
BLAKE2b-256 0314d201789fa95d6cf4ee5d01a67d837d57eef1e7e48448e3e2b2167365946f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page