network_migration_mappings
Creates, updates, deletes, gets or lists a network_migration_mappings resource.
Overview
| Name | network_migration_mappings |
| Type | Resource |
| Id | aws.mgn.network_migration_mappings |
Fields
The following fields are returned by SELECT queries:
- list_network_migration_mappings
| Name | Datatype | Description |
|---|---|---|
created_at | string (date-time) | The timestamp when the job was created. |
ended_at | string (date-time) | The timestamp when the job completed or failed. |
job_id | string | The unique identifier of the mapping job. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>) |
network_migration_definition_id | string | The unique identifier of the network migration definition. (pattern: <code>nmd-[0-9a-zA-Z]{17}</code>) |
network_migration_execution_id | string | The unique identifier of the network migration execution. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>) |
status | string | The current status of the mapping job. (PENDING, STARTED, SUCCEEDED, FAILED) |
status_details | string | Detailed status information about the job. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_network_migration_mappings | select | region | Lists network migration mapping jobs, which analyze and create relationships between source and target network resources. | |
start_network_migration_mapping_update | exec | region, networkMigrationExecutionID, networkMigrationDefinitionID | Starts a job to apply customer modifications to network migration mappings, such as changing properties. |
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_network_migration_mappings
Lists network migration mapping jobs, which analyze and create relationships between source and target network resources.
SELECT
created_at,
ended_at,
job_id,
network_migration_definition_id,
network_migration_execution_id,
status,
status_details
FROM aws.mgn.network_migration_mappings
WHERE region = '{{ region }}' -- required
;
Lifecycle Methods
- start_network_migration_mapping_update
Starts a job to apply customer modifications to network migration mappings, such as changing properties.
EXEC aws.mgn.network_migration_mappings.start_network_migration_mapping_update
@region='{{ region }}' --required
@@json=
'{
"networkMigrationExecutionID": "{{ networkMigrationExecutionID }}",
"networkMigrationDefinitionID": "{{ networkMigrationDefinitionID }}",
"constructs": "{{ constructs }}",
"segments": "{{ segments }}"
}'
;