source_resources
Creates, updates, deletes, gets or lists a source_resources resource.
Overview
| Name | source_resources |
| Type | Resource |
| Id | aws.mgh.source_resources |
Fields
The following fields are returned by SELECT queries:
- list_source_resources
| Name | Datatype | Description |
|---|---|---|
description | string | A description that can be free-form text to record additional detail about the resource for clarity or later reference. (pattern: <code>^.{0,500}$</code>) |
name | string | This is the name that you want to use to identify the resource. If the resource is an AWS resource, we recommend that you set this parameter to the ARN of the resource. |
status_detail | string | A free-form description of the status of the resource. (pattern: <code>^.{0,2500}$</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_source_resources | select | region | Lists all the source resource that are associated with the specified MigrationTaskName and ProgressUpdateStream. | |
associate_source_resource | update | region, ProgressUpdateStream, MigrationTaskName, SourceResource | Associates a source resource with a migration task. For example, the source resource can be a source server, an application, or a migration wave. | |
disassociate_source_resource | update | region, ProgressUpdateStream, MigrationTaskName, SourceResourceName | Removes the association between a source resource and a migration task. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- list_source_resources
Lists all the source resource that are associated with the specified MigrationTaskName and ProgressUpdateStream.
SELECT
description,
name,
status_detail
FROM aws.mgh.source_resources
WHERE region = '{{ region }}' -- required
;
UPDATE examples
- associate_source_resource
- disassociate_source_resource
Associates a source resource with a migration task. For example, the source resource can be a source server, an application, or a migration wave.
UPDATE aws.mgh.source_resources
SET
ProgressUpdateStream = '{{ ProgressUpdateStream }}',
MigrationTaskName = '{{ MigrationTaskName }}',
SourceResource = '{{ SourceResource }}',
DryRun = {{ DryRun }}
WHERE
region = '{{ region }}' --required
AND ProgressUpdateStream = '{{ ProgressUpdateStream }}' --required
AND MigrationTaskName = '{{ MigrationTaskName }}' --required
AND SourceResource = '{{ SourceResource }}' --required;
Removes the association between a source resource and a migration task.
UPDATE aws.mgh.source_resources
SET
ProgressUpdateStream = '{{ ProgressUpdateStream }}',
MigrationTaskName = '{{ MigrationTaskName }}',
SourceResourceName = '{{ SourceResourceName }}',
DryRun = {{ DryRun }}
WHERE
region = '{{ region }}' --required
AND ProgressUpdateStream = '{{ ProgressUpdateStream }}' --required
AND MigrationTaskName = '{{ MigrationTaskName }}' --required
AND SourceResourceName = '{{ SourceResourceName }}' --required;