API deployment and stages in AWS - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is an API deployment in AWS API Gateway?

An API deployment is a snapshot of your API configuration that you can make available to users. It represents a specific version of your API that is ready to be called.

beginner

What is an API stage in AWS API Gateway?

An API stage is a named reference to a deployment. It acts like a live environment (for example, 'dev', 'test', or 'prod') where the deployed API is accessible.

intermediate

Why use stages in API Gateway?

Stages let you manage different versions of your API for different environments. You can test changes in a 'dev' stage before moving them to 'prod' without affecting users.

beginner

How do you create a new deployment in AWS API Gateway?

You create a deployment by selecting your API and choosing to deploy it to a stage. This saves the current API configuration as a deployment linked to that stage.

intermediate

What happens if you redeploy an API to the same stage?

Redeploying updates the stage to point to the new deployment. This means the API changes become live immediately for that stage's users.

What does an API stage represent in AWS API Gateway?

A A security setting for your API

B A backup of your API configuration

C A live environment where a deployed API version is accessible

D A database connected to your API

An API stage is a live environment like 'dev' or 'prod' where the deployed API version is accessible.

What is the purpose of deploying an API in AWS API Gateway?

A To delete the API

B To monitor API usage

C To create a new API from scratch

D To save a snapshot of the API configuration for use

Deployment saves a snapshot of the API configuration that can be accessed by users.

If you want to test API changes without affecting users, what should you use?

A A separate API stage like 'dev'

B Delete the production API

C Deploy directly to 'prod'

D Disable the API

Using a separate stage like 'dev' allows testing without affecting production users.

What happens when you redeploy an API to the same stage?

A The stage updates to the new deployment and changes go live

B The API is deleted

C Nothing changes

D A new stage is created automatically

Redeploying updates the stage to point to the new deployment, making changes live.

Which of the following is NOT a typical stage name in API Gateway?

A test

B backup

C prod

D dev

'backup' is not a typical stage name; common ones are 'dev', 'test', and 'prod'.

Explain what an API deployment and an API stage are in AWS API Gateway and how they work together.

Think of deployment as a saved version and stage as the place where users access that version.

Describe why using multiple stages is important when managing APIs in AWS API Gateway.

Consider how you might test a new recipe before serving it to guests.

Practice

1. What is the main purpose of an API stage in AWS API Gateway?

easy

A. To monitor network traffic outside AWS

B. To store API keys for users

C. To create backend Lambda functions

D. To manage different versions or environments of the API

Solution

1. Step 1: Understand API stages concept

   API stages in AWS API Gateway represent different versions or environments like development, testing, or production.

2. Step 2: Identify the role of stages

   Stages allow you to deploy and manage separate API versions independently.

3. Final Answer:

   To manage different versions or environments of the API -> Option D

4. Quick Check:

   API stages = version/environment management [OK]

Hint: Stages separate API versions or environments [OK]

Common Mistakes:

• Confusing stages with API keys
• Thinking stages create backend functions
• Assuming stages monitor external traffic

2. Which AWS CLI command is used to create a new deployment for an API Gateway REST API?

easy

A. aws apigateway create-deployment

B. aws apigateway create-stage

C. aws apigateway deploy-api

D. aws apigateway new-deployment

Solution

1. Step 1: Identify the correct AWS CLI command for deployment

   The command to create a deployment in API Gateway is create-deployment.

2. Step 2: Differentiate from other commands

   create-stage creates a stage, not a deployment. Other options are invalid commands.

3. Final Answer:

   aws apigateway create-deployment -> Option A

4. Quick Check:

   Deployment command = create-deployment [OK]

Hint: Deploy with 'create-deployment' command [OK]

Common Mistakes:

• Using create-stage instead of create-deployment
• Assuming deploy-api is a valid command
• Confusing deployment with stage creation

3. Given the following AWS CLI command:
aws apigateway create-stage --rest-api-id abc123 --stage-name prod --deployment-id dep456
What does this command do?

medium

A. Creates a new deployment named 'prod' for API 'abc123'

B. Creates a new stage 'prod' linked to deployment 'dep456' for API 'abc123'

C. Deletes the stage 'prod' from API 'abc123'

D. Updates the deployment 'dep456' with stage 'prod'

Solution

1. Step 1: Analyze the command parameters

   The command is create-stage with parameters for API ID, stage name, and deployment ID.

2. Step 2: Understand the effect of create-stage

   This creates a new stage named 'prod' that points to the deployment 'dep456' for the API 'abc123'.

3. Final Answer:

   Creates a new stage 'prod' linked to deployment 'dep456' for API 'abc123' -> Option B

4. Quick Check:

   create-stage + deployment-id = new stage linked to deployment [OK]

Hint: create-stage links stage to deployment by deployment-id [OK]

Common Mistakes:

• Confusing stage creation with deployment creation
• Thinking it deletes or updates instead
• Mixing up stage name and deployment ID

4. You ran this command to deploy your API stage:
aws apigateway create-stage --rest-api-id abc123 --stage-name test --deployment-id dep789
But you get an error saying the deployment ID does not exist. What is the likely cause?

medium

A. The deployment ID 'dep789' was not created before creating the stage

B. The stage name 'test' is invalid

C. The rest-api-id 'abc123' is incorrect format

D. You must create the stage before creating the deployment

Solution

1. Step 1: Understand the dependency between deployment and stage

   A stage must point to an existing deployment. If deployment ID does not exist, stage creation fails.

2. Step 2: Identify the error cause

   The error indicates deployment 'dep789' was not created or is invalid before stage creation.

3. Final Answer:

   The deployment ID 'dep789' was not created before creating the stage -> Option A

4. Quick Check:

   Stage needs existing deployment ID [OK]

Hint: Create deployment before stage with deployment ID [OK]

Common Mistakes:

• Assuming stage name format causes error
• Thinking API ID format is the issue
• Believing stage must be created before deployment

5. You want to deploy a new version of your API to a 'prod' stage without affecting the current live API. Which sequence of AWS CLI commands should you use?

hard

A. aws apigateway create-deployment -> aws apigateway create-stage with 'prod'

B. aws apigateway create-stage with 'prod' -> aws apigateway create-deployment

C. aws apigateway create-deployment -> aws apigateway update-stage with 'prod'

D. aws apigateway update-stage with 'prod' -> aws apigateway create-deployment

Solution

1. Step 1: Deploy new API version

   First, create a new deployment to capture the latest API changes.

2. Step 2: Update existing 'prod' stage to point to new deployment

   Use update-stage to switch the 'prod' stage to the new deployment without creating a new stage.

3. Final Answer:

   aws apigateway create-deployment -> aws apigateway update-stage with 'prod' -> Option C

4. Quick Check:

   Deploy then update stage to switch versions [OK]

Hint: Create deployment then update existing stage [OK]

Common Mistakes:

• Creating a new stage instead of updating existing
• Updating stage before deployment exists
• Assuming create-stage can update existing stage