Skip to content

Commit 32b0435

Browse files
lewijacnNaarcha-AWSnatebower
authored
Add bring your own snapshot documentation to configuration-options.md (#9573)
* Add documentation for byos Signed-off-by: Tanner Lewis <lewijacn@amazon.com> * Update _migration-assistant/deploying-migration-assistant/configuration-options.md Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Tanner Lewis <lewijacn@amazon.com> * Enhance wording for BYOS Signed-off-by: Tanner Lewis <lewijacn@amazon.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Tanner Lewis <lewijacn@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
1 parent 83b14df commit 32b0435

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

_migration-assistant/deploying-migration-assistant/configuration-options.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,50 @@ The `serviceSigningName` can be `es` for an Elasticsearch or OpenSearch domain,
170170

171171
All of these authentication options apply to both source and target clusters.
172172

173+
## Bring-your-own-snapshot options
174+
175+
An existing Amazon Simple Storage Service (Amazon S3) snapshot can alternatively be used to perform [metadata]({{site.url}}{{site.baseurl}}/migration-assistant/migration-phases/migrating-metadata/) and [backfill]({{site.url}}{{site.baseurl}}/migration-assistant/migration-phases/backfill/) migrations instead of using Migration Assistant to create a snapshot:
176+
177+
```json
178+
"snapshot": {
179+
"snapshotName": "my-snapshot-name",
180+
"s3Uri": "s3://my-s3-bucket-name/my-bucket-path-to-snapshot-repo",
181+
"s3Region": "us-east-2"
182+
}
183+
```
184+
{% include copy.html %}
185+
186+
By default, Amazon S3 buckets automatically allow roles in the same AWS account (with the appropriate `s3:*` permissions) to access the S3 bucket, regardless of the bucket's AWS Region. If the external S3 bucket being used is in the same AWS account as the Migration Assistant deployment, no further AWS Identity and Access Management (IAM) configuration is required to access the bucket.
187+
188+
If a custom permission model has been used with Amazon S3, any access control list (ACL) or custom bucket policy should allow the Migration Assistant task roles for RFS and the migration console to read from the S3 bucket.
189+
190+
If the S3 bucket is in a separate AWS account from the Migration Assistant deployment, a custom bucket policy similar to the following will be needed to allow access to Migration Assistant:
191+
192+
```json
193+
{
194+
"Version": "2012-10-17",
195+
"Statement": [
196+
{
197+
"Sid": "AllowExternalAccountReadAccessToBucket",
198+
"Effect": "Allow",
199+
"Principal": {
200+
"AWS": "arn:aws:iam::<ACCOUNT_ID>:root"
201+
},
202+
"Action": [
203+
"s3:GetObject",
204+
"s3:ListBucket",
205+
"s3:GetBucketLocation"
206+
],
207+
"Resource": [
208+
"arn:aws:s3:::my-s3-bucket-name",
209+
"arn:aws:s3:::my-s3-bucket-name/*"
210+
]
211+
}
212+
]
213+
}
214+
```
215+
{% include copy.html %}
216+
173217
## Network configuration
174218

175219
The migration tooling expects the source cluster, target cluster, and migration resources to exist in the same VPC. If this is not the case, manual networking setup outside of this documentation is likely required.

0 commit comments

Comments
 (0)