Skip to content

improve replicator doc #1705

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 3, 2025
Merged
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
37 changes: 25 additions & 12 deletions content/en/user-guide/tools/aws-replicator/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,24 +37,33 @@ These operations can be limited by creating a minimal IAM role with just the pol

See the [supported resources section](#supported-resources) for details of what policy actions are required for each resource.

Replication is triggered using the LocalStack CLI, which must run in a shell configured to access AWS.
If you have the aws-cli v2 installed, the cli will read credentials from your configured `AWS_PROFILE`.
When the replication is triggered using the LocalStack CLI, which must run in a shell configured to access AWS.
Here are some options:

Otherwise, the following environment variables must be set:
{{< tabpane text=true >}}
{{< tab header="AWS CLI v2" >}}
{{% markdown %}}

If you have the AWS CLI v2 installed, the CLI will read credentials from your configured `AWS_PROFILE`.

{{< command >}}
$ export AWS_PROFILE=my-aws-profile
$ localstack replicator ...
{{< /command >}}

{{% /markdown %}}
{{< /tab >}}
{{< tab header="AWS CLI v1" >}}
{{% markdown %}}
If you have the AWS CLI v1 installed or no installation of the AWS CLI, the following environment variables must be set:

- `AWS_ACCESS_KEY_ID`
- `AWS_SECRET_ACCESS_KEY`
- `AWS_SESSION_TOKEN` (optional)
- `AWS_DEFAULT_REGION`

{{< callout "tip" >}}
Use `aws configure export-credentials --format env` to print the required environment variables in a format that can be evaluated.

{{< command >}}
<disable-copy>$ </disable-copy>eval $(AWS_PROFILE=<aws-profile> aws configure export-credentials \
--format env)
{{< /command >}}
{{< /callout >}}
{{% /markdown %}}
{{< /tab >}}
{{< /tabpane >}}

### Trigger a replication job

Expand Down Expand Up @@ -306,6 +315,10 @@ Use the `--target-account-id` flag to specify a different account.

## Supported Resources

The project is still in preview state and we welcome feedback and bug reports.
We have opened a [github issue where you can request and upvote](https://github.com/localstack/localstack/issues/12439) to help us prioritize our efforts and support the resources with the most impact.
For any other requests or reports, please open a [new github issue](https://github.com/localstack/localstack/issues/new/choose).

{{< callout "tip" >}}
To ensure support for all resources, use the latest LocalStack Docker image.
{{< /callout >}}
Expand Down