# cdk-amazon-chime-resources
An AWS Cloud Development Kit (AWS CDK) construct library that allows you to provision Amazon Chime resources with npm and pypi.
## Background
Amazon Chime resources (Amazon Chime Messaging and Amazon Chime PSTN resources) are not natively available in AWS CloudFormation or AWS CDK. Therefore, in order to create these resources with AWS CDK, an AWS Lambda backed custom resource must be used. In an effort to simplify that process, this AWS CDK construct has been created. This AWS CDK construct will create a custom resource and associated Lambda and expose constructs that can be used to create corresponding resources. This construct includes resources for both Amazon Chime Messaging and Amazon Chime PSTN.
## Resources
* [Amazon Chime SDK PSTN Resources](PSTNRESOURCES.MD)
* [Amazon Chime SDK Messaging Resources](MESSAGINGRESOURCES.MD)
* [Amazon Chime SDK Media Insights Resources](MEDIAINSIGHTS.MD)
## Installing
To add to your AWS CDK package.json file:
```
yarn add cdk-amazon-chime-resources
```
## Version 3 Upgrade
Version 3.0 is a potentially breaking change that involves multiple upgrades and changes. Version 3.0 revises the deployment to streamline and make more efficient the multiple configurations. This should result in an increased speed of deployment. All namespaces were updated to the current `chime-sdk-voice`, `chime-sdk-messaging`, `chime-sdk-identity`, or `chime-sdk-media-pipelines` namespace. Along with these changes, IAM policies were reduced where possible. If you encounter issues, please open an Issue.
> Potential Breaking Change with Streaming Messaging Data
>
> As part of the namespace change, this has been updated:
>
> ```python
> const appInstance = new MessagingAppInstance(this, 'appInstance', {
> name: 'MessagingAppInstanceExample',
> });
> appInstance.streaming([
> {
> dataType: MessagingDataType.CHANNEL,
> resourceArn: kinesisStream.streamArn,
> },
> ]);
> ```
## Not Supported Yet
This is a work in progress.
Features that are not supported yet:
* [ ] Amazon Chime Voice Connector Groups
* [ ] Amazon Chime Voice Connector Emergency Calling
* [ ] Updates to created resources
## Contributing
See [CONTRIBUTING](CONTRIBUTING.md) for more information.
## License
This project is licensed under the Apache-2.0 License.
Raw data
{
"_id": null,
"home_page": "https://github.com/cdklabs/cdk-amazon-chime-resources.git",
"name": "cdk-amazon-chime-resources",
"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/5f/65/82885762e73f20dc59145502f2d302b09659cfe07f7b602d43139bece53e/cdk-amazon-chime-resources-3.2.7.tar.gz",
"platform": null,
"description": "# cdk-amazon-chime-resources\n\n\n\nAn AWS Cloud Development Kit (AWS CDK) construct library that allows you to provision Amazon Chime resources with npm and pypi.\n\n## Background\n\nAmazon Chime resources (Amazon Chime Messaging and Amazon Chime PSTN resources) are not natively available in AWS CloudFormation or AWS CDK. Therefore, in order to create these resources with AWS CDK, an AWS Lambda backed custom resource must be used. In an effort to simplify that process, this AWS CDK construct has been created. This AWS CDK construct will create a custom resource and associated Lambda and expose constructs that can be used to create corresponding resources. This construct includes resources for both Amazon Chime Messaging and Amazon Chime PSTN.\n\n## Resources\n\n* [Amazon Chime SDK PSTN Resources](PSTNRESOURCES.MD)\n* [Amazon Chime SDK Messaging Resources](MESSAGINGRESOURCES.MD)\n* [Amazon Chime SDK Media Insights Resources](MEDIAINSIGHTS.MD)\n\n## Installing\n\nTo add to your AWS CDK package.json file:\n\n```\nyarn add cdk-amazon-chime-resources\n```\n\n## Version 3 Upgrade\n\nVersion 3.0 is a potentially breaking change that involves multiple upgrades and changes. Version 3.0 revises the deployment to streamline and make more efficient the multiple configurations. This should result in an increased speed of deployment. All namespaces were updated to the current `chime-sdk-voice`, `chime-sdk-messaging`, `chime-sdk-identity`, or `chime-sdk-media-pipelines` namespace. Along with these changes, IAM policies were reduced where possible. If you encounter issues, please open an Issue.\n\n> Potential Breaking Change with Streaming Messaging Data\n>\n> As part of the namespace change, this has been updated:\n>\n> ```python\n> const appInstance = new MessagingAppInstance(this, 'appInstance', {\n> name: 'MessagingAppInstanceExample',\n> });\n> appInstance.streaming([\n> {\n> dataType: MessagingDataType.CHANNEL,\n> resourceArn: kinesisStream.streamArn,\n> },\n> ]);\n> ```\n\n## Not Supported Yet\n\nThis is a work in progress.\n\nFeatures that are not supported yet:\n\n* [ ] Amazon Chime Voice Connector Groups\n* [ ] Amazon Chime Voice Connector Emergency Calling\n* [ ] Updates to created resources\n\n## Contributing\n\nSee [CONTRIBUTING](CONTRIBUTING.md) for more information.\n\n## License\n\nThis project is licensed under the Apache-2.0 License.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "cdk-amazon-chime-resources",
"version": "3.2.7",
"project_urls": {
"Homepage": "https://github.com/cdklabs/cdk-amazon-chime-resources.git",
"Source": "https://github.com/cdklabs/cdk-amazon-chime-resources.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c64d2f5ccfe580bd7411f3f7c744ee00c8006e667acb1f0553f29987c7346522",
"md5": "646161ef5d7fcafc589ebeef0c0fa88e",
"sha256": "e2823f9de52008ac5c99f257499ba9d2e104148c7d424b5fb00722fd1ef7eeff"
},
"downloads": -1,
"filename": "cdk_amazon_chime_resources-3.2.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "646161ef5d7fcafc589ebeef0c0fa88e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.8",
"size": 15420927,
"upload_time": "2024-04-22T00:08:47",
"upload_time_iso_8601": "2024-04-22T00:08:47.281629Z",
"url": "https://files.pythonhosted.org/packages/c6/4d/2f5ccfe580bd7411f3f7c744ee00c8006e667acb1f0553f29987c7346522/cdk_amazon_chime_resources-3.2.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5f6582885762e73f20dc59145502f2d302b09659cfe07f7b602d43139bece53e",
"md5": "f8b6528786758ca62adcf6819b5cf482",
"sha256": "bbf0521bda941c38e370365401cd16840ed831f963d0712b194236ef40814361"
},
"downloads": -1,
"filename": "cdk-amazon-chime-resources-3.2.7.tar.gz",
"has_sig": false,
"md5_digest": "f8b6528786758ca62adcf6819b5cf482",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.8",
"size": 15422631,
"upload_time": "2024-04-22T00:08:54",
"upload_time_iso_8601": "2024-04-22T00:08:54.102928Z",
"url": "https://files.pythonhosted.org/packages/5f/65/82885762e73f20dc59145502f2d302b09659cfe07f7b602d43139bece53e/cdk-amazon-chime-resources-3.2.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-22 00:08:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cdklabs",
"github_project": "cdk-amazon-chime-resources",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cdk-amazon-chime-resources"
}
JSON
