First iteration of aws-lambda-transcribe

Author: biffgaut

source/package-lock.json

@@ -0,0 +1,30 @@
+*.js
+*.js.map
+*.d.ts
+node_modules
+*.generated.ts
+dist
+.jsii
+
+.nyc_output
+coverage
+.nycrc
+.LAST_BUILD
+.nyc_output
+junit.xml
+test-reports/
+!jest.config.js
+*.tsbuildinfo
+
+.LAST_PACKAGE
+*.snk
+nyc.config.js
+!.eslintrc.js
+!jest.config.js
+
+# CDK asset staging directory
+.cdk.staging
+cdk.out
+
+# Parcel default cache directory
+.parcel-cache

source/patterns/@aws-solutions-constructs/aws-lambda-transcribe/.gitignore

@@ -0,0 +1,34 @@
+# The basics
+*.ts
+*.tsx
+!*.d.ts
+!*.js
+*.map
+.jsii
+.nyc_output
+coverage
+node_modules
+*.tgz
+*.snk
+tsconfig.json
+.eslintrc.js
+# Runtime dependencies (we bundle them)
+/node_modules/
+
+# Test .js files
+test/
+!*.d.ts
+*.tsbuildinfo
+
+# exclude cdk artifacts
+**/cdk.out
+junit.xml
+test-reports/
+
+
+# Exclude jsii outdir
+dist
+
+# Include .jsii and .jsii.gz
+!.jsii
+!.jsii.gz

source/patterns/@aws-solutions-constructs/aws-lambda-transcribe/.npmignore

@@ -0,0 +1,286 @@
+//!!NODE_ROOT <section>
+//== aws-lambda-transcribe module
+
+[.topic]
+= aws-lambda-transcribe
+:info_doctype: section
+:info_title: aws-lambda-transcribe
+
+
+image:https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge[Stability:Experimental]
+
+[width="100%",cols="<50%,<50%",options="header",]
+|===
+|*Reference Documentation*:
+|https://docs.aws.amazon.com/solutions/latest/constructs/
+|===
+
+[width="100%",cols="<46%,54%",options="header",]
+|===
+|*Language* |*Package*
+|image:https://docs.aws.amazon.com/cdk/api/latest/img/python32.png[Python
+Logo] Python |`aws_solutions_constructs.aws_lambda_transcribe`
+
+|image:https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png[Typescript
+Logo] Typescript |`@aws-solutions-constructs/aws-lambda-transcribe`
+
+|image:https://docs.aws.amazon.com/cdk/api/latest/img/java32.png[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. The construct creates
+a source bucket for audio files and a destination bucket for transcription
+results, with appropriate IAM permissions for the Lambda function to interact
+with both buckets and Amazon Transcribe service.
+
+Here is a minimal deployable pattern definition:
+
+====
+[role="tablist"]
+Typescript::
++
+[source,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::
++
+[source,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::
++
+[source,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
+
+[width="100%",cols="<30%,<35%,35%",options="header",]
+|===
+|*Name* |*Type* |*Description*
+|existingLambdaObj?
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html[`lambda.Function`]
+|Existing instance of Lambda Function object, providing both this and
+`lambdaFunctionProps` will cause an error.
+
+|lambdaFunctionProps?
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.FunctionProps.html[`lambda.FunctionProps`]
+|Optional user provided props to override the default props for the
+Lambda function.
+
+|existingSourceBucketObj?
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.IBucket.html[`s3.IBucket`]
+|Existing instance of S3 Bucket object for source audio files. If this is provided, then also
+providing sourceBucketProps is an error.
+
+|sourceBucketProps?
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.BucketProps.html[`s3.BucketProps`]
+|Optional user provided props to override the default props for the source S3
+Bucket.
+
+|existingDestinationBucketObj?
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.IBucket.html[`s3.IBucket`]
+|Existing instance of S3 Bucket object for transcription results. If this is provided, then also
+providing destinationBucketProps is an error.
+
+|destinationBucketProps?
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.BucketProps.html[`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.
+When true, only the source bucket will be created and used for both purposes. Default: false
+
+|existingVpc?
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html[`ec2.IVpc`]
+|An optional, existing VPC into which this pattern should be deployed.
+When deployed in a VPC, the Lambda function will use ENIs in the VPC to
+access network resources and Interface Endpoints will be created in
+the VPC for Amazon S3 and Amazon Transcribe. If an existing VPC is provided, the `deployVpc`
+property cannot be `true`. This uses `ec2.IVpc` to allow clients to
+supply VPCs that exist outside the stack using the
+https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.Vpc.html#static-fromwbrlookupscope-id-options[`ec2.Vpc.fromLookup()`]
+method.
+
+|vpcProps?
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.VpcProps.html[`ec2.VpcProps`]
+|Optional user provided properties to override the default properties
+for the new VPC. `enableDnsHostnames`, `enableDnsSupport`, `natGateways`
+and `subnetConfiguration` are set by the pattern, so any values for
+those properties supplied here will be overridden. If `deployVpc` is not
+`true` then this property will be ignored.
+
+|deployVpc? |`boolean` |Whether to create a new VPC based on `vpcProps`
+into which to deploy this pattern. Setting this to true will deploy the
+minimal, most private VPC to run the pattern.
+
+|sourceBucketEnvironmentVariableName? |`string` |Optional Name for the Lambda
+function environment variable set to the name of the source bucket. Default:
+SOURCE_BUCKET_NAME
+
+|destinationBucketEnvironmentVariableName? |`string` |Optional Name for the Lambda
+function environment variable set to the name of the destination bucket. Default:
+DESTINATION_BUCKET_NAME
+
+|sourceLoggingBucketProps?
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.BucketProps.html[`s3.BucketProps`]
+|Optional user provided props to override the default props for the source S3
+Logging Bucket.
+
+|destinationLoggingBucketProps?
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.BucketProps.html[`s3.BucketProps`]
+|Optional user provided props to override the default props for the destination S3
+Logging Bucket.
+
+|logSourceS3AccessLogs? |boolean |Whether to turn on Access Logging for the source S3
+bucket. Creates an S3 bucket with associated storage costs for the logs.
+Enabling Access Logging is a best practice. default - true
+
+|logDestinationS3AccessLogs? |boolean |Whether to turn on Access Logging for the destination S3
+bucket. Creates an S3 bucket with associated storage costs for the logs.
+Enabling Access Logging is a best practice. default - true
+|===
+
+== Pattern Properties
+
+[width="100%",cols="<30%,<35%,35%",options="header",]
+|===
+|*Name* |*Type* |*Description*
+|lambdaFunction
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html[`lambda.Function`]
+|Returns an instance of the Lambda function created by the pattern.
+
+|sourceBucket?
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.Bucket.html[`s3.Bucket`]
+|Returns an instance of the source S3 bucket if it is created by the pattern.
+
+|destinationBucket?
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.Bucket.html[`s3.Bucket`]
+|Returns an instance of the destination S3 bucket if it is created by the pattern.
+
+|sourceLoggingBucket?
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.Bucket.html[`s3.Bucket`]
+|Returns an instance of s3.Bucket created by the construct as the
+logging bucket for the source bucket.
+
+|destinationLoggingBucket?
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.Bucket.html[`s3.Bucket`]
+|Returns an instance of s3.Bucket created by the construct as the
+logging bucket for the destination bucket.
+
+|vpc?
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html[`ec2.IVpc`]
+|Returns an interface on the VPC used by the pattern (if any). This may
+be a VPC created by the pattern or the VPC supplied to the pattern
+constructor.
+
+|sourceBucketInterface
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.IBucket.html[`s3.IBucket`]
+|Returns an interface of s3.IBucket used by the construct for the source bucket whether created by the pattern or supplied from the client.
+
+|destinationBucketInterface
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.IBucket.html[`s3.IBucket`]
+|Returns an interface of s3.IBucket used by the construct for the destination bucket whether created by the pattern or supplied from the client.
+|===
+
+== 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) SOURCE_BUCKET_NAME
+** (default) DESTINATION_BUCKET_NAME
+** AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x
+and higher functions)
+* Grant permissions to use Amazon Transcribe service, write permissions to the source bucket, and read permissions to the 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
+* Applies Lifecycle rule to move noncurrent object versions to Glacier
+storage after 90 days
+
+=== 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
+
+=== Amazon VPC
+
+* If deployVpc is true, a minimal VPC will be created with:
+** Interface Endpoints for Amazon S3 and Amazon Transcribe
+** Private subnets for Lambda function
+** Appropriate security groups and routing
+
+== Architecture
+
+
+image::aws-lambda-transcribe.png["Diagram showing the Lambda function, source and destination S3 buckets, Amazon Transcribe service, and IAM roles created by the construct",scaledwidth=100%]
+
+== Example Lambda Function Implementation
+
+While Solutions Constructs does not publish code for the Lambda function to call Transcribe, there is an example of calling Transcribe https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/javascriptv3/example_code/transcribe/src/transcribe_create_job.js['here'].
+
+// github block
+
+'''''
+
+© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.