You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/content/docs/aws/services/ssm.md
+15-16Lines changed: 15 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,5 @@
1
1
---
2
2
title: "Systems Manager (SSM)"
3
-
linkTitle: "Systems Manager (SSM)"
4
3
description: Get started with Systems Manager (SSM) on LocalStack
5
4
tags: ["Free"]
6
5
persistence: supported
@@ -12,7 +11,7 @@ Systems Manager (SSM) is a management service provided by Amazon Web Services th
12
11
SSM simplifies tasks related to system and application management, patching, configuration, and automation, allowing you to maintain the health and compliance of your environment.
13
12
14
13
LocalStack allows you to use the SSM APIs in your local environment to run operational tasks on the Dockerized instances.
15
-
The supported APIs are available on our [API coverage page]({{< ref "coverage_ssm" >}}), which provides information on the extent of SSM's integration with LocalStack.
14
+
The supported APIs are available on our [API coverage page](), which provides information on the extent of SSM's integration with LocalStack.
16
15
17
16
## Getting started
18
17
@@ -27,20 +26,20 @@ To get started, pull the `ubuntu:focal` image from Docker Hub and tag it as `loc
27
26
LocalStack uses a naming scheme to recognise and manage the containers and images associated with it.
28
27
The container are named `localstack-ec2.<InstanceId>`, while images are tagged `localstack-ec2/<AmiName>:<AmiId>`.
29
28
30
-
{{< command >}}
31
-
$ docker pull ubuntu:focal
32
-
$ docker tag ubuntu:focal localstack-ec2/ubuntu-focal-docker-ami:ami-00a001
33
-
{{< / command >}}
29
+
```bash
30
+
docker pull ubuntu:focal
31
+
docker tag ubuntu:focal localstack-ec2/ubuntu-focal-docker-ami:ami-00a001
32
+
```
34
33
35
34
LocalStack's Docker backend treats Docker images with the above naming scheme as AMIs.
36
35
The AMI ID is the last part of the image tag, `ami-00a001` in this case.
37
36
You can run an EC2 instance using the [`RunInstances`](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_RunInstances.html) API.
38
37
Execute the following command to create an EC2 instance using the `ami-00a001` AMI.
39
38
40
-
{{< command >}}
41
-
$ awslocal ec2 run-instances \
39
+
```bash
40
+
awslocal ec2 run-instances \
42
41
--image-id ami-00a001 --count 1
43
-
{{< / command >}}
42
+
```
44
43
45
44
The following output would be retrieved:
46
45
@@ -71,12 +70,12 @@ You can copy the `InstanceId` value and use it in the following commands.
71
70
You can use the [`SendCommand`](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_SendCommand.html) API to send a command to the EC2 instance.
72
71
The following command sends a `cat lsb-release`commandin the `/etc` directory to the EC2 instance.
@@ -101,11 +100,11 @@ You can copy the `CommandId` value and use it in the following commands.
101
100
You can use the [`GetCommandInvocation`](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_GetCommandInvocation.html) API to retrieve the command output.
102
101
The following command retrieves the output of the command sent in the previous step.
Change the `CommandId` and `InstanceId` values to the ones you received in the previous step.
111
110
The following output would be retrieved:
@@ -127,7 +126,7 @@ The following output would be retrieved:
127
126
The LocalStack Web Application provides a Resource Browser for managing SSM System Parameters.
128
127
You can access the Resource Browser by opening the LocalStack Web Application in your browser, navigating to the **Resource Browser** section, and then clicking on **Simple Systems Manager (SSM)** under the **Management/Governance** section.
Copy file name to clipboardExpand all lines: src/content/docs/aws/services/stepfunctions.mdx
+40-38Lines changed: 40 additions & 38 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,7 @@
1
1
---
2
2
title: "Step Functions"
3
-
linkTitle: "Step Functions"
4
3
tags: ["Free"]
5
-
description: >
6
-
Get started with Step Functions on LocalStack
4
+
description: Get started with Step Functions on LocalStack
7
5
---
8
6
9
7
## Introduction
@@ -13,7 +11,7 @@ It provides a JSON-based structured language called Amazon States Language (ASL)
13
11
Thus making it easier to build and maintain complex and distributed applications.
14
12
15
13
LocalStack allows you to use the Step Functions APIs in your local environment to create, execute, update, and delete state machines locally.
16
-
The supported APIs are available on our [API coverage page]({{< ref "coverage_stepfunctions" >}}), which provides information on the extent of Step Function's integration with LocalStack.
14
+
The supported APIs are available on our [API coverage page](), which provides information on the extent of Step Function's integration with LocalStack.
17
15
18
16
## Getting started
19
17
@@ -28,8 +26,8 @@ You can create a state machine using the [`CreateStateMachine`](https://docs.aws
28
26
The API requires the name of the state machine, the state machine definition, and the role ARN that the state machine will assume to call AWS services.
29
27
Run the following command to create a state machine:
The output of the above command is the execution ARN:
77
75
@@ -87,10 +85,10 @@ The output of the above command is the execution ARN:
87
85
To check the status of the execution, you can use the [`DescribeExecution`](https://docs.aws.amazon.com/step-functions/latest/apireference/API_DescribeExecution.html) API.
88
86
Run the following command to describe the execution:
Replace the `execution-arn` with the ARN of the execution you want to describe.
96
94
@@ -161,10 +159,10 @@ LocalStack can also serve as a drop-in replacement for [AWS Step Functions Local
161
159
It supports test cases with mocked Task states and maintains compatibility with existing Step Functions Local configurations.
162
160
This functionality is extended in LocalStack by providing access to the latest Step Functions features such as [JSONata and Variables](https://blog.localstack.cloud/aws-step-functions-made-easy/), as well as the ability to enable both mocked and emulated service interactions emulated by LocalStack.
163
161
164
-
{{< callout >}}
162
+
:::note
165
163
LocalStack does not validate response formats.
166
164
Ensure the payload structure in the mocked responses matches what the real service expects.
167
-
{{< /callout >}}
165
+
:::
168
166
169
167
### Identify a State Machine for Mocked Integrations
170
168
@@ -287,9 +285,9 @@ In the example above:
287
285
-`Return`: Simulates a successful response by returning a predefined payload.
288
286
-`Throw`: Simulates a failure by returning an `Error` and an optional `Cause`.
289
287
290
-
{{< callout >}}
288
+
:::note
291
289
Each entry must have **either**`Return` or `Throw`, but cannot have both.
292
-
{{< /callout >}}
290
+
:::
293
291
294
292
Here is a complete example of the `MockedResponses` section:
295
293
@@ -390,12 +388,17 @@ Set the `SFN_MOCK_CONFIG` environment variable to the path of your mock configur
390
388
391
389
If you're running LocalStack in Docker, mount the file and pass the variable as shown below:
After the state machine is created and correctly named, you can run test cases defined in the mock configuration file using the [`StartExecution`](https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html) API.
431
435
@@ -435,22 +439,22 @@ This tells LocalStack to apply the corresponding mocked responses from the confi
During execution, any state mapped in the mock config will use the predefined response.
446
450
States without mock entries invoke the actual emulated service as usual.
447
451
448
452
You can inspect the execution using the [`DescribeExecution`](https://docs.aws.amazon.com/step-functions/latest/apireference/API_DescribeExecution.html) API:
The sample output shows the execution details, including the state machine ARN, execution ARN, status, start and stop dates, input, and output:
456
460
@@ -475,10 +479,10 @@ The sample output shows the execution details, including the state machine ARN,
475
479
476
480
You can also use the [`GetExecutionHistory`](https://docs.aws.amazon.com/step-functions/latest/apireference/API_GetExecutionHistory.html) API to retrieve the execution history, including the events and their details.
This will return the full execution history, including entries that indicate how mocked responses were applied to Lambda and SQS states.
484
488
@@ -522,9 +526,7 @@ The LocalStack Web Application includes a **Resource Browser** for managing Step
522
526
523
527
To access it, open the LocalStack Web UI in your browser, navigate to the **Resource Browser** section, and click **Step Functions** under **App Integration**.
Copy file name to clipboardExpand all lines: src/content/docs/aws/services/sts.md
+22-23Lines changed: 22 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,5 @@
1
1
---
2
2
title: "Security Token Service (STS)"
3
-
linkTitle: "Security Token Service (STS)"
4
3
description: Get started with Security Token Service on LocalStack
5
4
persistence: supported
6
5
tags: ["Free"]
@@ -13,7 +12,7 @@ STS implements fine-grained access control and reduce the exposure of your long-
13
12
The temporary credentials, known as security tokens, can be used to access AWS services and resources based on the permissions specified in the associated policies.
14
13
15
14
LocalStack allows you to use the STS APIs in your local environment to request security tokens, manage permissions, integrate with identity providers, and more.
16
-
The supported APIs are available on our [API coverage page]({{< ref "coverage_sts" >}}), which provides information on the extent of STS's integration with LocalStack.
15
+
The supported APIs are available on our [API coverage page](), which provides information on the extent of STS's integration with LocalStack.
17
16
18
17
## Getting started
19
18
@@ -28,18 +27,18 @@ You can create an IAM User and Role using the [`CreateUser`](https://docs.aws.am
28
27
The IAM User will be used to assume the IAM Role.
29
28
Run the following command to create an IAM User, named `localstack-user`:
30
29
31
-
{{< command >}}
32
-
$ awslocal iam create-user \
30
+
```bash
31
+
awslocal iam create-user \
33
32
--user-name localstack-user
34
-
{{< /command >}}
33
+
```
35
34
36
35
You can generate long-term access keys for the IAM user using the [`CreateAccessKey`](https://docs.aws.amazon.com/STS/latest/APIReference/API_CreateAccessKey.html) API.
37
36
Run the following command to create an access key for the IAM user:
38
37
39
-
{{< command >}}
40
-
$ awslocal iam create-access-key \
38
+
```bash
39
+
awslocal iam create-access-key \
41
40
--user-name localstack-user
42
-
{{< /command >}}
41
+
```
43
42
44
43
The following output would be retrieved:
45
44
@@ -58,9 +57,9 @@ The following output would be retrieved:
58
57
Using STS, you can also fetch temporary credentials for this user using the [`GetSessionToken`](https://docs.aws.amazon.com/STS/latest/APIReference/API_GetSessionToken.html) API.
59
58
Run the following command using your long-term credentials to get your temporary credentials:
60
59
61
-
{{< command >}}
62
-
$ awslocal sts get-session-token
63
-
{{< /command >}}
60
+
```bash
61
+
awslocal sts get-session-token
62
+
```
64
63
65
64
The following output would be retrieved:
66
65
@@ -80,11 +79,11 @@ The following output would be retrieved:
80
79
You can now create an IAM Role, named `localstack-role`, using the [`CreateRole`](https://docs.aws.amazon.com/STS/latest/APIReference/API_CreateRole.html) API.
@@ -115,22 +114,22 @@ The following output would be retrieved:
115
114
You can attach the policy to the IAM role using the [`AttachRolePolicy`](https://docs.aws.amazon.com/STS/latest/APIReference/API_AttachRolePolicy.html) API.
116
115
Run the following command to attach the policy to the IAM role:
@@ -157,9 +156,9 @@ You can use the temporary credentials in your applications for temporary access.
157
156
You can get the caller identity to identify the principal your current credentials are valid for using the [`GetCallerIdentity`](https://docs.aws.amazon.com/STS/latest/APIReference/API_GetCallerIdentity.html) API.
158
157
Run the following command to get the caller identity for the credentials set in your environment:
0 commit comments