Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/content/docs/aws/services/account.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ It's important to note that LocalStack doesn't offer a programmatic interface to

## Getting started

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.
This guide is designed for users who are new to Account and assumes basic knowledge of the AWS CLI and our [`lstk aws`](/aws/developer-tools/running-localstack/lstk/#aws) command.

Start your LocalStack container using your preferred method.
We will demonstrate how to put contact information, fetch account details, and attach an alternate contact to your account.
Expand All @@ -34,7 +34,7 @@ You can use the [`PutContactInformation`](https://docs.aws.amazon.com/accounts/l
Run the following command to add contact information to your account:

```bash showshowLineNumbers
awslocal account put-contact-information \
lstk aws account put-contact-information \
--contact-information '{
"FullName": "Jane Doe",
"PhoneNumber": "+XXXXXXXXX",
Expand All @@ -52,7 +52,7 @@ You can use the [`GetContactInformation`](https://docs.aws.amazon.com/accounts/l
Run the following command to fetch the contact information for your account:

```bash
awslocal account get-contact-information
lstk aws account get-contact-information
```

```bash title="Output" showshowLineNumbers
Expand All @@ -75,7 +75,7 @@ You can attach an alternate contact using [`PutAlternateContact`](https://docs.a
Run the following command to attach an alternate contact to your account:

```bash showshowLineNumbers
awslocal account put-alternate-contact \
lstk aws account put-alternate-contact \
--alternate-contact-type "BILLING" \
--email-address "bill@ing.com" \
--name "Bill Ing" \
Expand Down
22 changes: 11 additions & 11 deletions src/content/docs/aws/services/acm-pca.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The supported APIs are available on our [API Coverage section](#api-coverage), w

## Getting started

This guide is designed for users who are new to ACM PCA and assumes basic knowledge of the AWS CLI and our [`awslocal`](https://github.com/localstack/awscli-local) wrapper script.
This guide is designed for users who are new to ACM PCA and assumes basic knowledge of the AWS CLI and our [`lstk aws`](/aws/developer-tools/running-localstack/lstk/#aws) command.
We will follow the procedure to create and install a certificate for a single-level hierarchy CA hosted by ACM PCA.

### Create a CA
Expand All @@ -27,7 +27,7 @@ Start by creating a new Certificate Authority with ACM PCA using the [`CreateCer
This command sets up a new CA with specified configurations for key algorithm, signing algorithm, and subject information.

```bash
awslocal acm-pca create-certificate-authority \
lstk aws acm-pca create-certificate-authority \
--certificate-authority-configuration '{
"KeyAlgorithm":"RSA_2048",
"SigningAlgorithm":"SHA256WITHRSA",
Expand All @@ -53,7 +53,7 @@ To retrieve the detailed information about the created Certificate Authority, us
This command returns the detailed information about the CA, including the CA's ARN, status, and configuration.

```bash
awslocal acm-pca describe-certificate-authority \
lstk aws acm-pca describe-certificate-authority \
--certificate-authority-arn arn:aws:acm-pca:eu-central-1:000000000000:certificate-authority/0b20353f-ce7a-4de4-9b82-e06903a893ff
```

Expand Down Expand Up @@ -94,15 +94,15 @@ In the following steps, we will create and attach a certificate for this CA.
Use the [`GetCertificateAuthorityCsr`](https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificateAuthorityCsr.html) operation to obtain the Certificate Signing Request (CSR) for the CA.

```bash
awslocal acm-pca get-certificate-authority-csr \
lstk aws acm-pca get-certificate-authority-csr \
--certificate-authority-arn arn:aws:acm-pca:eu-central-1:000000000000:certificate-authority/0b20353f-ce7a-4de4-9b82-e06903a893ff \
--output text | tee ca.csr
```

Next, issue the certificate for the CA using this CSR.

```bash
awslocal acm-pca issue-certificate \
lstk aws acm-pca issue-certificate \
--csr fileb://ca.csr \
--signing-algorithm SHA256WITHRSA \
--template-arn arn:aws:acm-pca:::template/RootCACertificate/V1 \
Expand All @@ -123,14 +123,14 @@ The CA certificate is now created and its ARN is indicated by the `CertificateAr
Finally, we retrieve the signed certificate with [`GetCertificate`](https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificate.html) and import it using [`ImportCertificateAuthorityCertificate`](https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html).

```bash
awslocal acm-pca get-certificate \
lstk aws acm-pca get-certificate \
--certificate-authority-arn arn:aws:acm-pca:eu-central-1:000000000000:certificate-authority/0b20353f-ce7a-4de4-9b82-e06903a893ff \
--certificate-arn arn:aws:acm-pca:eu-central-1:000000000000:certificate-authority/0b20353f-ce7a-4de4-9b82-e06903a893ff/certificate/17ef7bbf3cc6471ba3ef0707119b8392 \
--output text | tee cert.pem
```

```bash
awslocal acm-pca import-certificate-authority-certificate \
lstk aws acm-pca import-certificate-authority-certificate \
--certificate-authority-arn arn:aws:acm-pca:eu-central-1:000000000000:certificate-authority/0b20353f-ce7a-4de4-9b82-e06903a893ff \
--certificate fileb://cert.pem
```
Expand All @@ -139,7 +139,7 @@ The CA is now ready for use.
You can verify this by checking its status:

```bash
awslocal acm-pca describe-certificate-authority \
lstk aws acm-pca describe-certificate-authority \
--certificate-authority-arn arn:aws:acm-pca:eu-central-1:000000000000:certificate-authority/0b20353f-ce7a-4de4-9b82-e06903a893ff \
--query CertificateAuthority.Status \
--output text
Expand Down Expand Up @@ -196,7 +196,7 @@ Next, using [`IssueCertificate`](https://docs.aws.amazon.com/privateca/latest/AP
Note that there is no [certificate template](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html) specified which causes the end-entity certificate to be issued by default.

```bash
awslocal acm-pca issue-certificate \
lstk aws acm-pca issue-certificate \
--certificate-authority-arn arn:aws:acm-pca:eu-central-1:000000000000:certificate-authority/0b20353f-ce7a-4de4-9b82-e06903a893ff \
--csr fileb://local-csr.pem \
--signing-algorithm "SHA256WITHRSA" \
Expand Down Expand Up @@ -231,7 +231,7 @@ Use the [`TagCertificateAuthority`](https://docs.aws.amazon.com/privateca/latest
This command adds the specified tags to the specified CA.

```bash
awslocal acm-pca tag-certificate-authority \
lstk aws acm-pca tag-certificate-authority \
--certificate-authority-arn arn:aws:acm-pca:us-east-1:000000000000:certificate-authority/f38ee966-bc23-40f8-8143-e981aee73600 \
--tags Key=Admin,Value=Alice
```
Expand All @@ -240,7 +240,7 @@ After tagging your Certificate Authority, you may want to view these tags.
You can use the [`ListTags`](https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html) API to list all the tags associated with the specified CA.

```bash
awslocal acm-pca list-tags \
lstk aws acm-pca list-tags \
--certificate-authority-arn arn:aws:acm-pca:us-east-1:000000000000:certificate-authority/f38ee966-bc23-40f8-8143-e981aee73600 \
--max-results 10
```
Expand Down
10 changes: 5 additions & 5 deletions src/content/docs/aws/services/acm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The supported APIs are available on our [API Coverage section](#api-coverage), w

## Getting started

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.
This guide is designed for users who are new to ACM and assumes basic knowledge of the AWS CLI and our [`lstk aws`](/aws/developer-tools/running-localstack/lstk/#aws) command.

### Request a public certificate

Expand All @@ -29,7 +29,7 @@ Specify the domain name you want to request the certificate for, and any additio
Here's an example command:

```bash showshowLineNumbers
awslocal acm request-certificate \
lstk aws acm request-certificate \
--domain-name www.example.com \
--validation-method DNS \
--idempotency-token 1234 \
Expand All @@ -51,7 +51,7 @@ This command returns a list of the ARNs of all the certificates that have been r
Here's an example command:

```bash
awslocal acm list-certificates --max-items 10
lstk aws acm list-certificates --max-items 10
```

### Describe the certificate
Expand All @@ -61,7 +61,7 @@ Provide the ARN of the certificate you want to view, and this command will retur
Here's an example command:

```bash
awslocal acm describe-certificate --certificate-arn arn:aws:acm:<region>:account:certificate/<certificate_ID>
lstk aws acm describe-certificate --certificate-arn arn:aws:acm:<region>:account:certificate/<certificate_ID>
```

### Delete the certificate
Expand All @@ -70,7 +70,7 @@ Finally you can use the [`DeleteCertificate` API](https://docs.aws.amazon.com/ac
Here's an example command:

```bash
awslocal acm delete-certificate --certificate-arn arn:aws:acm:<region>:account:certificate/<certificate_ID>
lstk aws acm delete-certificate --certificate-arn arn:aws:acm:<region>:account:certificate/<certificate_ID>
```

## Resource Browser
Expand Down
28 changes: 14 additions & 14 deletions src/content/docs/aws/services/apigateway.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The supported APIs are available on the API coverage section for [API Gateway V1

## Getting started

This guide is designed for users new to API Gateway and assumes basic knowledge of the AWS CLI and our [`awslocal`](https://github.com/localstack/awscli-local) wrapper script.
This guide is designed for users new to API Gateway and assumes basic knowledge of the AWS CLI and our [`lstk aws`](/aws/developer-tools/running-localstack/lstk/#aws) command.

Start your LocalStack container using your preferred method.
We will use the Lambda proxy integration to integrate an API method with a Lambda function.
Expand Down Expand Up @@ -49,12 +49,12 @@ module.exports = {
```

The above code defines a function named `apiHandler` that returns a response with a status code of `200` and a body containing the string `Hello from Lambda`.
Zip the file and upload it to LocalStack using the `awslocal` CLI.
Zip the file and upload it to LocalStack using the `lstk aws` command.
Run the following command:

```bash showshowLineNumbers
zip function.zip lambda.js
awslocal lambda create-function \
lstk aws lambda create-function \
--function-name apigw-lambda \
--runtime nodejs16.x \
--handler lambda.apiHandler \
Expand All @@ -71,7 +71,7 @@ We will use the API Gateway's [`CreateRestApi`](https://docs.aws.amazon.com/apig
Here's an example command:

```bash
awslocal apigateway create-rest-api --name 'API Gateway Lambda integration'
lstk aws apigateway create-rest-api --name 'API Gateway Lambda integration'
```

This creates a new REST API named `API Gateway Lambda integration`.
Expand Down Expand Up @@ -99,7 +99,7 @@ You'll need this ID for the next step.
Use the REST API ID generated in the previous step to fetch the resources for the API, using the [`GetResources`](https://docs.aws.amazon.com/apigateway/latest/api/API_GetResources.html) API:

```bash
awslocal apigateway get-resources --rest-api-id <REST_API_ID>
lstk aws apigateway get-resources --rest-api-id <REST_API_ID>
```

```bash title="Output"
Expand All @@ -122,7 +122,7 @@ Create a new resource for the API using the [`CreateResource`](https://docs.aws.
Use the ID of the resource returned in the previous step as the parent ID:

```bash showshowLineNumbers
awslocal apigateway create-resource \
lstk aws apigateway create-resource \
--rest-api-id <REST_API_ID> \
--parent-id <PARENT_ID> \
--path-part "{somethingId}"
Expand All @@ -146,7 +146,7 @@ Add a `GET` method to the resource using the [`PutMethod`](https://docs.aws.amaz
Use the ID of the resource returned in the previous step as the Resource ID:

```bash showshowLineNumbers
awslocal apigateway put-method \
lstk aws apigateway put-method \
--rest-api-id <REST_API_ID> \
--resource-id <RESOURCE_ID> \
--http-method GET \
Expand All @@ -168,7 +168,7 @@ awslocal apigateway put-method \
Now, create a new integration for the method using the [`PutIntegration`](https://docs.aws.amazon.com/apigateway/latest/api/API_PutIntegration.html) API.

```bash showshowLineNumbers
awslocal apigateway put-integration \
lstk aws apigateway put-integration \
--rest-api-id <REST_API_ID> \
--resource-id <RESOURCE_ID> \
--http-method GET \
Expand All @@ -186,7 +186,7 @@ We can now proceed with the deployment before invoking the API.
Create a new deployment for the API using the [`CreateDeployment`](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateDeployment.html) API:

```bash
awslocal apigateway create-deployment \
lstk aws apigateway create-deployment \
--rest-api-id <REST_API_ID> \
--stage-name dev
```
Expand Down Expand Up @@ -346,10 +346,10 @@ functions:
```

Upon deployment of the Serverless project, LocalStack creates a new API Gateway V2 endpoint.
To retrieve the list of APIs and verify the WebSocket endpoint, you can use the `awslocal` CLI:
To retrieve the list of APIs and verify the WebSocket endpoint, you can use the `lstk aws` CLI:

```bash
awslocal apigatewayv2 get-apis
lstk aws apigatewayv2 get-apis
```

```bash title="Output"
Expand Down Expand Up @@ -377,7 +377,7 @@ To push data from a backend service to the WebSocket connection, you can use the
In LocalStack, use the following CLI command (replace `<connectionId>` with your WebSocket connection ID):

```bash
awslocal apigatewaymanagementapi \
lstk aws apigatewaymanagementapi \
post-to-connection \
--connection-id '<connectionId>' \
--data '{"msg": "Hi"}'
Expand All @@ -392,7 +392,7 @@ To assign a custom ID to an API Gateway REST API, use the `create-rest-api` comm
The following example assigns the custom ID `"myid123"` to the API:

```bash
awslocal apigateway create-rest-api --name my-api --tags '{"_custom_id_":"myid123"}'
lstk aws apigateway create-rest-api --name my-api --tags '{"_custom_id_":"myid123"}'
```

```bash title="Output"
Expand All @@ -405,7 +405,7 @@ awslocal apigateway create-rest-api --name my-api --tags '{"_custom_id_":"myid12
You can also configure the protocol type, the possible values being `HTTP` and `WEBSOCKET`:

```bash showshowLineNumbers
awslocal apigatewayv2 create-api \
lstk aws apigatewayv2 create-api \
--name=my-api \
--protocol-type=HTTP --tags="_custom_id_=my-api"
{
Expand Down
14 changes: 7 additions & 7 deletions src/content/docs/aws/services/appconfig.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The supported APIs are available on our [API Coverage section](#api-coverage), w

## Getting started

This guide is designed for users new to AppConfig and assumes basic knowledge of the AWS CLI and our [`awslocal`](https://github.com/localstack/awscli-local) wrapper script.
This guide is designed for users new to AppConfig and assumes basic knowledge of the AWS CLI and our [`lstk aws`](/aws/developer-tools/running-localstack/lstk/#aws) command.

Start your LocalStack container using your preferred method.
We will demonstrate how to create an AppConfig application, environment, configuration profiles & feature flags, and deploy the configuration with the AWS CLI.
Expand All @@ -27,7 +27,7 @@ The application is a folder/directory that contains the configuration data for y
The following command creates an application named `my-app`:

```bash
awslocal appconfig create-application \
lstk aws appconfig create-application \
--name my-app \
--description "My application"
```
Expand All @@ -47,7 +47,7 @@ An environment consists of the deployment group of your AppConfig applications.
The following command creates an environment named `my-app-env`:

```bash
awslocal appconfig create-environment \
lstk aws appconfig create-environment \
--application-id 400c285 \
--name my-app-env \
--description "My application environment"
Expand All @@ -73,7 +73,7 @@ A configuration profile contains for the configurations of your AppConfig applic
The following command creates a configuration profile named `my-app-config`:

```bash
awslocal appconfig create-configuration-profile \
lstk aws appconfig create-configuration-profile \
--application-id 400c285 \
--name my-app-config \
--location-uri hosted \
Expand Down Expand Up @@ -110,7 +110,7 @@ You can now use the [`CreateHostedConfigurationVersion`](https://docs.aws.amazon
The following command creates a hosted configuration version for the configuration profile you created in the previous step:

```bash
awslocal appconfig create-hosted-configuration-version \
lstk aws appconfig create-hosted-configuration-version \
--application-id 400c285 \
--configuration-profile-id 7d748f9 \
--content-type "application/json" \
Expand All @@ -134,7 +134,7 @@ A deployment strategy defines important criteria for rolling out your configurat
The following command creates a deployment strategy named `my-app-deployment-strategy`:

```bash
awslocal appconfig create-deployment-strategy \
lstk aws appconfig create-deployment-strategy \
--name my-app-deployment-strategy \
--description "My application deployment strategy" \
--deployment-duration-in-minutes 10 \
Expand All @@ -155,7 +155,7 @@ You can now use the [`StartDeployment`](https://docs.aws.amazon.com/appconfig/la
The following command deploys the configuration to the environment you created in the previous step:

```bash
awslocal appconfig start-deployment \
lstk aws appconfig start-deployment \
--application-id 400c285 \
--environment-id 3695ea3 \
--deployment-strategy-id f2f2225 \
Expand Down
Loading
Loading