network_migration_definitions

Creates, updates, deletes, gets or lists a network_migration_definitions resource.

Overview

Name	network_migration_definitions
Type	Resource
Id	aws.mgn.network_migration_definitions

Fields

The following fields are returned by SELECT queries:

get_network_migration_definition

Name	Datatype	Description
name	string	The name of the network migration definition. (pattern: <code>[^\s\x00]( [^\s\x00])</code>)
arn	string	The Amazon Resource Name (ARN) of the network migration definition.
created_at	string (date-time)	The timestamp when the network migration definition was created.
description	string	A description of the network migration definition. (pattern: <code>[^\x00]*</code>)
network_migration_definition_id	string	The unique identifier of the network migration definition. (pattern: <code>nmd-[0-9a-zA-Z]{17}</code>)
scope_tags	object	Scope tags for the network migration definition.
source_configurations	array	A list of source configurations for the network migration.
tags	object	Tags assigned to the network migration definition.
target_deployment	string	The target deployment configuration for the migrated network. (SINGLE_ACCOUNT, MULTI_ACCOUNT)
target_network	object	Configuration for the target network topology and addressing.
target_s3_configuration	object	S3 configuration for storing target network artifacts.
updated_at	string (date-time)	The timestamp when the network migration definition was last updated.

list_network_migration_definitions

Name	Datatype	Description
name	string	The name of the network migration definition. (pattern: <code>[^\s\x00]( [^\s\x00])</code>)
arn	string	The Amazon Resource Name (ARN) of the network migration definition.
network_migration_definition_id	string	The unique identifier of the network migration definition. (pattern: <code>nmd-[0-9a-zA-Z]{17}</code>)
scope_tags	object	Scope tags for the network migration definition.
source_environment	string	The source environment configuration. (NSX, VSPHERE, FORTIGATE_FIREWALL, PALO_ALTO_FIREWALL, CISCO_ACI, LOGICAL_MODEL, MODELIZE_IT, AWS_DISCOVERY_COLLECTOR)
tags	object	Tags assigned to the network migration definition.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_network_migration_definition	select	region		Retrieves the details of a network migration definition including source and target configurations.
list_network_migration_definitions	select	region		Lists all network migration definitions in the account, with optional filtering.
create_network_migration_definition	insert	region, name, targetS3Configuration, targetNetwork		Creates a new network migration definition that specifies the source and target network configuration for a migration.
update_network_migration_definition	update	region, networkMigrationDefinitionID		Updates an existing network migration definition with new source or target configurations.
delete_network_migration_definition	delete	region		Deletes a network migration definition. This operation removes the migration definition and all associated metadata.
start_network_migration_analysis	exec	region, networkMigrationExecutionID, networkMigrationDefinitionID		Starts a network migration analysis job to evaluate connectivity and compatibility of the migration mappings.
start_network_migration_code_generation	exec	region, networkMigrationExecutionID, networkMigrationDefinitionID		Starts a code generation job to convert network migration mappings into infrastructure-as-code templates.
start_network_migration_deployment	exec	region, networkMigrationExecutionID, networkMigrationDefinitionID		Starts a deployment job to create the target network infrastructure based on the generated code templates.
start_network_migration_mapping	exec	region, networkMigrationExecutionID, networkMigrationDefinitionID		Starts the network migration mapping process for a given network migration execution.

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

get_network_migration_definition

Retrieves the details of a network migration definition including source and target configurations.

SELECT
name,
arn,
created_at,
description,
network_migration_definition_id,
scope_tags,
source_configurations,
tags,
target_deployment,
target_network,
target_s3_configuration,
updated_at
FROM aws.mgn.network_migration_definitions
WHERE region = '{{ region }}' -- required
;

list_network_migration_definitions

Lists all network migration definitions in the account, with optional filtering.

SELECT
name,
arn,
network_migration_definition_id,
scope_tags,
source_environment,
tags
FROM aws.mgn.network_migration_definitions
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_network_migration_definition

Creates a new network migration definition that specifies the source and target network configuration for a migration.

INSERT INTO aws.mgn.network_migration_definitions (
name,
description,
sourceConfigurations,
targetS3Configuration,
targetNetwork,
targetDeployment,
tags,
scopeTags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ sourceConfigurations }}',
'{{ targetS3Configuration }}' /* required */,
'{{ targetNetwork }}' /* required */,
'{{ targetDeployment }}',
'{{ tags }}',
'{{ scopeTags }}',
'{{ region }}'
RETURNING
name,
arn,
created_at,
description,
network_migration_definition_id,
scope_tags,
source_configurations,
tags,
target_deployment,
target_network,
target_s3_configuration,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: network_migration_definitions
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the network_migration_definitions resource.
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: sourceConfigurations
    value:
      - sourceEnvironment: "{{ sourceEnvironment }}"
        sourceS3Configuration:
          s3Bucket: "{{ s3Bucket }}"
          s3BucketOwner: "{{ s3BucketOwner }}"
          s3Key: "{{ s3Key }}"
  - name: targetS3Configuration
    description: |
      S3 configuration for storing target network artifacts.
    value:
      s3Bucket: "{{ s3Bucket }}"
      s3BucketOwner: "{{ s3BucketOwner }}"
  - name: targetNetwork
    description: |
      Configuration for the target network topology and addressing.
    value:
      topology: "{{ topology }}"
      inboundCidr: "{{ inboundCidr }}"
      outboundCidr: "{{ outboundCidr }}"
      inspectionCidr: "{{ inspectionCidr }}"
  - name: targetDeployment
    value: "{{ targetDeployment }}"
    valid_values: ['SINGLE_ACCOUNT', 'MULTI_ACCOUNT']
  - name: tags
    value: "{{ tags }}"
  - name: scopeTags
    value: "{{ scopeTags }}"

UPDATE examples

update_network_migration_definition

Updates an existing network migration definition with new source or target configurations.

UPDATE aws.mgn.network_migration_definitions
SET 
networkMigrationDefinitionID = '{{ networkMigrationDefinitionID }}',
name = '{{ name }}',
description = '{{ description }}',
sourceConfigurations = '{{ sourceConfigurations }}',
targetS3Configuration = '{{ targetS3Configuration }}',
targetNetwork = '{{ targetNetwork }}',
targetDeployment = '{{ targetDeployment }}',
scopeTags = '{{ scopeTags }}'
WHERE 
region = '{{ region }}' --required
AND networkMigrationDefinitionID = '{{ networkMigrationDefinitionID }}' --required
RETURNING
name,
arn,
created_at,
description,
network_migration_definition_id,
scope_tags,
source_configurations,
tags,
target_deployment,
target_network,
target_s3_configuration,
updated_at;

DELETE examples

delete_network_migration_definition

Deletes a network migration definition. This operation removes the migration definition and all associated metadata.

DELETE FROM aws.mgn.network_migration_definitions
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

start_network_migration_analysis

Starts a network migration analysis job to evaluate connectivity and compatibility of the migration mappings.

EXEC aws.mgn.network_migration_definitions.start_network_migration_analysis 
@region='{{ region }}' --required 
@@json=
'{
"networkMigrationExecutionID": "{{ networkMigrationExecutionID }}", 
"networkMigrationDefinitionID": "{{ networkMigrationDefinitionID }}"
}'
;

start_network_migration_code_generation

Starts a code generation job to convert network migration mappings into infrastructure-as-code templates.

EXEC aws.mgn.network_migration_definitions.start_network_migration_code_generation 
@region='{{ region }}' --required 
@@json=
'{
"networkMigrationExecutionID": "{{ networkMigrationExecutionID }}", 
"networkMigrationDefinitionID": "{{ networkMigrationDefinitionID }}", 
"codeGenerationOutputFormatTypes": "{{ codeGenerationOutputFormatTypes }}"
}'
;

start_network_migration_deployment

Starts a deployment job to create the target network infrastructure based on the generated code templates.

EXEC aws.mgn.network_migration_definitions.start_network_migration_deployment 
@region='{{ region }}' --required 
@@json=
'{
"networkMigrationExecutionID": "{{ networkMigrationExecutionID }}", 
"networkMigrationDefinitionID": "{{ networkMigrationDefinitionID }}"
}'
;

start_network_migration_mapping

Starts the network migration mapping process for a given network migration execution.

EXEC aws.mgn.network_migration_definitions.start_network_migration_mapping 
@region='{{ region }}' --required 
@@json=
'{
"networkMigrationExecutionID": "{{ networkMigrationExecutionID }}", 
"networkMigrationDefinitionID": "{{ networkMigrationDefinitionID }}", 
"securityGroupMappingStrategy": "{{ securityGroupMappingStrategy }}"
}'
;