# AWS CDK Assets
<!--BEGIN STABILITY BANNER-->---
> AWS CDK v1 has reached End-of-Support on 2023-06-01.
> This package is no longer being updated, and users should migrate to AWS CDK v2.
>
> For more information on how to migrate, see the [*Migrating to AWS CDK v2* guide](https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html).
---
<!--END STABILITY BANNER-->
Assets are local files or directories which are needed by a CDK app. A common
example is a directory which contains the handler code for a Lambda function,
but assets can represent any artifact that is needed for the app's operation.
When deploying a CDK app that includes constructs with assets, the CDK toolkit
will first upload all the assets to S3, and only then deploy the stacks. The S3
locations of the uploaded assets will be passed in as CloudFormation Parameters
to the relevant stacks.
The following JavaScript example defines a directory asset which is archived as
a .zip file and uploaded to S3 during deployment.
```python
asset = assets.Asset(self, "SampleAsset",
path=path.join(__dirname, "sample-asset-directory")
)
```
The following JavaScript example defines a file asset, which is uploaded as-is
to an S3 bucket during deployment.
```python
asset = assets.Asset(self, "SampleAsset",
path=path.join(__dirname, "file-asset.txt")
)
```
## Attributes
`Asset` constructs expose the following deploy-time attributes:
* `s3BucketName` - the name of the assets S3 bucket.
* `s3ObjectKey` - the S3 object key of the asset file (whether it's a file or a zip archive)
* `s3ObjectUrl` - the S3 object URL of the asset (i.e. s3://mybucket/mykey.zip)
* `httpUrl` - the S3 HTTP URL of the asset (i.e. https://s3.us-east-1.amazonaws.com/mybucket/mykey.zip)
In the following example, the various asset attributes are exported as stack outputs:
```python
asset = assets.Asset(self, "SampleAsset",
path=path.join(__dirname, "sample-asset-directory")
)
cdk.CfnOutput(self, "S3BucketName", value=asset.s3_bucket_name)
cdk.CfnOutput(self, "S3ObjectKey", value=asset.s3_object_key)
cdk.CfnOutput(self, "S3HttpURL", value=asset.http_url)
cdk.CfnOutput(self, "S3ObjectURL", value=asset.s3_object_url)
```
## Permissions
IAM roles, users or groups which need to be able to read assets in runtime will should be
granted IAM permissions. To do that use the `asset.grantRead(principal)` method:
The following example grants an IAM group read permissions on an asset:
```python
group = iam.Group(self, "MyUserGroup")
asset.grant_read(group)
```
## How does it work
When an asset is defined in a construct, a construct metadata entry
`aws:cdk:asset` is emitted with instructions on where to find the asset and what
type of packaging to perform (`zip` or `file`). Furthermore, the synthesized
CloudFormation template will also include two CloudFormation parameters: one for
the asset's bucket and one for the asset S3 key. Those parameters are used to
reference the deploy-time values of the asset (using `{ Ref: "Param" }`).
Then, when the stack is deployed, the toolkit will package the asset (i.e. zip
the directory), calculate an MD5 hash of the contents and will render an S3 key
for this asset within the toolkit's asset store. If the file doesn't exist in
the asset store, it is uploaded during deployment.
> The toolkit's asset store is an S3 bucket created by the toolkit for each
> environment the toolkit operates in (environment = account + region).
Now, when the toolkit deploys the stack, it will set the relevant CloudFormation
Parameters to point to the actual bucket and key for each asset.
## Asset Bundling
When defining an asset, you can use the `bundling` option to specify a command
to run inside a docker container. The command can read the contents of the asset
source from `/asset-input` and is expected to write files under `/asset-output`
(directories mapped inside the container). The files under `/asset-output` will
be zipped and uploaded to S3 as the asset.
The following example uses custom asset bundling to convert a markdown file to html:
```python
asset = assets.Asset(self, "BundledAsset",
path=path.join(__dirname, "markdown-asset"), # /asset-input and working directory in the container
bundling=BundlingOptions(
image=DockerImage.from_build(path.join(__dirname, "alpine-markdown")), # Build an image
command=["sh", "-c", """
markdown index.md > /asset-output/index.html
"""
]
)
)
```
The bundling docker image (`image`) can either come from a registry (`DockerImage.fromRegistry`)
or it can be built from a `Dockerfile` located inside your project (`DockerImage.fromBuild`).
You can set the `CDK_DOCKER` environment variable in order to provide a custom
docker program to execute. This may sometime be needed when building in
environments where the standard docker cannot be executed (see
https://github.com/aws/aws-cdk/issues/8460 for details).
Use `local` to specify a local bundling provider. The provider implements a
method `tryBundle()` which should return `true` if local bundling was performed.
If `false` is returned, docker bundling will be done:
```python
@jsii.implements(ILocalBundling)
class MyBundle:
def try_bundle(self, output_dir, *, image, entrypoint=None, command=None, volumes=None, environment=None, workingDirectory=None, user=None, local=None, outputType=None, securityOpt=None):
can_run_locally = True # replace with actual logic
if can_run_locally:
# perform local bundling here
return True
return False
assets.Asset(self, "BundledAsset",
path="/path/to/asset",
bundling=BundlingOptions(
local=MyBundle(),
# Docker bundling fallback
image=DockerImage.from_registry("alpine"),
entrypoint=["/bin/sh", "-c"],
command=["bundle"]
)
)
```
Although optional, it's recommended to provide a local bundling method which can
greatly improve performance.
If the bundling output contains a single archive file (zip or jar) it will be
uploaded to S3 as-is and will not be zipped. Otherwise the contents of the
output directory will be zipped and the zip file will be uploaded to S3. This
is the default behavior for `bundling.outputType` (`BundlingOutput.AUTO_DISCOVER`).
Use `BundlingOutput.NOT_ARCHIVED` if the bundling output must always be zipped:
```python
asset = assets.Asset(self, "BundledAsset",
path="/path/to/asset",
bundling=BundlingOptions(
image=DockerImage.from_registry("alpine"),
command=["command-that-produces-an-archive.sh"],
output_type=BundlingOutput.NOT_ARCHIVED
)
)
```
Use `BundlingOutput.ARCHIVED` if the bundling output contains a single archive file and
you don't want it to be zipped.
## CloudFormation Resource Metadata
> NOTE: This section is relevant for authors of AWS Resource Constructs.
In certain situations, it is desirable for tools to be able to know that a certain CloudFormation
resource is using a local asset. For example, SAM CLI can be used to invoke AWS Lambda functions
locally for debugging purposes.
To enable such use cases, external tools will consult a set of metadata entries on AWS CloudFormation
resources:
* `aws:asset:path` points to the local path of the asset.
* `aws:asset:property` is the name of the resource property where the asset is used
Using these two metadata entries, tools will be able to identify that assets are used
by a certain resource, and enable advanced local experiences.
To add these metadata entries to a resource, use the
`asset.addResourceMetadata(resource, property)` method.
See https://github.com/aws/aws-cdk/issues/1432 for more details
Raw data
{
"_id": null,
"home_page": "https://github.com/aws/aws-cdk",
"name": "aws-cdk.aws-s3-assets",
"maintainer": "",
"docs_url": null,
"requires_python": "~=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Amazon Web Services",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/0d/5d/cff359508feb9dbae3b99527bef8f4f9652cf6b535b5144186336e7a2042/aws-cdk.aws-s3-assets-1.204.0.tar.gz",
"platform": null,
"description": "# AWS CDK Assets\n\n<!--BEGIN STABILITY BANNER-->---\n\n\n\n\n> AWS CDK v1 has reached End-of-Support on 2023-06-01.\n> This package is no longer being updated, and users should migrate to AWS CDK v2.\n>\n> For more information on how to migrate, see the [*Migrating to AWS CDK v2* guide](https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html).\n\n---\n<!--END STABILITY BANNER-->\n\nAssets are local files or directories which are needed by a CDK app. A common\nexample is a directory which contains the handler code for a Lambda function,\nbut assets can represent any artifact that is needed for the app's operation.\n\nWhen deploying a CDK app that includes constructs with assets, the CDK toolkit\nwill first upload all the assets to S3, and only then deploy the stacks. The S3\nlocations of the uploaded assets will be passed in as CloudFormation Parameters\nto the relevant stacks.\n\nThe following JavaScript example defines a directory asset which is archived as\na .zip file and uploaded to S3 during deployment.\n\n```python\nasset = assets.Asset(self, \"SampleAsset\",\n path=path.join(__dirname, \"sample-asset-directory\")\n)\n```\n\nThe following JavaScript example defines a file asset, which is uploaded as-is\nto an S3 bucket during deployment.\n\n```python\nasset = assets.Asset(self, \"SampleAsset\",\n path=path.join(__dirname, \"file-asset.txt\")\n)\n```\n\n## Attributes\n\n`Asset` constructs expose the following deploy-time attributes:\n\n* `s3BucketName` - the name of the assets S3 bucket.\n* `s3ObjectKey` - the S3 object key of the asset file (whether it's a file or a zip archive)\n* `s3ObjectUrl` - the S3 object URL of the asset (i.e. s3://mybucket/mykey.zip)\n* `httpUrl` - the S3 HTTP URL of the asset (i.e. https://s3.us-east-1.amazonaws.com/mybucket/mykey.zip)\n\nIn the following example, the various asset attributes are exported as stack outputs:\n\n```python\nasset = assets.Asset(self, \"SampleAsset\",\n path=path.join(__dirname, \"sample-asset-directory\")\n)\n\ncdk.CfnOutput(self, \"S3BucketName\", value=asset.s3_bucket_name)\ncdk.CfnOutput(self, \"S3ObjectKey\", value=asset.s3_object_key)\ncdk.CfnOutput(self, \"S3HttpURL\", value=asset.http_url)\ncdk.CfnOutput(self, \"S3ObjectURL\", value=asset.s3_object_url)\n```\n\n## Permissions\n\nIAM roles, users or groups which need to be able to read assets in runtime will should be\ngranted IAM permissions. To do that use the `asset.grantRead(principal)` method:\n\nThe following example grants an IAM group read permissions on an asset:\n\n```python\ngroup = iam.Group(self, \"MyUserGroup\")\nasset.grant_read(group)\n```\n\n## How does it work\n\nWhen an asset is defined in a construct, a construct metadata entry\n`aws:cdk:asset` is emitted with instructions on where to find the asset and what\ntype of packaging to perform (`zip` or `file`). Furthermore, the synthesized\nCloudFormation template will also include two CloudFormation parameters: one for\nthe asset's bucket and one for the asset S3 key. Those parameters are used to\nreference the deploy-time values of the asset (using `{ Ref: \"Param\" }`).\n\nThen, when the stack is deployed, the toolkit will package the asset (i.e. zip\nthe directory), calculate an MD5 hash of the contents and will render an S3 key\nfor this asset within the toolkit's asset store. If the file doesn't exist in\nthe asset store, it is uploaded during deployment.\n\n> The toolkit's asset store is an S3 bucket created by the toolkit for each\n> environment the toolkit operates in (environment = account + region).\n\nNow, when the toolkit deploys the stack, it will set the relevant CloudFormation\nParameters to point to the actual bucket and key for each asset.\n\n## Asset Bundling\n\nWhen defining an asset, you can use the `bundling` option to specify a command\nto run inside a docker container. The command can read the contents of the asset\nsource from `/asset-input` and is expected to write files under `/asset-output`\n(directories mapped inside the container). The files under `/asset-output` will\nbe zipped and uploaded to S3 as the asset.\n\nThe following example uses custom asset bundling to convert a markdown file to html:\n\n```python\nasset = assets.Asset(self, \"BundledAsset\",\n path=path.join(__dirname, \"markdown-asset\"), # /asset-input and working directory in the container\n bundling=BundlingOptions(\n image=DockerImage.from_build(path.join(__dirname, \"alpine-markdown\")), # Build an image\n command=[\"sh\", \"-c\", \"\"\"\n markdown index.md > /asset-output/index.html\n \"\"\"\n ]\n )\n)\n```\n\nThe bundling docker image (`image`) can either come from a registry (`DockerImage.fromRegistry`)\nor it can be built from a `Dockerfile` located inside your project (`DockerImage.fromBuild`).\n\nYou can set the `CDK_DOCKER` environment variable in order to provide a custom\ndocker program to execute. This may sometime be needed when building in\nenvironments where the standard docker cannot be executed (see\nhttps://github.com/aws/aws-cdk/issues/8460 for details).\n\nUse `local` to specify a local bundling provider. The provider implements a\nmethod `tryBundle()` which should return `true` if local bundling was performed.\nIf `false` is returned, docker bundling will be done:\n\n```python\n@jsii.implements(ILocalBundling)\nclass MyBundle:\n def try_bundle(self, output_dir, *, image, entrypoint=None, command=None, volumes=None, environment=None, workingDirectory=None, user=None, local=None, outputType=None, securityOpt=None):\n can_run_locally = True # replace with actual logic\n if can_run_locally:\n # perform local bundling here\n return True\n return False\n\nassets.Asset(self, \"BundledAsset\",\n path=\"/path/to/asset\",\n bundling=BundlingOptions(\n local=MyBundle(),\n # Docker bundling fallback\n image=DockerImage.from_registry(\"alpine\"),\n entrypoint=[\"/bin/sh\", \"-c\"],\n command=[\"bundle\"]\n )\n)\n```\n\nAlthough optional, it's recommended to provide a local bundling method which can\ngreatly improve performance.\n\nIf the bundling output contains a single archive file (zip or jar) it will be\nuploaded to S3 as-is and will not be zipped. Otherwise the contents of the\noutput directory will be zipped and the zip file will be uploaded to S3. This\nis the default behavior for `bundling.outputType` (`BundlingOutput.AUTO_DISCOVER`).\n\nUse `BundlingOutput.NOT_ARCHIVED` if the bundling output must always be zipped:\n\n```python\nasset = assets.Asset(self, \"BundledAsset\",\n path=\"/path/to/asset\",\n bundling=BundlingOptions(\n image=DockerImage.from_registry(\"alpine\"),\n command=[\"command-that-produces-an-archive.sh\"],\n output_type=BundlingOutput.NOT_ARCHIVED\n )\n)\n```\n\nUse `BundlingOutput.ARCHIVED` if the bundling output contains a single archive file and\nyou don't want it to be zipped.\n\n## CloudFormation Resource Metadata\n\n> NOTE: This section is relevant for authors of AWS Resource Constructs.\n\nIn certain situations, it is desirable for tools to be able to know that a certain CloudFormation\nresource is using a local asset. For example, SAM CLI can be used to invoke AWS Lambda functions\nlocally for debugging purposes.\n\nTo enable such use cases, external tools will consult a set of metadata entries on AWS CloudFormation\nresources:\n\n* `aws:asset:path` points to the local path of the asset.\n* `aws:asset:property` is the name of the resource property where the asset is used\n\nUsing these two metadata entries, tools will be able to identify that assets are used\nby a certain resource, and enable advanced local experiences.\n\nTo add these metadata entries to a resource, use the\n`asset.addResourceMetadata(resource, property)` method.\n\nSee https://github.com/aws/aws-cdk/issues/1432 for more details\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Deploy local files and directories to S3",
"version": "1.204.0",
"project_urls": {
"Homepage": "https://github.com/aws/aws-cdk",
"Source": "https://github.com/aws/aws-cdk.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "83113e9de7b1cb7bf2770eb4b0a7868fe2cce62c483f3a2fbaae8460dbd25246",
"md5": "d3e3733f8205665db239efd6550e74b2",
"sha256": "041450f122448677e330324baaede02b20c1beaed0177f80c306bc94772da471"
},
"downloads": -1,
"filename": "aws_cdk.aws_s3_assets-1.204.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d3e3733f8205665db239efd6550e74b2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.7",
"size": 48359,
"upload_time": "2023-06-19T21:00:57",
"upload_time_iso_8601": "2023-06-19T21:00:57.091566Z",
"url": "https://files.pythonhosted.org/packages/83/11/3e9de7b1cb7bf2770eb4b0a7868fe2cce62c483f3a2fbaae8460dbd25246/aws_cdk.aws_s3_assets-1.204.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0d5dcff359508feb9dbae3b99527bef8f4f9652cf6b535b5144186336e7a2042",
"md5": "ff332f486cf9dcf764e02fdb113432d0",
"sha256": "61ec7a8c236760df9064d11652c54a0eb8ff45e0c04095e77f56fce8775cf01c"
},
"downloads": -1,
"filename": "aws-cdk.aws-s3-assets-1.204.0.tar.gz",
"has_sig": false,
"md5_digest": "ff332f486cf9dcf764e02fdb113432d0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.7",
"size": 49777,
"upload_time": "2023-06-19T21:07:09",
"upload_time_iso_8601": "2023-06-19T21:07:09.367886Z",
"url": "https://files.pythonhosted.org/packages/0d/5d/cff359508feb9dbae3b99527bef8f4f9652cf6b535b5144186336e7a2042/aws-cdk.aws-s3-assets-1.204.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-19 21:07:09",
"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-s3-assets"
}
JSON
