Skip to content

Commit 13f5fbd

Browse files
quetzalliwritesquetzalliwrites
authored
Merge pull request #4 from localstack/docs-move-aws-services-pages-over
docs: move aws services pages over and update them with latest in main
2 parents d8e8684 + 2aa9d63 commit 13f5fbd

Some content is hidden

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

98 files changed

+21149
-0
lines changed

‎src/content/docs/aws/services/account-management.md‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
---
2+
title: "Account Management"
3+
linkTitle: "Account Management"
4+
description: Get started with AWS Account Management on LocalStack
5+
tags: ["Ultimate"]
6+
---
7+
8+
## Introduction
9+
10+
The Account service provides APIs to manage your AWS account.
11+
You can use the Account APIs to retrieve information about your account, manage your contact information and alternate contacts.
12+
Additionally, you can use the Account APIs to enable or disable a region for your account, and delete alternate contacts in your account.
13+
14+
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.
16+
17+
{{< callout >}}
18+
LocalStack's Account provider is mock-only and does not support any real AWS account.
19+
The Account APIs are only intended to demonstrate how you can use and mock the AWS Account APIs in your local environment.
20+
It's important to note that LocalStack doesn't offer a programmatic interface to manage your AWS or your LocalStack account.
21+
{{< /callout >}}
22+
23+
## Getting started
24+
25+
This guide is designed for users who are new to Account and assumes basic knowledge of the AWS CLI and our [`awslocal`](https://github.com/localstack/awscli-local) wrapper script.
26+
27+
Start your LocalStack container using your preferred method.
28+
We will demonstrate how to put contact information, fetch account details, and attach an alternate contact to your account.
29+
30+
### Put contact information
31+
32+
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.
33+
Run the following command to add contact information to your account:
34+
35+
{{< command >}}
36+
$ awslocal account put-contact-information \
37+
--contact-information '{
38+
"FullName": "Jane Doe",
39+
"PhoneNumber": "+XXXXXXXXX",
40+
"AddressLine1": "XXXX Main St",
41+
"City": "XXXX",
42+
"PostalCode": "XXXXX",
43+
"CountryCode": "US",
44+
"StateOrRegion": "WA"
45+
}'
46+
{{< /command >}}
47+
48+
### Fetch account details
49+
50+
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.
51+
Run the following command to fetch the contact information for your account:
52+
53+
{{< command >}}
54+
$ awslocal account get-contact-information
55+
{{< /command >}}
56+
57+
The command will return the contact information for your account:
58+
59+
```json
60+
{
61+
"ContactInformation": {
62+
"AddressLine1": "XXXX Main St",
63+
"City": "XXXX",
64+
"CountryCode": "US",
65+
"FullName": "Jane Doe",
66+
"PhoneNumber": "+XXXXXXXXX",
67+
"PostalCode": "XXXXX",
68+
"StateOrRegion": "WA"
69+
}
70+
}
71+
```
72+
73+
### Attach alternate contact
74+
75+
You can attach an alternate contact using [`PutAlternateContact`](https://docs.aws.amazon.com/accounts/latest/reference/API_PutAlternateContact.html) API.
76+
Run the following command to attach an alternate contact to your account:
77+
78+
{{< command >}}
79+
$ awslocal account put-alternate-contact \
80+
--alternate-contact-type "BILLING" \
81+
--email-address "[email protected]" \
82+
--name "Bill Ing" \
83+
--phone-number "+1 555-555-5555" \
84+
--title "Billing"
85+
{{< /command >}}
86+
87+
## Resource Browser
88+
89+
The LocalStack Web Application provides a Resource Browser for managing contact information & alternate accounts for the Account service.
90+
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.
91+
92+
<img src="account-resource-browser.png" alt="Account Resource Browser" title="Account Resource Browser" width="900" />
93+
<br><br>
94+
95+
The Resource Browser allows you to perform the following actions:
96+
97+
* **Create Contact Information**: Add the contact information for your mocked AWS account by clicking on the **Create** button in the contact information section.
98+
* **Create Alternate Contact**: Add an alternate contact for your mocked AWS account by clicking on the **Create** button in the alternate contacts section.
99+
* **View Contact Information**: View the contact information for your mocked AWS account by clicking on the contact information.
100+
* **Update Contact Information**: Update the contact information for your mocked AWS account by clicking on the contact information.
101+
* **Filter**: Filter the contact information and alternate contacts by types, such as `BILLING`, `OPERATIONS`, and `SECURITY`.

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

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
---
2+
title: "Certificate Manager (ACM)"
3+
linkTitle: "Certificate Manager (ACM)"
4+
description: Get started with AWS Certificate Manager (ACM) on LocalStack
5+
tags: ["Free"]
6+
---
7+
8+
## Introduction
9+
10+
[AWS Certificate Manager (ACM)](https://aws.amazon.com/certificate-manager/) is a service that enables you to create and manage SSL/TLS certificates that can be used to secure your applications and resources in AWS.
11+
You can use ACM to provision and deploy public or private certificates trusted by browsers and other clients.
12+
13+
ACM supports securing multiple domain names and subdomains and can create wildcard SSL certificates to protect an entire domain and its subdomains.
14+
You can also use ACM to import certificates from third-party certificate authorities or to generate private certificates for internal use.
15+
16+
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.
18+
19+
## Getting started
20+
21+
This guide is designed for users who are new to ACM and assumes basic knowledge of the AWS CLI and our [`awslocal`](https://github.com/localstack/awscli-local) wrapper script.
22+
23+
### Request a public certificate
24+
25+
Start your LocalStack container using your preferred method, then use the [RequestCertificate API](https://docs.aws.amazon.com/acm/latest/APIReference/API_RequestCertificate.html) to request a new public ACM certificate.
26+
Specify the domain name you want to request the certificate for, and any additional options you need.
27+
Here's an example command:
28+
29+
{{< command >}}
30+
$ awslocal acm request-certificate \
31+
--domain-name www.example.com \
32+
--validation-method DNS \
33+
--idempotency-token 1234 \
34+
--options CertificateTransparencyLoggingPreference=DISABLED
35+
{{< /command >}}
36+
37+
This command will return the Amazon Resource Name (ARN) of the new certificate, which you can use in other ACM commands.
38+
39+
```json
40+
{
41+
"CertificateArn": "arn:aws:acm:<region>:000000000000:certificate/<certificate_ID>"
42+
}
43+
```
44+
45+
### List the certificates
46+
47+
Use the [`ListCertificates` API](https://docs.aws.amazon.com/acm/latest/APIReference/API_ListCertificates.html) to list all the certificates.
48+
This command returns a list of the ARNs of all the certificates that have been requested or imported into ACM.
49+
Here's an example command:
50+
51+
{{< command >}}
52+
$ awslocal acm list-certificates --max-items 10
53+
{{< /command >}}
54+
55+
### Describe the certificate
56+
57+
Use the [`DescribeCertificate` API](https://docs.aws.amazon.com/acm/latest/APIReference/API_DescribeCertificate.html) to view the details of a specific certificate.
58+
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.
59+
Here's an example command:
60+
61+
{{< command >}}
62+
$ awslocal acm describe-certificate --certificate-arn arn:aws:acm:<region>:account:certificate/<certificate_ID>
63+
{{< /command >}}
64+
65+
### Delete the certificate
66+
67+
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.
68+
Here's an example command:
69+
70+
{{< command >}}
71+
$ awslocal acm delete-certificate --certificate-arn arn:aws:acm:<region>:account:certificate/<certificate_ID>
72+
{{< /command >}}
73+
74+
## Resource Browser
75+
76+
The LocalStack Web Application provides a Resource Browser for managing ACM Certificates.
77+
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.
78+
79+
<img src="acm-resource-browser.png" alt="ACM Resource Browser" title="ACM Resource Browser" width="900" />
80+
<br><br>
81+
82+
The Resource Browser allows you to perform the following actions:
83+
84+
- **Create Certificate**: Create a new ACM certificate by clicking **Create Certificate** and providing the required information.
85+
- **View Certificate**: View the details of a specific certificate by clicking on the domain name.
86+
- **Delete Certificate**: Delete a certificate by selecting the certificate, followed by clicking **Actions** and then **Remove Selected**.
87+
88+
## Examples
89+
90+
The following code snippets and sample applications provide practical examples of how to use ACM in LocalStack for various use cases:
91+
92+
- [API Gateway with Custom Domains](https://github.com/localstack/localstack-pro-samples/tree/master/apigw-custom-domain)
93+
- [Generating an ACM certificate via Terraform](https://github.com/localstack/localstack-terraform-samples/tree/master/acm-route53)

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

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
title: "Amplify"
3+
linkTitle: "Amplify"
4+
description: Get started with Amplify on LocalStack
5+
tags: ["Ultimate"]
6+
persistence: supported
7+
---
8+
9+
## Introduction
10+
11+
Amplify is a JavaScript-based development framework with libraries, UI components, and a standard CLI interface for building and deploying web and mobile applications.
12+
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.
13+
14+
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.
16+
17+
{{< callout "note" >}}
18+
The `amplifylocal` CLI and the Amplify JS library have been deprecated and are no longer supported.
19+
We recommend using the Amplify CLI with the Amplify LocalStack Plugin instead.
20+
{{< /callout >}}
21+
22+
## Amplify LocalStack Plugin
23+
24+
[Amplify LocalStack Plugin](https://github.com/localstack/amplify-localstack) allows the `amplify` CLI tool to create resources on your local machine instead of AWS.
25+
It achieves this by redirecting any requests to AWS to a LocalStack container running locally on your machine.
26+
27+
### Installation
28+
29+
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:
30+
31+
{{< command >}}
32+
$ npm install -g amplify-localstack
33+
$ amplify plugin add amplify-localstack
34+
{{< /command >}}
35+
36+
### Configuration
37+
38+
You can configure the following environment variables to customize LocalStack's behaviour:
39+
40+
- `EDGE_PORT`: The port number under which the LocalStack edge service is accessible.
41+
The default value is `4566`.
42+
- `LOCALSTACK_HOSTNAME`: It specifies the target host under which the LocalStack edge service is accessible.
43+
The default value is `localhost.localstack.cloud`.
44+
- `LOCALSTACK_ENDPOINT`: It allows you to set a custom endpoint directly.
45+
If set, it overrides the values set for `EDGE_PORT` and `LOCALSTACK_HOSTNAME`.
46+
The default value is `https://localhost.localstack.cloud:4566`.
47+
48+
### Usage
49+
50+
After installing the plugin, you can deploy your resources to LocalStack using the `amplify init` or `amplify push` commands.
51+
The console will prompt you to select whether to deploy to LocalStack or AWS.
52+
53+
You can also add the parameter `--use-localstack true` to your commands to avoid being prompted and automatically use LocalStack.
54+
Here is an example:
55+
56+
{{< command >}}
57+
$ amplify init --use-localstack true
58+
$ amplify add api
59+
$ amplify push --use-localstack true
60+
{{< /command >}}
61+
62+
## Resource Browser
63+
64+
The LocalStack Web Application provides a Resource Browser for managing Amplify applications.
65+
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.
66+
67+
<img src="amplify-resource-browser.png" alt="Amplify Resource Browser" title="Amplify Resource Browser" width="900" />
68+
<br><br>
69+
70+
The Resource Browser allows you to perform the following actions:
71+
72+
- **Create new Amplify applications**: Create new Amplify applications by clicking **Create App** and filling in the required details.
73+
- **View Amplify applications**: View the list of Amplify applications created in LocalStack by clicking on the application ID.
74+
- **Edit Amplify applications**: Edit the configuration of an existing Amplify application by clicking on the application ID and then clicking **Edit App**.
75+
- **Delete Amplify applications**: Delete an existing Amplify application by selecting the application, followed by clicking **Actions** and then **Remove Selected**.

0 commit comments

Comments
 (0)