Skip to content

Commit d19be99

Browse files
quetzalliwritesquetzalliwrites
committed
first round of services files to add
1 parent 64b5492 commit d19be99

21 files changed

+4325
-0
lines changed

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

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
title: Account Management
3+
description: Get started with AWS Account Management on LocalStack
4+
---
5+
6+
## Introduction
7+
8+
The Account service provides APIs to manage your AWS account.
9+
You can use the Account APIs to retrieve information about your account, manage your contact information and alternate contacts.
10+
Additionally, you can use the Account APIs to enable or disable a region for your account, and delete alternate contacts in your account.
11+
12+
LocalStack supports Account via the Pro offering, allowing you to use the Account API to retrieve information about your account.
13+
The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_account/), which provides information on the extent of Account's integration with LocalStack.
14+
15+
{{< callout >}}
16+
LocalStack's Account provider is mock-only and does not support any real AWS account.
17+
The Account APIs are only intended to demonstrate how you can use and mock the AWS Account APIs in your local environment.
18+
It's important to note that LocalStack doesn't offer a programmatic interface to manage your AWS or your LocalStack account.
19+
{{< /callout >}}
20+
21+
## Getting started
22+
23+
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.
24+
25+
Start your LocalStack container using your preferred method.
26+
We will demonstrate how to put contact information, fetch account details, and attach an alternate contact to your account.
27+
28+
### Put contact information
29+
30+
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.
31+
Run the following command to add contact information to your account:
32+
33+
{{< command >}}
34+
$ awslocal account put-contact-information \
35+
--contact-information '{
36+
"FullName": "Jane Doe",
37+
"PhoneNumber": "+XXXXXXXXX",
38+
"AddressLine1": "XXXX Main St",
39+
"City": "XXXX",
40+
"PostalCode": "XXXXX",
41+
"CountryCode": "US",
42+
"StateOrRegion": "WA"
43+
}'
44+
{{< /command >}}
45+
46+
### Fetch account details
47+
48+
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.
49+
Run the following command to fetch the contact information for your account:
50+
51+
{{< command >}}
52+
$ awslocal account get-contact-information
53+
{{< /command >}}
54+
55+
The command will return the contact information for your account:
56+
57+
```json
58+
{
59+
"ContactInformation": {
60+
"AddressLine1": "XXXX Main St",
61+
"City": "XXXX",
62+
"CountryCode": "US",
63+
"FullName": "Jane Doe",
64+
"PhoneNumber": "+XXXXXXXXX",
65+
"PostalCode": "XXXXX",
66+
"StateOrRegion": "WA"
67+
}
68+
}
69+
```
70+
71+
### Attach alternate contact
72+
73+
You can attach an alternate contact using [`PutAlternateContact`](https://docs.aws.amazon.com/accounts/latest/reference/API_PutAlternateContact.html) API.
74+
Run the following command to attach an alternate contact to your account:
75+
76+
{{< command >}}
77+
$ awslocal account put-alternate-contact \
78+
--alternate-contact-type "BILLING" \
79+
--email-address "[email protected]" \
80+
--name "Bill Ing" \
81+
--phone-number "+1 555-555-5555" \
82+
--title "Billing"
83+
{{< /command >}}
84+
85+
## Resource Browser
86+
87+
The LocalStack Web Application provides a Resource Browser for managing contact information & alternate accounts for the Account service.
88+
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.
89+
90+
<img src="account-resource-browser.png" alt="Account Resource Browser" title="Account Resource Browser" width="900" />
91+
<br><br>
92+
93+
The Resource Browser allows you to perform the following actions:
94+
95+
* **Create Contact Information**: Add the contact information for your mocked AWS account by clicking on the **Create** button in the contact information section.
96+
* **Create Alternate Contact**: Add an alternate contact for your mocked AWS account by clicking on the **Create** button in the alternate contacts section.
97+
* **View Contact Information**: View the contact information for your mocked AWS account by clicking on the contact information.
98+
* **Update Contact Information**: Update the contact information for your mocked AWS account by clicking on the contact information.
99+
* **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: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
---
2+
title: Certificate Manager (ACM)
3+
description: Get started with AWS Certificate Manager (ACM) on LocalStack
4+
---
5+
6+
## Introduction
7+
8+
[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.
9+
You can use ACM to provision and deploy public or private certificates trusted by browsers and other clients.
10+
11+
ACM supports securing multiple domain names and subdomains and can create wildcard SSL certificates to protect an entire domain and its subdomains.
12+
You can also use ACM to import certificates from third-party certificate authorities or to generate private certificates for internal use.
13+
14+
LocalStack allows you to use the ACM APIs to create, list, and delete certificates.
15+
The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_acm/), which provides information on the extent of ACM's integration with LocalStack.
16+
17+
## Getting started
18+
19+
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.
20+
21+
### Request a public certificate
22+
23+
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.
24+
Specify the domain name you want to request the certificate for, and any additional options you need.
25+
Here's an example command:
26+
27+
{{< command >}}
28+
$ awslocal acm request-certificate \
29+
--domain-name www.example.com \
30+
--validation-method DNS \
31+
--idempotency-token 1234 \
32+
--options CertificateTransparencyLoggingPreference=DISABLED
33+
{{< /command >}}
34+
35+
This command will return the Amazon Resource Name (ARN) of the new certificate, which you can use in other ACM commands.
36+
37+
```json
38+
{
39+
"CertificateArn": "arn:aws:acm:<region>:000000000000:certificate/<certificate_ID>"
40+
}
41+
```
42+
43+
### List the certificates
44+
45+
Use the [`ListCertificates` API](https://docs.aws.amazon.com/acm/latest/APIReference/API_ListCertificates.html) to list all the certificates.
46+
This command returns a list of the ARNs of all the certificates that have been requested or imported into ACM.
47+
Here's an example command:
48+
49+
{{< command >}}
50+
$ awslocal acm list-certificates --max-items 10
51+
{{< /command >}}
52+
53+
### Describe the certificate
54+
55+
Use the [`DescribeCertificate` API](https://docs.aws.amazon.com/acm/latest/APIReference/API_DescribeCertificate.html) to view the details of a specific certificate.
56+
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.
57+
Here's an example command:
58+
59+
{{< command >}}
60+
$ awslocal acm describe-certificate --certificate-arn arn:aws:acm:<region>:account:certificate/<certificate_ID>
61+
{{< /command >}}
62+
63+
### Delete the certificate
64+
65+
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.
66+
Here's an example command:
67+
68+
{{< command >}}
69+
$ awslocal acm delete-certificate --certificate-arn arn:aws:acm:<region>:account:certificate/<certificate_ID>
70+
{{< /command >}}
71+
72+
## Resource Browser
73+
74+
The LocalStack Web Application provides a Resource Browser for managing ACM Certificates.
75+
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.
76+
77+
<img src="acm-resource-browser.png" alt="ACM Resource Browser" title="ACM Resource Browser" width="900" />
78+
<br><br>
79+
80+
The Resource Browser allows you to perform the following actions:
81+
82+
- **Create Certificate**: Create a new ACM certificate by clicking **Create Certificate** and providing the required information.
83+
- **View Certificate**: View the details of a specific certificate by clicking on the domain name.
84+
- **Delete Certificate**: Delete a certificate by selecting the certificate, followed by clicking **Actions** and then **Remove Selected**.
85+
86+
## Examples
87+
88+
The following code snippets and sample applications provide practical examples of how to use ACM in LocalStack for various use cases:
89+
90+
- [API Gateway with Custom Domains](https://github.com/localstack/localstack-pro-samples/tree/master/apigw-custom-domain)
91+
- [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: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
title: Amplify
3+
description: Get started with Amplify on LocalStack
4+
---
5+
6+
## Introduction
7+
8+
Amplify is a JavaScript-based development framework with libraries, UI components, and a standard CLI interface for building and deploying web and mobile applications.
9+
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.
10+
11+
LocalStack allows you to use the Amplify APIs to build and test their Amplify applications locally.
12+
The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_amplify/), which provides information on the extent of Amplify's integration with LocalStack.
13+
14+
{{< callout "note" >}}
15+
The `amplifylocal` CLI and the Amplify JS library have been deprecated and are no longer supported.
16+
We recommend using the Amplify CLI with the Amplify LocalStack Plugin instead.
17+
{{< /callout >}}
18+
19+
## Amplify LocalStack Plugin
20+
21+
[Amplify LocalStack Plugin](https://github.com/localstack/amplify-localstack) allows the `amplify` CLI tool to create resources on your local machine instead of AWS.
22+
It achieves this by redirecting any requests to AWS to a LocalStack container running locally on your machine.
23+
24+
### Installation
25+
26+
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:
27+
28+
{{< command >}}
29+
$ npm install -g amplify-localstack
30+
$ amplify plugin add amplify-localstack
31+
{{< /command >}}
32+
33+
### Configuration
34+
35+
You can configure the following environment variables to customize LocalStack's behaviour:
36+
37+
- `EDGE_PORT`: The port number under which the LocalStack edge service is accessible.
38+
The default value is `4566`.
39+
- `LOCALSTACK_HOSTNAME`: It specifies the target host under which the LocalStack edge service is accessible.
40+
The default value is `localhost.localstack.cloud`.
41+
- `LOCALSTACK_ENDPOINT`: It allows you to set a custom endpoint directly.
42+
If set, it overrides the values set for `EDGE_PORT` and `LOCALSTACK_HOSTNAME`.
43+
The default value is `https://localhost.localstack.cloud:4566`.
44+
45+
### Usage
46+
47+
After installing the plugin, you can deploy your resources to LocalStack using the `amplify init` or `amplify push` commands.
48+
The console will prompt you to select whether to deploy to LocalStack or AWS.
49+
50+
You can also add the parameter `--use-localstack true` to your commands to avoid being prompted and automatically use LocalStack.
51+
Here is an example:
52+
53+
{{< command >}}
54+
$ amplify init --use-localstack true
55+
$ amplify add api
56+
$ amplify push --use-localstack true
57+
{{< /command >}}
58+
59+
## Resource Browser
60+
61+
The LocalStack Web Application provides a Resource Browser for managing Amplify applications.
62+
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.
63+
64+
<img src="amplify-resource-browser.png" alt="Amplify Resource Browser" title="Amplify Resource Browser" width="900" />
65+
<br><br>
66+
67+
The Resource Browser allows you to perform the following actions:
68+
69+
- **Create new Amplify applications**: Create new Amplify applications by clicking **Create App** and filling in the required details.
70+
- **View Amplify applications**: View the list of Amplify applications created in LocalStack by clicking on the application ID.
71+
- **Edit Amplify applications**: Edit the configuration of an existing Amplify application by clicking on the application ID and then clicking **Edit App**.
72+
- **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)