# AWS::S3ObjectLambda Construct Library
<!--BEGIN STABILITY BANNER-->---
> The APIs of higher level constructs in this module are experimental and under active development.
> They are subject to non-backward compatible changes or removal in any future version. These are
> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be
> announced in the release notes. 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.
---
<!--END STABILITY BANNER-->
This construct library allows you to define S3 object lambda access points.
```python
import aws_cdk.aws_lambda as lambda_
import aws_cdk.aws_s3 as s3
import aws_cdk.aws_s3objectlambda_alpha as s3objectlambda
import aws_cdk as cdk
stack = cdk.Stack()
bucket = s3.Bucket(stack, "MyBucket")
handler = lambda_.Function(stack, "MyFunction",
runtime=lambda_.Runtime.NODEJS_LATEST,
handler="index.handler",
code=lambda_.Code.from_asset("lambda.zip")
)
s3objectlambda.AccessPoint(stack, "MyObjectLambda",
bucket=bucket,
handler=handler,
access_point_name="my-access-point",
payload={
"prop": "value"
}
)
```
## Handling range and part number requests
Lambdas are currently limited to only transforming `GetObject` requests. However, they can additionally support `GetObject-Range` and `GetObject-PartNumber` requests, which needs to be specified in the access point configuration:
```python
import aws_cdk.aws_lambda as lambda_
import aws_cdk.aws_s3 as s3
import aws_cdk.aws_s3objectlambda_alpha as s3objectlambda
import aws_cdk as cdk
stack = cdk.Stack()
bucket = s3.Bucket(stack, "MyBucket")
handler = lambda_.Function(stack, "MyFunction",
runtime=lambda_.Runtime.NODEJS_LATEST,
handler="index.handler",
code=lambda_.Code.from_asset("lambda.zip")
)
s3objectlambda.AccessPoint(stack, "MyObjectLambda",
bucket=bucket,
handler=handler,
access_point_name="my-access-point",
supports_get_object_range=True,
supports_get_object_part_number=True
)
```
## Pass additional data to Lambda function
You can specify an additional object that provides supplemental data to the Lambda function used to transform objects. The data is delivered as a JSON payload to the Lambda:
```python
import aws_cdk.aws_lambda as lambda_
import aws_cdk.aws_s3 as s3
import aws_cdk.aws_s3objectlambda_alpha as s3objectlambda
import aws_cdk as cdk
stack = cdk.Stack()
bucket = s3.Bucket(stack, "MyBucket")
handler = lambda_.Function(stack, "MyFunction",
runtime=lambda_.Runtime.NODEJS_LATEST,
handler="index.handler",
code=lambda_.Code.from_asset("lambda.zip")
)
s3objectlambda.AccessPoint(stack, "MyObjectLambda",
bucket=bucket,
handler=handler,
access_point_name="my-access-point",
payload={
"prop": "value"
}
)
```
## Accessing the S3 AccessPoint ARN
If you need access to the s3 accesspoint, you can get its ARN like so:
```python
import aws_cdk.aws_s3objectlambda_alpha as s3objectlambda
# access_point: s3objectlambda.AccessPoint
s3_access_point_arn = access_point.s3_access_point_arn
```
This is only supported for AccessPoints created in the stack - currently you're unable to get the S3 AccessPoint ARN for imported AccessPoints. To do that you'd have to know the S3 bucket name beforehand.
Raw data
{
"_id": null,
"home_page": "https://github.com/aws/aws-cdk",
"name": "aws-cdk.aws-s3objectlambda-alpha",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Amazon Web Services",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/21/52/1b2cee03ed5c85af4495a1f33b8cdb1d675e04b54660fd8291524d957fe6/aws_cdk_aws_s3objectlambda_alpha-2.180.0a0.tar.gz",
"platform": null,
"description": "# AWS::S3ObjectLambda Construct Library\n\n<!--BEGIN STABILITY BANNER-->---\n\n\n\n\n> The APIs of higher level constructs in this module are experimental and under active development.\n> They are subject to non-backward compatible changes or removal in any future version. These are\n> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be\n> announced in the release notes. This means that while you may use them, you may need to update\n> your source code when upgrading to a newer version of this package.\n\n---\n<!--END STABILITY BANNER-->\n\nThis construct library allows you to define S3 object lambda access points.\n\n```python\nimport aws_cdk.aws_lambda as lambda_\nimport aws_cdk.aws_s3 as s3\nimport aws_cdk.aws_s3objectlambda_alpha as s3objectlambda\nimport aws_cdk as cdk\n\nstack = cdk.Stack()\nbucket = s3.Bucket(stack, \"MyBucket\")\nhandler = lambda_.Function(stack, \"MyFunction\",\n runtime=lambda_.Runtime.NODEJS_LATEST,\n handler=\"index.handler\",\n code=lambda_.Code.from_asset(\"lambda.zip\")\n)\ns3objectlambda.AccessPoint(stack, \"MyObjectLambda\",\n bucket=bucket,\n handler=handler,\n access_point_name=\"my-access-point\",\n payload={\n \"prop\": \"value\"\n }\n)\n```\n\n## Handling range and part number requests\n\nLambdas are currently limited to only transforming `GetObject` requests. However, they can additionally support `GetObject-Range` and `GetObject-PartNumber` requests, which needs to be specified in the access point configuration:\n\n```python\nimport aws_cdk.aws_lambda as lambda_\nimport aws_cdk.aws_s3 as s3\nimport aws_cdk.aws_s3objectlambda_alpha as s3objectlambda\nimport aws_cdk as cdk\n\nstack = cdk.Stack()\nbucket = s3.Bucket(stack, \"MyBucket\")\nhandler = lambda_.Function(stack, \"MyFunction\",\n runtime=lambda_.Runtime.NODEJS_LATEST,\n handler=\"index.handler\",\n code=lambda_.Code.from_asset(\"lambda.zip\")\n)\ns3objectlambda.AccessPoint(stack, \"MyObjectLambda\",\n bucket=bucket,\n handler=handler,\n access_point_name=\"my-access-point\",\n supports_get_object_range=True,\n supports_get_object_part_number=True\n)\n```\n\n## Pass additional data to Lambda function\n\nYou can specify an additional object that provides supplemental data to the Lambda function used to transform objects. The data is delivered as a JSON payload to the Lambda:\n\n```python\nimport aws_cdk.aws_lambda as lambda_\nimport aws_cdk.aws_s3 as s3\nimport aws_cdk.aws_s3objectlambda_alpha as s3objectlambda\nimport aws_cdk as cdk\n\nstack = cdk.Stack()\nbucket = s3.Bucket(stack, \"MyBucket\")\nhandler = lambda_.Function(stack, \"MyFunction\",\n runtime=lambda_.Runtime.NODEJS_LATEST,\n handler=\"index.handler\",\n code=lambda_.Code.from_asset(\"lambda.zip\")\n)\ns3objectlambda.AccessPoint(stack, \"MyObjectLambda\",\n bucket=bucket,\n handler=handler,\n access_point_name=\"my-access-point\",\n payload={\n \"prop\": \"value\"\n }\n)\n```\n\n## Accessing the S3 AccessPoint ARN\n\nIf you need access to the s3 accesspoint, you can get its ARN like so:\n\n```python\nimport aws_cdk.aws_s3objectlambda_alpha as s3objectlambda\n\n# access_point: s3objectlambda.AccessPoint\ns3_access_point_arn = access_point.s3_access_point_arn\n```\n\nThis is only supported for AccessPoints created in the stack - currently you're unable to get the S3 AccessPoint ARN for imported AccessPoints. To do that you'd have to know the S3 bucket name beforehand.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "The CDK Construct Library for AWS::S3ObjectLambda",
"version": "2.180.0a0",
"project_urls": {
"Homepage": "https://github.com/aws/aws-cdk",
"Source": "https://github.com/aws/aws-cdk.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "7ae2aa40516b4233a1e15f3e2dd46a2316534bf54753391d3b37e3fa4ca74eb9",
"md5": "f7b950657728514fefefb63f308f4ba7",
"sha256": "9abe7a999628b13d2ca0497bcf226d6ce37552ff04eac73834183c836dca9c7c"
},
"downloads": -1,
"filename": "aws_cdk.aws_s3objectlambda_alpha-2.180.0a0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f7b950657728514fefefb63f308f4ba7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.8",
"size": 44199,
"upload_time": "2025-02-21T06:04:42",
"upload_time_iso_8601": "2025-02-21T06:04:42.042275Z",
"url": "https://files.pythonhosted.org/packages/7a/e2/aa40516b4233a1e15f3e2dd46a2316534bf54753391d3b37e3fa4ca74eb9/aws_cdk.aws_s3objectlambda_alpha-2.180.0a0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "21521b2cee03ed5c85af4495a1f33b8cdb1d675e04b54660fd8291524d957fe6",
"md5": "7b4c81298cff213481c2f9b3dc20a6c6",
"sha256": "8628f01ca7f7222c419f1911393fa21c02c57df69d4afa2df61e850ee8c3f889"
},
"downloads": -1,
"filename": "aws_cdk_aws_s3objectlambda_alpha-2.180.0a0.tar.gz",
"has_sig": false,
"md5_digest": "7b4c81298cff213481c2f9b3dc20a6c6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.8",
"size": 45090,
"upload_time": "2025-02-21T06:05:37",
"upload_time_iso_8601": "2025-02-21T06:05:37.454630Z",
"url": "https://files.pythonhosted.org/packages/21/52/1b2cee03ed5c85af4495a1f33b8cdb1d675e04b54660fd8291524d957fe6/aws_cdk_aws_s3objectlambda_alpha-2.180.0a0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-21 06:05:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aws",
"github_project": "aws-cdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aws-cdk.aws-s3objectlambda-alpha"
}
JSON
