AWS Toolkit for VS Code - User Guide

AWS Toolkit for VS Code

User Guide

AWS Toolkit for VS Code User Guide

AWS Toolkit for VS Code: User Guide

Copyright ? 2023 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon.

AWS Toolkit for VS Code User Guide

Table of Contents

AWS Toolkit for Visual Studio Code ...................................................................................................... 1 What is the AWS Toolkit for Visual Studio Code ............................................................................. 1 Related information ................................................................................................................... 1

Setting Up ........................................................................................................................................ 2 Installing the Toolkit for VS Code ................................................................................................ 2 Prerequisites ...................................................................................................................... 2 Install the Toolkit for VS Code ............................................................................................. 3 Establishing credentials ............................................................................................................... 4 Using AWS-supported credentials ......................................................................................... 4 Using an external credential process ..................................................................................... 9 Connecting to AWS .................................................................................................................... 9 Connect to AWS through the Toolkit for VS Code ................................................................. 10 Use multiple AWS accounts with the Toolkit ........................................................................ 12 Changing AWS Regions ............................................................................................................. 12 Add a Region to the AWS Explorer ..................................................................................... 13 Hide a Region from the AWS Explorer ................................................................................. 14 Configuring your toolchain ........................................................................................................ 15 Configure a toolchain for .NET Core .................................................................................... 15 Configure a toolchain for Node.js ....................................................................................... 15 Configure a toolchain for Python ....................................................................................... 16 Configure a toolchain for Java ........................................................................................... 16 Configure a toolchain for Go ............................................................................................. 16 Using Your toolchain ........................................................................................................ 17

Navigating the Toolkit ...................................................................................................................... 18 Fundamental UI Components ..................................................................................................... 18 The AWS Explorer ............................................................................................................ 18 The AWS CDK Explorer ...................................................................................................... 19 Toolkit for VS Code commands .................................................................................................. 19 Visual Studio Code Command Palette ................................................................................. 19 AWS Explorer Menu ......................................................................................................... 19

Working with AWS Services ............................................................................................................... 20 Experimental features ............................................................................................................... 20 AWS Explorer ........................................................................................................................... 21 Amazon CodeCatalyst ............................................................................................................... 22 What is Amazon CodeCatalyst? .......................................................................................... 22 Getting started with CodeCatalyst ...................................................................................... 22 Working with CodeCatalyst resources .................................................................................. 24 Working with Dev Environments ........................................................................................ 26 Troubleshooting ............................................................................................................... 28 Amazon API Gateway ................................................................................................................ 29 AWS App Runner ...................................................................................................................... 29 Prerequisites .................................................................................................................... 30 Pricing ............................................................................................................................ 31 Creating App Runner services ............................................................................................ 32 Managing App Runner services .......................................................................................... 33 AWS CDK ................................................................................................................................ 35 AWS CDK applications ....................................................................................................... 35 AWS CloudFormation stacks ...................................................................................................... 37 Deleting an AWS CloudFormation stack .............................................................................. 37 Create a CloudFormation template ..................................................................................... 38 Amazon CloudWatch Logs ......................................................................................................... 39 Viewing CloudWatch log groups and log streams ................................................................. 39 Working with CloudWatch log events .................................................................................. 40 Amazon CodeWhisperer ............................................................................................................ 41

iii

AWS Toolkit for VS Code User Guide

What is CodeWhisperer? .................................................................................................... 41 Amazon ECR ............................................................................................................................ 41

Prerequisites .................................................................................................................... 41 Using Amazon ECR with Toolkit for VS Code ........................................................................ 43 Amazon ECS ............................................................................................................................ 48 Using IntelliSense for task-definition files ............................................................................ 48 Amazon ECS Exec ............................................................................................................. 49 Amazon EventBridge ................................................................................................................. 51 Working with Amazon EventBridge Schemas ........................................................................ 51 AWS IoT .................................................................................................................................. 53 AWS IoT prerequisites ....................................................................................................... 53 AWS IoT Things ................................................................................................................ 54 AWS IoT certificates .......................................................................................................... 55 AWS IoT policies .............................................................................................................. 56 AWS Lambda Functions ............................................................................................................. 58 Interacting with Remote Lambda Functions ......................................................................... 59 Amazon S3 .............................................................................................................................. 64 Amazon S3 overview ........................................................................................................ 64 AWS Serverless Application ....................................................................................................... 67 Getting Started ................................................................................................................ 68 Running and debugging Lambda functions directly from code ................................................ 72 Running and debugging local Amazon API Gateway resources ................................................ 75 Configuration options for debugging serverless applications .................................................. 77 Troubleshooting ............................................................................................................... 82 AWS Systems Manager .............................................................................................................. 83 Assumptions and prerequisites ........................................................................................... 84 IAM permissions for Systems Manager Automation documents ............................................... 84 Creating a new Systems Manager Automation document ....................................................... 85 Opening an existing Systems Manager Automation document ................................................ 85 Editing a Systems Manager Automation document ............................................................... 85 Publishing a Systems Manager Automation document ........................................................... 86 Deleting a Systems Manager Automation document ............................................................. 86 Executing a Systems Manager Automation document ............................................................ 87 Troubleshooting ............................................................................................................... 87 AWS Step Functions ................................................................................................................. 87 AWS Step Functions and VS Code ...................................................................................... 87 Resources ................................................................................................................................ 94 IAM permissions for accessing resources .............................................................................. 94 Adding and interacting with existing resources ..................................................................... 95 Creating and editing resources ........................................................................................... 96 Security ........................................................................................................................................... 98 Data protection ........................................................................................................................ 98 Document history ............................................................................................................................. 99

iv

AWS Toolkit for VS Code User Guide What is the AWS Toolkit for Visual Studio Code

AWS Toolkit for Visual Studio Code

This is the user guide for the AWS Toolkit for VS Code. If you are looking for the AWS Toolkit for Visual Studio, see the User Guide for the AWS Toolkit for Visual Studio.

What is the AWS Toolkit for Visual Studio Code

The Toolkit for VS Code is an open-source extension for the Visual Studio Code (VS Code) editor. This extension makes it easier for developers to develop, debug locally, and deploy serverless applications that use Amazon Web Services (AWS). Topics ? Setting Up the AWS Toolkit for Visual Studio Code (p. 2) ? Navigating the AWS Toolkit for Visual Studio Code (p. 18) ? Working with AWS Services (p. 20)

Related information

Use the following resources to access the source code for the toolkit or view currently open issues. ? Source Code ? Issue Tracker To learn more about the Visual Studio Code editor, visit .

1

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download