cdk construct for importing a zipped Lex bot
Project description
cdk-lex-zip-import
An AWS Cloud Development Kit (AWS CDK) construct library that allows you to upload and deploy a Zipped Lex Bot. Once imported, this Bot can be managed within the Amazon Lex Console.
Usage
To add to your AWS CDK package.json file:
yarn add cdk-lex-zip-import
Within your AWS CDK:
Import Lex Bot
const bot = new lexupload.ImportBot(this, 'lexBot', {
sourceDirectory: './resources/LexBot',
lexRoleArn: lexRole.roleArn,
});
The sourceDirecotry
must include a file named LexBot.zip
. All files in that directory will be uploaded, but only a file named LexBot.zip
will be imported to Lex as a Bot.
The lexRoleArn
refers to the roleArn of an IAM Role. For example:
const lexRole = new iam.Role(this, 'lexRole', {
assumedBy: new iam.ServicePrincipal('lex.amazonaws.com'),
inlinePolicies: {
['lexPolicy']: new iam.PolicyDocument({
statements: [
new iam.PolicyStatement({
resources: ['*'],
actions: ['polly:SynthesizeSpeech', 'comprehend:DetectSentiment'],
}),
],
}),
},
});
Adding a Resource Policy
bot.addResourcePolicy(resourceArn, policy);
addResourcePolicy
requires two properties: the resourceArn
of the Lex Bot, and a policy to be applied. This policy will be applied to the alias associated with the Bot.
Resource ARN Example:
const resourceArn = `arn:aws:lex:${this.region}:${this.account}:bot-alias/${bot.botId}/${bot.botAliasId}`;
Policy Example:
const policy = {
Version: '2012-10-17',
Statement: [
{
Sid: 'AllowChimePstnAudioUseBot',
Effect: 'Allow',
Principal: { Service: 'voiceconnector.chime.amazonaws.com' },
Action: 'lex:StartConversation',
Resource: resourceArn,
Condition: {
StringEquals: { 'AWS:SourceAccount': `${this.account}` },
ArnEquals: {
'AWS:SourceArn': `arn:aws:voiceconnector:us-east-1:${this.account}:*`,
},
},
},
],
};
Not Supported Yet
This is a work in progress.
Features that are not supported yet:
- Non-Draft Versions
- Updates to created resources
Contributing
See CONTRIBUTING for more information.
License
This project is licensed under the Apache-2.0 License.
Project details
Release history Release notifications | RSS feed
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
Hashes for cdk-lex-zip-import-0.0.62.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a7a4d099fe927d835136309d217ffd3036b42cca8c2bb23faa11c4b16d0c7cc7 |
|
MD5 | 1ee1f7c37eeaa8cd69531183785e81fe |
|
BLAKE2b-256 | e337b31829546eda625afe16cfea8442628f4a63ebab34ffef06d10834332cbb |
Hashes for cdk_lex_zip_import-0.0.62-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | efec6cfdeb98cea5eb168549871c03ca5d20bac4869869e79cecada8bb8f2efa |
|
MD5 | 3657292a34dab4f37cd357fe9f9bed88 |
|
BLAKE2b-256 | e5fcfd75593cc0f19563efeae5382fd99f72140f10495f7bbd2091e0e24a22ef |