Skip to content

Commit d3e34af

Browse files
Merge pull request #9 from localstack/service-docs-revamp
revamp aws service docs
2 parents 1a27617 + 376aba4 commit d3e34af

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

100 files changed

+4174
-3389
lines changed
Loading

src/content/docs/aws/services/account-management.md renamed to src/content/docs/aws/services/account.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,23 @@
11
---
22
title: "Account Management"
3-
linkTitle: "Account Management"
43
description: Get started with AWS Account Management on LocalStack
54
tags: ["Ultimate"]
65
---
76

87
## Introduction
98

10-
The Account service provides APIs to manage your AWS account.
9+
Account service provides APIs to manage your AWS account.
1110
You can use the Account APIs to retrieve information about your account, manage your contact information and alternate contacts.
1211
Additionally, you can use the Account APIs to enable or disable a region for your account, and delete alternate contacts in your account.
1312

1413
LocalStack allows you to use the Account API to retrieve information about your account.
15-
The supported APIs are available on our [API coverage page]({{< ref "coverage_account" >}}), which provides information on the extent of Account's integration with LocalStack.
14+
The supported APIs are available on our [API coverage page](), which provides information on the extent of Account's integration with LocalStack.
1615

17-
{{< callout >}}
18-
LocalStack's Account provider is mock-only and does not support any real AWS account.
16+
:::note
17+
LocalStack's Account provider is mock-only and does not support connecting to any real AWS account.
1918
The Account APIs are only intended to demonstrate how you can use and mock the AWS Account APIs in your local environment.
2019
It's important to note that LocalStack doesn't offer a programmatic interface to manage your AWS or your LocalStack account.
21-
{{< /callout >}}
20+
:::
2221

2322
## Getting started
2423

@@ -32,8 +31,8 @@ We will demonstrate how to put contact information, fetch account details, and a
3231
You can use the [`PutContactInformation`](https://docs.aws.amazon.com/accounts/latest/reference/API_PutContactInformation.html) API to add or update the contact information for your AWS account.
3332
Run the following command to add contact information to your account:
3433

35-
{{< command >}}
36-
$ awslocal account put-contact-information \
34+
```bash
35+
awslocal account put-contact-information \
3736
--contact-information '{
3837
"FullName": "Jane Doe",
3938
"PhoneNumber": "+XXXXXXXXX",
@@ -43,16 +42,16 @@ $ awslocal account put-contact-information \
4342
"CountryCode": "US",
4443
"StateOrRegion": "WA"
4544
}'
46-
{{< /command >}}
45+
```
4746

4847
### Fetch account details
4948

5049
You can use the [`GetContactInformation`](https://docs.aws.amazon.com/accounts/latest/reference/API_GetContactInformation.html) API to retrieve the contact information for your AWS account.
5150
Run the following command to fetch the contact information for your account:
5251

53-
{{< command >}}
54-
$ awslocal account get-contact-information
55-
{{< /command >}}
52+
```bash
53+
awslocal account get-contact-information
54+
```
5655

5756
The command will return the contact information for your account:
5857

@@ -75,22 +74,21 @@ The command will return the contact information for your account:
7574
You can attach an alternate contact using [`PutAlternateContact`](https://docs.aws.amazon.com/accounts/latest/reference/API_PutAlternateContact.html) API.
7675
Run the following command to attach an alternate contact to your account:
7776

78-
{{< command >}}
79-
$ awslocal account put-alternate-contact \
77+
```bash
78+
awslocal account put-alternate-contact \
8079
--alternate-contact-type "BILLING" \
8180
--email-address "[email protected]" \
8281
--name "Bill Ing" \
8382
--phone-number "+1 555-555-5555" \
8483
--title "Billing"
85-
{{< /command >}}
84+
```
8685

8786
## Resource Browser
8887

8988
The LocalStack Web Application provides a Resource Browser for managing contact information & alternate accounts for the Account service.
9089
You can access the Resource Browser by opening the LocalStack Web Application in your browser, navigating to the Resources section, and then clicking on **Account** under the **Management & Governance** section.
9190

92-
<img src="account-resource-browser.png" alt="Account Resource Browser" title="Account Resource Browser" width="900" />
93-
<br><br>
91+
![Account Resource Browser](/images/aws/account-resource-browser.png)
9492

9593
The Resource Browser allows you to perform the following actions:
9694

src/content/docs/aws/services/acm.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: "Certificate Manager (ACM)"
3-
linkTitle: "Certificate Manager (ACM)"
43
description: Get started with AWS Certificate Manager (ACM) on LocalStack
54
tags: ["Free"]
65
---
@@ -14,7 +13,7 @@ ACM supports securing multiple domain names and subdomains and can create wildca
1413
You can also use ACM to import certificates from third-party certificate authorities or to generate private certificates for internal use.
1514

1615
LocalStack allows you to use the ACM APIs to create, list, and delete certificates.
17-
The supported APIs are available on our [API coverage page]({{< ref "coverage_acm" >}}), which provides information on the extent of ACM's integration with LocalStack.
16+
The supported APIs are available on our [API coverage page](), which provides information on the extent of ACM's integration with LocalStack.
1817

1918
## Getting started
2019

@@ -26,13 +25,13 @@ Start your LocalStack container using your preferred method, then use the [Reque
2625
Specify the domain name you want to request the certificate for, and any additional options you need.
2726
Here's an example command:
2827

29-
{{< command >}}
30-
$ awslocal acm request-certificate \
28+
```bash
29+
awslocal acm request-certificate \
3130
--domain-name www.example.com \
3231
--validation-method DNS \
3332
--idempotency-token 1234 \
3433
--options CertificateTransparencyLoggingPreference=DISABLED
35-
{{< /command >}}
34+
```
3635

3736
This command will return the Amazon Resource Name (ARN) of the new certificate, which you can use in other ACM commands.
3837

@@ -48,36 +47,35 @@ Use the [`ListCertificates` API](https://docs.aws.amazon.com/acm/latest/APIRefer
4847
This command returns a list of the ARNs of all the certificates that have been requested or imported into ACM.
4948
Here's an example command:
5049

51-
{{< command >}}
52-
$ awslocal acm list-certificates --max-items 10
53-
{{< /command >}}
50+
```bash
51+
awslocal acm list-certificates --max-items 10
52+
```
5453

5554
### Describe the certificate
5655

5756
Use the [`DescribeCertificate` API](https://docs.aws.amazon.com/acm/latest/APIReference/API_DescribeCertificate.html) to view the details of a specific certificate.
5857
Provide the ARN of the certificate you want to view, and this command will return information about the certificate's status, domain name, and other attributes.
5958
Here's an example command:
6059

61-
{{< command >}}
62-
$ awslocal acm describe-certificate --certificate-arn arn:aws:acm:<region>:account:certificate/<certificate_ID>
63-
{{< /command >}}
60+
```bash
61+
awslocal acm describe-certificate --certificate-arn arn:aws:acm:<region>:account:certificate/<certificate_ID>
62+
```
6463

6564
### Delete the certificate
6665

6766
Finally you can use the [`DeleteCertificate` API](https://docs.aws.amazon.com/acm/latest/APIReference/API_DeleteCertificate.html) to delete a certificate from ACM, by passing the ARN of the certificate you want to delete.
6867
Here's an example command:
6968

70-
{{< command >}}
71-
$ awslocal acm delete-certificate --certificate-arn arn:aws:acm:<region>:account:certificate/<certificate_ID>
72-
{{< /command >}}
69+
```bash
70+
awslocal acm delete-certificate --certificate-arn arn:aws:acm:<region>:account:certificate/<certificate_ID>
71+
```
7372

7473
## Resource Browser
7574

7675
The LocalStack Web Application provides a Resource Browser for managing ACM Certificates.
7776
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 **Certificate Manager** under the **Security Identity Compliance** section.
7877

79-
<img src="acm-resource-browser.png" alt="ACM Resource Browser" title="ACM Resource Browser" width="900" />
80-
<br><br>
78+
![ACM Resource Browser](/images/aws/acm-resource-browser.png)
8179

8280
The Resource Browser allows you to perform the following actions:
8381

src/content/docs/aws/services/amplify.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: "Amplify"
3-
linkTitle: "Amplify"
43
description: Get started with Amplify on LocalStack
54
tags: ["Ultimate"]
65
persistence: supported
@@ -12,12 +11,12 @@ Amplify is a JavaScript-based development framework with libraries, UI component
1211
With Amplify, developers can build and host static websites, single-page applications, and full-stack serverless web applications using an abstraction layer over popular AWS services like DynamoDB, Cognito, AppSync, Lambda, S3, and more.
1312

1413
LocalStack allows you to use the Amplify APIs to build and test their Amplify applications locally.
15-
The supported APIs are available on our [API coverage page]({{< ref "coverage_amplify" >}}), which provides information on the extent of Amplify's integration with LocalStack.
14+
The supported APIs are available on our [API coverage page](), which provides information on the extent of Amplify's integration with LocalStack.
1615

17-
{{< callout "note" >}}
16+
:::note
1817
The `amplifylocal` CLI and the Amplify JS library have been deprecated and are no longer supported.
1918
We recommend using the Amplify CLI with the Amplify LocalStack Plugin instead.
20-
{{< /callout >}}
19+
:::
2120

2221
## Amplify LocalStack Plugin
2322

@@ -28,10 +27,10 @@ It achieves this by redirecting any requests to AWS to a LocalStack container ru
2827

2928
To install the Amplify LocalStack Plugin, install the [amplify-localstack](https://www.npmjs.com/package/amplify-localstack) package from the npm registry and add the plugin to your Amplify setup:
3029

31-
{{< command >}}
32-
$ npm install -g amplify-localstack
33-
$ amplify plugin add amplify-localstack
34-
{{< /command >}}
30+
```bash
31+
npm install -g amplify-localstack
32+
amplify plugin add amplify-localstack
33+
```
3534

3635
### Configuration
3736

@@ -53,19 +52,18 @@ The console will prompt you to select whether to deploy to LocalStack or AWS.
5352
You can also add the parameter `--use-localstack true` to your commands to avoid being prompted and automatically use LocalStack.
5453
Here is an example:
5554

56-
{{< command >}}
57-
$ amplify init --use-localstack true
58-
$ amplify add api
59-
$ amplify push --use-localstack true
60-
{{< /command >}}
55+
```bash
56+
amplify init --use-localstack true
57+
amplify add api
58+
amplify push --use-localstack true
59+
```
6160

6261
## Resource Browser
6362

6463
The LocalStack Web Application provides a Resource Browser for managing Amplify applications.
6564
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 **Amplify** under the **Front-end Web & Mobile** section.
6665

67-
<img src="amplify-resource-browser.png" alt="Amplify Resource Browser" title="Amplify Resource Browser" width="900" />
68-
<br><br>
66+
![Amplify Resource Browser](/images/aws/amplify-resource-browser.png)
6967

7068
The Resource Browser allows you to perform the following actions:
7169

0 commit comments

Comments
 (0)