cdk-alexa-skill
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.1 • Public • Published

    Alexa Skill CDK Construct

    This is a CDK construct library for creating an Alexa Skill.

    This library currently supports NodeJS and Python.

    Installation

    Install with npm

    $ npm install cdk-alexa-skill

    Install with pip

    $ pip install cdk-alexa-skill

    CDK compatibility

    • Version 2.x is compatible with the CDK v2.
    • Version 1.x is compatible with the CDK v1. There won't be regular updates for this.

    Usage/Examples

    TypeScript:

    import * as cdk from '@aws-cdk/core';
    import * as lambda from '@aws-cdk/aws-lambda';
    import { Skill } from 'cdk-alexa-skill';
    
    const skillBackendLambdaFunction = new lambda.Function(this, 'Function', {
        ...
    });
    
    const skill = new Skill(this, 'Skill', {
        endpointLambdaFunction: skillBackendLambdaFunction, // @aws-cdk/aws-lambda.IFunction object containing backend code for the Alexa Skill
        skillPackagePath: 'src/skill-package', // path to your skill package
        alexaVendorId: 'XXXXXXXXXX', // vendor ID of Alexa Developer account
        lwaClientId: 'XXXXXXXXXX', // client ID of LWA Security Profile
        lwaClientSecret: cdk.SecretValue.secretsManager('lwa-client-secret'), // @aws-cdk/core.SecretValue object containing client secret of LWA Security Profile
        lwaRefreshToken: cdk.SecretValue.secretsManager('lwa-refresh-token') // @aws-cdk/core.SecretValue object containing refresh token of LWA Security Profile
    });

    Python:

    from aws_cdk import core
    from aws_cdk import aws_lambda as lambda_
    from cdk_alexa_skill import Skill
    
    skill_backend_lambda_function = lambda_.Function(self, 'Function',
        ...)
    
    skill = Skill(self, 'Skill',
        endpoint_lambda_function=skill_backend_lambda_function, # aws_cdk.aws_lambda.IFunction object containing backend code for the Alexa Skill
        skill_package_path='src/skill_package', # path to your skill package
        alexa_vendor_id='XXXXXXXXXX', # vendor ID of Alexa Developer account
        lwa_client_id='XXXXXXXXXX', # client ID of LWA Security Profile
        lwa_client_secret=core.SecretValue.secrets_manager('lwa-client-secret'), # @aws-cdk/core.SecretValue object containing client secret of LWA Security Profile
        lwa_refresh_token=core.SecretValue.secrets_manager('lwa-refresh-token')) # @aws-cdk/core.SecretValue object containing refresh token of LWA Security Profile

    See example folder or this blog post for a more complete example.

    Contributing

    Contributions of all kinds are welcome and celebrated. Raise an issue, submit a PR, do the right thing.

    See CONTRIBUTING.md for contributing guidelines.

    License

    MIT

    Install

    npm i cdk-alexa-skill

    DownloadsWeekly Downloads

    29

    Version

    2.0.1

    License

    MIT-0

    Unpacked Size

    141 kB

    Total Files

    14

    Last publish

    Collaborators

    • amzn-oss
    • gardnerjh