Introduction:
Alexa is Amazon's cloud-based voice service that powers hundreds of millions of devices. It also enables developers to build skills, which are like applications for Alexa. The Alexa skill is a cloud-based solution that provides the logic and functionality to perform certain tasks using voice commands. The skill is hosted on AWS Lambda and is built using Alexa Skills Kit SDK (ASK) framework. The communication between Alexa service and the Lambda function hosting the Alexa skill is encrypted and the access permissions to the Lambda function are protected by AWS Identity and Access Management (IAM) policies. Therefore, we can be confident that Alexa skills are secure.
This step-by-step tutorial walks you through the process of developing an Alexa cloud-based solution. We will build our Alexa skill using Alexa Skills Kit SDK (ASK) for Python that will allow us to run AWS Systems Manager Documents (SSM documents) using Run Command, which is a capability of Systems Manager. The SSM documents run on AWS Systems Manager managed nodes (SSM managed EC2 instances) using AWS-RunDocument. Utilizing the AWS-RunDocument SSM document with Run Command enables us to run any SSM document on our managed nodes without having to modify our backend source code (Python). It is a great way to standardize the process of running SSM documents on our managed nodes. The SSM documents define the actions to perform on the managed instances and can be used to perform a variety of tasks such as patching OS, stopping EC2 instances, installing software, updating software, configuring operating systems, and much more. Basically, sky is the limit when it comes to the functionality of running SSM documents.
It is worth mentioning that this serverless solution is built using AWS services and components with minimal costs associated. The solution is also built using the best practices and the least privilege principle. The access permissions to the AWS services and components are protected by AWS Identity and Access Management (IAM) policies. Therefore, we can be confident that our solution is secure.
The ultimate goal of the tutorial is to simplify the process of building this cloud-based solution, learning how to create an Alexa skill and learning how to create several AWS services and components such as, DynamoDB table, IAM service role, SNS topic, Lambda functions, Secrets Manager secret, and SSM documents. Moreover, it is a great opportunity to learn about the logic behind the solution and the architecture of the solution.
As an AWS Community Builder, this is part of my continuous effort to share knowledge and experience with the community. The value added by this solution is to run SSM commands on our managed instances without having to log into the AWS console or to use the AWS CLI. We can perform tasks remotely and securely from anywhere using Alexa enabled devices such as an Echo device or Alexa mobile app. Run commands and tasks remotely on our managed instances using Alexa is a great way to save time and to automate the process of running SSM documents on our managed instances.
I intend keep the tutorial as simple as possible and will not go into the details unless necessary. I will pass the baton to you to take the solution to the next level. I will also intentionally intermingle between SSM documents and SSM commands. Although, the solution could be built using IaC, we would have lost the learning experience.
Remember, the goal of the tutorial is to learn and to understand the logic and architecture of the solution. It's about the journey, not the destination, so let's buckle up and get started!
Alexa Cloud Solution: Logic and Architecture:
The solution consists of several AWS services and components as shown on the diagram below. The logic flow might be a bit complex at first, but it becomes clearer as we go through the tutorial.
1- The user wakes up the Alexa skill by saying, Alexa, open {name of the skill}
on Alexa enabled devices such as an Echo device or Alexa mobile app. Our skill is called Command Control
.
2- The user initiates a voice command to run an SSM command for a specific instance tag by saying, {name of the command} {name of the tag}
, for example, patch dev
. Ofcourse, we can change the utterances to match our needs. But for the purpose of this tutorial, we will keep it simple.
3- The Alexa service sends a JSON body request to invoke the Lambda function hosting the Alexa skill (AlexaSkill function). The AlexaSkill Lambda function validates the request and extracts the command and tag from the request.
4- The AlexaSkill function sends a payload of the command and tag to the Master Lambda function. The Master Lambda function is invoked synchronously.
5- Based on the command and tag received, the Master Lambda function queries a DynamoDB table to obtain the SSM document name and any SSM document parameters corresponds to the command.
Note: not all SSM documents require parameters. It's our responsibility to make sure that the SSM document name and any SSM document parameters are valid. The parameters in the DynamoDB table should be in JSON format.
6- The Master Lambda function validates the response from the DynamoDB table. If the response is not valid, the Master Lambda function returns error message to AlexaSkill function. The handled errors could be such as, the Command, SSM document name, any SSM document parameters or even the DynamoDB table name are not valid or don't exist.
7- The Master Lambda function then queries whether or not the specified tag exists for any running EC2 instances in the region (the instance will be ignored if it's not in the running status). If the condition is met (tag exists and the instance is running), the Master Lambda function then queries whether or not the instances are SSM managed nodes. Again, if this condition is met (the instances are SSM managed nodes), the Master Lambda function sends the AWS-RunDocument
attributes to Run Command to run the SSM document on the EC2 instances. If the condition is not met, the Master Lambda function returns error message to AlexaSkill function. The handled errors could be such as, the specified tag does not exist for any running and SSM managed EC2 instances.
8- The Run Command runs the SSM document on the EC2 instances filtering by the specified tag. Once Run Command has started executing the SSM document on the EC2 instances successfully, the Pending
status is to be returned to the Master Lambda function.
9- The Master Lambda function sends the Pending
status, command, tag and number of instances the SSM document is running on back to AlexaSkill function and AlexaSkill function sends the response to the user.
10- The Run Command also sends notifications to the SNS topic to notify the user once the SSM document has been run on the EC2 instances and also when the status has been updated to InProgress
, Failed
or Success
.
Note: if you prefer to receive notifications via email, SMS, or any other method allowed by SNS, you can subscribe to the SNS topic. It's also worth noting that the Run Command records the status of the SSM document in the SSM document history. Therefore, we can always go to the Run Command history to see the status of the SSM document.
Important Notes:
- The Master Lambda function only runs SSM documents on running and SSM managed nodes. Therefore, if the EC2 instance is not running or not SSM managed, the Master Lambda function will ignore it.
- To create SSM managed nodes, we need to install the SSM agent on the EC2 instance. The SSM agent is installed by default on Amazon Linux 2 EC2 instances. However, if we are using other Linux distributions, we need to install the SSM agent manually. Then, we need to attach an instance profile IAM role with the
AmazonSSMManagedInstanceCore
policy to the EC2 instance. Please, refer to AWS documentation for more details on to setup SSM managed nodes. - We also need to tag the EC2 instances with a key-value pair to filter the EC2 instances. I have designated
Alexa
to be the constant tag key, and we need to specify the tag value in the voice command to match the tag value we have specified for the EC2 instances. Therefore, if the instance does not haveAlexa
as the tag key, the Master Lambda function ignores the instance. If we need to use a different tag key, we should modify thetag_key = 'Alexa
in the Master Lambda function Python source code. - As best practices, I have configured intensive code level logging to cover lots of error scenarios, which should be helpful for troubleshooting and debugging. If an error is raised, the Master Lambda function sends an error message to AlexaSkill and eventually back to the user. The error messages are also logged in CloudWatch Logs for the Master Lambda function log group.
Alexa Cloud-based Solution Architecture Diagram
Tutorial Sections:
The solution is broken down into several sections to make it easier to follow. The sections are as following:
- Creating an Alexa skill hosted on AWS Lambda function (AlexaSkill function) using the Alexa Skill Kit (ASK) SDK for Python and Boto3 SDK for Python
- Configuring the skill with Alexa service on Alexa Developer Console
- Creating an SSM document to stop running EC2 instances. We will also use AWS SSM document
AWS-RunPatchBaseline
to patch Amazon Linux 2 EC2 instances. This covers the two scenarios; running AWS managed SSM documents and customer created SSM documents - Creating an SNS topic to publish notifications from Systems Manager - Run Command
- Creating an IAM service role for Systems Manager to send notifications to the SNS topic
- Provisioning an on-demand DynamoDB table to store the commands, SSM document names and any SSM document parameters that are used by the Master Lambda function
- Creating a Lambda function (MasterLambda) to send SSM commands to Systems Manager - Run Command
- Creating a Lambda function (SlackLambda) to send notifications to Slack or you may use any other method of your choice (optional)
- Testing Alexa skill and Run Command
- Party time πππ
Prerequisites:
- An AWS account
- An AWS Alexa Developer account
- Python 3 (>= 3.6)
- pip
- virtualenv or venv
- Alexa enabled device or Alexa app on your mobile device
1: Creating Alexa skill hosted on AWS Lambda function (AlexaSkill)
Step 1: Setting up the ASK SDK in a virtual environment on Linux or macOS
1- Create a virtual environment:
virtualenv command_control
Note:
commands
is the name of the virtual environment. You can use any name you want. Also for Windows, you may refer to Alexa documentation for more details.
2- Activate the virtual environment:
source command_control/bin/activate
3- Install the ASK SDK:
pip install ask-sdk
Note: The ASK SDK is installed in the virtual environment. You can use the
deactivate
command to exit the virtual environment.
Step 2: Add skill source code
Create a Python file named lambda_function.py
in the command_control
root directory and copy the Python code from this Lambda function.
Note: it's important to name the file
lambda_function.py
because the Lambda function will be looking for this handler when it's invoked.
Step 3: Packaging and Creating Lambda Function (AlexaSkill function)
1- From the command_control
root directory, copy the lambda_function.py into lib/python3.8/site-packages/
directory.
cd command_control
cp lambda_function.py lib/python3.8/site-packages/
2- Navigate to the site-packages
directory to create a zip file of the dependencies:
cd lib/python3.8/site-packages
zip -r lambda-package.zip .
Note: There are multiple ways to create a zip file for the package. You can use any method you prefer or refer to AWS documentation for more information.
3- Navigate to AWS Lambda console and create a new function with the following settings:
- Function name:
AlexaSkill
or any name you prefer - Runtime: Python 3.9
- Architecture: x86_64
- Role: Create a new role with basic Lambda permissions
- Click Create function
Note: we will come back to add all necessary permissions to the lambda IAM role later.
4- Upload the lambda_package.zip
file to the Lambda function.
5- Copy the ARN of the Lambda function. We will need it later.
2: Configuring skill with Alexa service via the Alexa Developer Console
Step 1: Configuring Alexa service
- Navigate to the Alexa Developer Console and login to create a skill.
- Click on the
Create Skill
button.
- Name the skill
Command Control
and clickNext
.
- For
Experience, Model, Hosting service
page, select options as follows:
-
Other
forChoose a type of experience
-
Custom
forChoose a model
-
Provision your own
forHosting service
Then, click on the Next
button.
- On
Templates
page, select theStart from scratch
option and click on theNext
button. - On
Review
page, click on theCreate Skill
button.
Step 2: Configuring skill with Alexa Service
- Under
CUSTOM
section on the left hand side menu, click onInteraction Model
. Then, click onJSON Editor
tab. Copy the JSON text from this interaction model file and paste it into the JSON editor. Then, click on theSave Model
button followed by theBuild Model
button.
Note: the JSON text is the interaction model for the skill. It's a quicker way to define the intents and utterances for the skill instead of doing it manually. To learn more about the interaction model, refer to Alexa documentation. Also, ensure that you have not received any errors while building the model.
- Under
CUSTOM
section on the left hand side menu, click onEndpoint
. - Select the
AWS Lambda ARN
option, which is selected by default. Then, copyYour Skill ID
from theEndpoint
page. The Skill ID is the unique identifier for the skill. It allows Alexa to identify the skill and to invoke the Lambda function securely. We will need it later. - We will come back to this page to add our AlexaSkill Lambda function ARN.
Step 3: Configuring Lambda function hosting Alexa skill with Alexa service
- Navigate back to the AWS Lambda console and select the
AlexaSkill
function. - Add an Alexa trigger to the Lambda function as shown below and paste the
Your Skill ID
from theEndpoint
page. Then, click on theAdd
button. - Head back to the Alexa Developer Console and add the AlexaSkill Lambda function ARN to the
Endpoint
page. Then, click on theSave Endpoints
button. Refer to Step 2, bullet 4.
- Under Configuration, select
Permissions
tab and click onRole name
link to open the IAM role on a new tab. - Create an inline policy to allow the lambda to invoke other lambda functions. Define the policy as shown below:
- Service: Lambda
- Actions: InvokeFunction
- Resources:
arn:aws:lambda:us-east-1:123456789012:function:*
(replace the account number and region with your own)
Or, you can use the following JSON to create the policy:
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "InvokeLambda",
"Effect": "Allow",
"Action": "lambda:InvokeFunction",
"Resource": "arn:aws:lambda:us-east-1:123456789012:function:*"
}
]
}
- Replace the account number and region with your own
- Click on the
Review policy
button, give the policy a name and click on theCreate policy
button.
Note: you may create a customer managed policy and attach it to the role instead of creating an inline policy. Please, refer to AWS documentation for more information.
3: Creating SSM document to stop EC2 instances
As previously mentioned, we will create our own SSM document to stop EC2 instances, and we will also use an Amazon managed or built-in SSM document to patch Amazon Linux 2 EC2 instances. By following this strategy, we would cover two case scenarios:
- Customer created SSM document
- Amazon managed SSM document
The reasoning behind this is that we may have our own SSM documents to perform certain tasks. Also, we may need to use Amazon managed or built-in SSM documents to perform other tasks.
Step 1: Customer created SSM document:
The below steps are for creating an SSM document to stop Amazon Linux 2 EC2 instances:
- Navigate to AWS Systems Manager console and select
Documents
from the left hand side menu. - Click on the
Create document
button and selectCommand or Session
from the drop-down menu. - On the
Create document
page, enter the following information:
- Name:
StopEC2Instances
- Document type: Command document
- Content: YAML
- Content: Copy the YAML text from this file and paste it into the
Content
field and click on theCreate document
button.
Note: the SSM document works on Amazon Linux 2 instances. If you are using a different operating system, you may need to modify the SSM document to work with your operating system.
Step 2: Amazon managed SSM document:
This step is informational only. The Amazon managed document called AWS-RunPatchBaseline
is used to patch EC2 instances. It works on all operating systems (Windows, Linux, and macOS). The document requires parameters to be passed to it. The following parameters are some of the parameters that can be passed to the document, but not all of them are required:
- Operation: The operation to perform. Valid values: Scan, Install
- RebootOption: The reboot option for the instances. Valid values: RebootIfNeeded, NoReboot
- Target selection: The instances to patch. Valid values: InstanceIds, Tags
- Timeout(seconds): The maximum time (in seconds) that the command can run before it is considered to have failed. The default value is 3600 seconds.
- Rate control: The maximum number of instances that are allowed to run the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50.
- Error threshold: The maximum number of errors allowed before the system stops sending the command to additional targets.
- Output S3 bucket: The S3 bucket where the command execution details are stored.
- SNS topic: The SNS topic where notifications are sent when the command status changes.
- IAM role: The IAM role that allows Systems Manager to send notifications.
- Event notifications: The event notifications that trigger notifications about command status changes.
The following are the parameters that we will pass to the AWS-RunPatchBaseline document via RunDocument:
- Document name: AWS-RunPatchBaseline
- Document version: $LATEST
- Operation: Install
- RebootOption: RebootIfNeeded
- Target selection: Tags
- Timeout(seconds): 3600
- Rate control: 50
- Error threshold: 0
- SNS topic ARN: SSMCommandNotifications
- IAM role ARN: Systems Manager IAM role
- Event notifications: All
- Event notification Type: Command
- Comment: Alexa - AWS-RunPatchBaseline
Note: we will configure the minimum required parameters to run AWS-RunPatchBaseline document. For more information about these parameters, refer to AWS documentation.
4: Creating SNS topic to receive notifications from Systems Manager - Run Command
- Navigate to AWS SNS console and click on the
Create topic
button. - Enter the following information:
- Type: Standard
- Topic name:
SSMCommandNotifications
- Display name:
SSMCommandNotifications
- Click on the
Create topic
button.
- Capture the
Topic ARN
from theTopic details
page. We will use this ARN later to add it as environment variable to the lambda function.
Note: this SNS topic is to receive notifications from Systems Manager - Run Command.
5: Creating IAM role to allow Systems Manager to send notifications to SNS
This service role is assumed by Systems Manager to publish notifications to the SNS topic when the SSM command status changes.
Step 1: Creating the IAM role:
- Navigate to AWS IAM console and click on the
Create role
button. - Select
AWS service
from theSelect type of trusted entity
drop-down menu. Then, selectSystems Manager
from theChoose a use case for other AWS services
drop-down menu and selectSystems Manager
again. Click on theNext: Permissions
button.
- Click on the
Next
button on theAttach permissions
page. We will attach an inline policy to the role in the next step. - On the
Name, review and create
page, give the role a name and click on theCreate role
button.
Step 2: Attaching inline policy to the IAM role:
- Navigate to AWS IAM console and select
Roles
from the left hand side menu. - Search for the role you created in the previous step and click on the role name.
- Click on the
Add permissions
button and selectCreate inline policy
from the drop-down menu. - Click on the
JSON
tab and paste the following JSON body into thePolicy document
field:
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "VisualEditor0",
"Effect": "Allow",
"Action": "sns:Publish",
"Resource": "arn:aws:sns:us-east-1:123456789012:SSMCommandNotifications"
}
]
}
Note: replace the region, account ID, and SNS topic name with your own values. Or, you can use
"arn:aws:sns:*:*:*"
to allow the IAM role to send notifications to all SNS topics.
- Click on the
Review policy
button and give the policy a name. Then, click on theCreate policy
button. - Capture the IAM role ARN. We will use this ARN later to add it as environment variable to the lambda function.
6: Provisioning on-demand DynamoDB table
The DynamoDB table will be used to store the commands, SSM document names and any SSM document parameters that will be used by the Master Lambda function.
Step 1: Creating DynamoDB table:
- Navigate to AWS DynamoDB console and click on the
Create table
button. - Enter the following information:
- Table name:
SSMCommands
- Primary key:
Command
(String) - Table settings:
Customize settings
- Table class:
DynamoDB Standard
- Read/write capacity settings:
On-demand
- Click on the
Create
button.
- Capture the table name. We will add the name as as environment variable to the lambda function.
Step 2: Creating DynamoDB table items:
- Navigate to AWS DynamoDB console and select the
SSMCommands
table. - Click on the
Actions
button and selectCreate item
. - For the
Command
value field, entershutdown
.
Note: Alexa service does not support the
stop
command. It is a reserved word. Therefore, we will use theshutdown
command to stop the EC2 instances.
- Click on the
Add new attribute
button and selectString
from the dropdown menu. - For the
Attribute name
field, enterDocumentName
and for theValue
field, enterStopEC2Instances
. Click on theCreate item
button. - Repeat steps 2-5 and create a new item with the following information:
- Command:
patch
- DocumentName:
AWS-RunPatchBaseline
- Click on the
Add new attribute
button and selectString
from the dropdown menu. For theAttribute name
field, enterParameters
and for theValue
field, enter the following JSON:
{
"Operation":[
"Install"
],
"RebootOption":[
"RebootIfNeeded"
]
}
- Click on the
Create item
button.
7: Creating Master Lambda function (MasterLambda) to send SSM commands to Run Command
Step 1: Creating Lambda function:
- Navigate to AWS Lambda console and create a new function with the following settings:
- Function name:
MasterLambda
or any name you prefer - Runtime: Python 3.9
- Architecture: x86_64
- Role: Create a new role with basic Lambda permissions
- Click Create function
Note: we will revisit the lambda function IAM role to add all necessary permissions.
- Copy the Python source code for the MasterLambda function and paste it into the
Code source
on the Lambda console. Then, click on theDeploy
button. - Under
Configuration
tab, selectPermissions
and click onRole name
link to open the IAM role on a new tab. - Create inline policy and copy the inline policy from this JSON file and paste it into the JSON editor. Replace the account number with your own. Then, click on the
Review policy
button. Give the policy a name and click on theCreate policy
button. The added policy will allow the lambda function to perform the following actions:
- Service: SSM - Actions: SendCommand, ListCommands, DescribeInstanceInformation
- Service: ec2 - Actions: DescribeInstances
- Service: SNS - Actions: Publish
- Service: DynamoDB - Actions: Query
- Service: IAM - Actions: PassRole
Note: following AWS best practices and security principles, we are using the least privilege principle to grant the lambda function only the permissions it needs to run and to communicate other AWS services successfully. For more information, refer to AWS documentation.
- Under
Configuration
tab, selectGeneral configuration
and click onEdit
button. Change the timeout to 30 seconds and click on theSave
button.
Note: I have tested 30 seconds timeout and 128 MB memory and they are sufficient for this solution.
- Under
Configuration
tab, selectEnvironment variables
and click onEdit
button. Add the following environment variables:
-
DynamoDB_Table_Name
:SSMCommands
(replace the DynamoDB table name from the previous step) -
SNS_Topic_ARN
:arn:aws:sns:us-east-1:123456789012:SSMCommandNotifications
(replace the SNS topic ARN from the previous step) SSM_Role_ARN
:arn:aws:iam::123456789012:role/SSMCommandRole
(replace the IAM role ARN from the previous step)The environment variables are used by the Master Lambda function to access the DynamoDB table and to pass on the SNS topic and the IAM role to Systems Manager.
- Click on the
Save
button.
Step 2: Configuring communication between MasterLambda function and AlexaSkill Lambda function:
- Navigate to AWS Lambda console and select the
AlexaSkill
function. - Under
Configuration
tab, selectEnvironment variables
and click onEdit
button. Add the following environment variables:
-
MasterLambdaARN
:arn:aws:lambda:us-east-1:123456789012:function:MasterLambda
(replace the ARN with your own value or copy the Master Lambda function ARN from the previous step)
8: Creating Lambda function (SlackLambda) to send notifications to Slack (Optional)
Step 1: Creating Secrets Manager secret to store Slack webhook URL:
The AWS Secrets Manager is used to store the Slack webhook URL. The webhook URL is a unique URL that is used to send messages to a specific Slack channel. For more information about Slack webhooks, refer to Slack documentation.
- Navigate to AWS Secrets Manager console and click on the
Store a new secret
button. - Enter the following information:
- Secret type:
Other type of secret
- Key/Value pairs: select
Plaintext
and remove everything from the block. - Paste the full Slack webhook URL and click on the
Next
button. - Secret name:
SlackWebhookURL
- Description:
Slack webhook URL
- Click on the
Next
button andNext
again. Then, click on theStore
button.
Note: we are using AWS Secrets Manager to store the Slack webhook URL. For more information, refer to AWS documentation.
Step 2: Creating Slack lambda function:
- Navigate to AWS Lambda console and create a new function with the following settings:
- Function name:
SlackLambda
or any name you prefer - Runtime: Python 3.7
- Architecture: x86_64
- Role: Create a new role with basic Lambda permissions
- Click Create function
Note: I have Python 3.7 as a runtime for this function due to the fact that the
requests
library is supported as part of the AWS Lambda execution environment in Python 3.7 and below. It means that we don't have to create a deployment package. Therequest
library is not supported in Python 3.8 and above. For more information, refer to AWS blog
- Copy the Python code for the SlackLambda function and paste it into the
Code source
on the Lambda console. Then, click on theDeploy
button. - Under
Configuration
tab, selectPermissions
and click onRole name
link to open the IAM role on a new tab. - Create inline policy and copy the inline policy from this JSON and paste it into the JSON editor. Then, click on the
Review policy
button. Give the policy a name and click on theCreate policy
button. The added policy is to allow the Lambda function to get the Slack webhook URL from Secrets Manager by performing the following action:
- Service: secretsmanager - Actions: GetSecretValue
- Under
Configuration
tab, selectGeneral configuration
and click onEdit
button. Change the timeout to30
seconds and click on theSave
button. - On the
SlackLambda.py
file, make sure to update theSLACK_CHANNEL
variable with the Slack channel name. Then, click on theDeploy
button.
-
SLACK_CHANNEL
: the Slack channel name
- If you are using a different name for the Secrets Manager secret, make sure to update the
SLACK_HOOK_URL
variable with the name of the secret for the Slack URL. Then, click on theDeploy
button.
SLACK_HOOK_URL
= boto3.client('secretsmanager').get_secret_value(SecretId='SlackWebhookURL')['SecretString']Replace
SecretId
with your secret name.
Step 3: Subscribing SlackLambda function to the SNS topic:
- From the AWS Lambda console, select the
SlackLambda
function. - Under
Function overview
, click on theAdd trigger
button. - Select
SNS
and again selectSSMCommandNotifications
topic. Then, click on theAdd
button.
Note: the
SSMCommandNotifications
topic is the SNS topic that we created in the previous section. If navigate to the SNS console, you will see that theSlackLambda
function is subscribed to theSSMCommandNotifications
topic.
9: Testing Alexa skill solution
Now, we have configured the Alexa skill solution, we are ready to test it. We will spin up two Amazon Linux 2 EC2 instances and then run the shutdown
command to stop the first instance on Alexa Developer Console simulator. Then, we will run the patch
command to patch the second instance. However, we need to tag the instances with the key-value pair first.
Instance | Tag Key | Tag Value |
---|---|---|
Instance 1 | Alexa |
testing |
Instance 2 | Alexa |
patching |
Note: the tags are case sensitive. The
A
in Alexa has to be capitalized andtesting
andpatching
have to be lower case. These are the commands and tags that we have defined in the Alexa Service. If you want to use different commands and tags, you will need to update the Alexa Service manually or update the Interaction Model JSON file.
Step 1: Tagging EC2 instances:
During the provisioning of the two EC2 instances, add the above tags to the instances accordingly. Alternatively, you can add the tags to the instances after provisioning them. However, it might take a few minutes for Systems Manager to detect the tags.
How to add tags to the EC2 instances after provisioning them:
- Navigate to the EC2 console and select the first instance.
- Click on the
Tags
tab and click on theAdd/Edit tags
button. - Add the following tags:
Key | Value |
---|---|
Alexa | testing |
- Repeat the same steps for the second instance and add the following tags:
Key | Value |
---|---|
Alexa | patching |
Note: the EC2 instances should be managed by Systems Manager. To confirm that, navigate to the Systems Manager console and under
Node Management
, selectFleet Manager
. You should see the two instances listed there.
Step 2: Testing Alexa skill:
- Navigate to the Alexa Developer Console and click on the name of the skill,
Command Control
. - Click on the
Test
tab and toggle theSkill testing is enabled in
toDevelopment
.
- Next to the microphone icon, type
open command control
and click on theEnter
button. - Type
shutdown
andtesting
as shown below and click on theEnter
button.
- If you have not tagged the EC2 instance with the key-value pair
Alexa
andtesting
, the instance is not running or the instance is not managed by Systems Manager, you will get the following error message:
I couldn't find any running instances tagged with testing. You can run a different command or say cancel to exit.
- If you have tagged the EC2 instance with the key-value pair
Alexa
andtesting
, the instance is running and the instance is managed by Systems Manager, you will get the following message:
I have sent command shutdown to 1 instance tagged with testing and its current status is Pending. You will receive a Slack notification when the command starts and completes.
Example:
- I had not tagged the EC2 instance with the key-value pair
Alexa
andtesting
and received a message by Alexa stating that there is no running instance tagged withtesting
. - Then, I tagged the EC2 instance with the key-value pair
Alexa
andtesting
and waited for a few minutes for Systems Manager to detect the tags. - Then, I ran the
shutdown
command and received a message by Alexa stating that the command has been sent to the instance. It takes the instance one minute to shutdown according to ourStopEC2Instances
SSM document as per design. - I also received a Slack notification stating that the command has been sent to the instance and the command status is
InProgress
and thenSuccess
when the command completed.
- Now, let's run the
patch
command to patch the second instance. Typepatch
andpatching
and click enter. Since we have spun up the instance recently, there are no patches to install and it would not take long to complete the patching. AWS is doing a great job in keeping the Amazon Linux 2 up to date. We can follow the command status or history in the Systems Manager console. We should receive Slack notifications when the command starts and completes, if we have configured SlackLambda function and Slack webhook URL correctly.
Refer to the GitHub repo to see the video.
Alexa to Run Systems Manager Documents
Introduction:
Alexa is Amazon's cloud-based voice service that powers hundreds of millions of devices. It also enables developers to build skills, which are like applications for Alexa. The Alexa skill is a cloud-based solution that provides the logic and functionality to perform certain tasks using voice commands. The skill is hosted on AWS Lambda and is built using Alexa Skills Kit SDK (ASK) framework. The communication between Alexa service and the Lambda function hosting the Alexa skill is encrypted and the access permissions to the Lambda function are protected by AWS Identity and Access Management (IAM) policies. Therefore, we can be confident that Alexa skills are secure.
This step-by-step tutorial walks you through the process of developing an Alexa cloud-based solution. We will build our Alexa skill using Alexa Skills Kit SDK (ASK) for Python that will allow us to run AWS Systemsβ¦
Important Notes
- If the simulator sits idle for 5 minutes or so, it will time out and you will need to refresh the page and start over.
- To troubleshoot any issues, you can check the CloudWatch logs for the
MasterLambda
andAlexaSkills
Lambda functions. - You can also check the Systems Manager console to see the command status and the command output by going to the
Run Command
section and selecting theCommand history
. - You can enable
Your Skills
in development mode on Alexa app on your mobile phone and test the skill on your mobile phone.
Conclusion
Congratulations on completing this tutorial! We have learned how to build a complete Alexa skill solution that can run SSM documents on SSM managed EC2 instances. The journey started with creating an Alexa skill hosted on an AWS Lambda function. Then we created a Master Lambda function that is triggered by the Alexa skill Lambda function. The Master Lambda function calls Systems Manager API using Boto3 SDK for Python to run SSM documents on SSM managed EC2 instances. We also created a Slack Lambda function that is subscribed to an SNS topic to send neat Slack notifications when the SSM command starts and completes. We have also learned how to use the Alexa Developer Console to test the Alexa skill.
Yes, it's time to celebrate! πππ
While you are celebrating, you can also think about how you can extend or improve this solution. Maybe you can add more SSM documents and more Alexa commands, or maybe you can learn more about Alexa utterances and intents. How about we take this solution to the next level and build an Observability solution? Maybe we can use the Alexa service with Grafana or CloudWatch to monitor metrics of our environments. That's another tutorial for another day π
The possibilities are endless and learning is a lifelong journey. Innovation is the key to success, so keep learning and keep innovating!
References
- Alexa Skills Kit - Tutorials
- Alexa Skills Kit SDK for Python
- AWS Lambda
- AWS Systems Manager
- AWS IAM
- AWS S3
Alexa to Run Systems Manager Documents
Introduction:
Alexa is Amazon's cloud-based voice service that powers hundreds of millions of devices. It also enables developers to build skills, which are like applications for Alexa. The Alexa skill is a cloud-based solution that provides the logic and functionality to perform certain tasks using voice commands. The skill is hosted on AWS Lambda and is built using Alexa Skills Kit SDK (ASK) framework. The communication between Alexa service and the Lambda function hosting the Alexa skill is encrypted and the access permissions to the Lambda function are protected by AWS Identity and Access Management (IAM) policies. Therefore, we can be confident that Alexa skills are secure.
This step-by-step tutorial walks you through the process of developing an Alexa cloud-based solution. We will build our Alexa skill using Alexa Skills Kit SDK (ASK) for Python that will allow us to run AWS Systemsβ¦
Top comments (0)