network_migration_mapper_segments

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

Overview

Name	network_migration_mapper_segments
Type	Resource
Id	aws.mgn.network_migration_mapper_segments

Fields

The following fields are returned by SELECT queries:

list_network_migration_mapper_segments

Name	Datatype	Description
name	string	The name of the segment. (pattern: <code>[^\s\x00]( [^\s\x00])</code>)
checksum	object	The checksum of the segment data for integrity verification.
created_at	string (date-time)	The timestamp when the segment was created.
description	string	A description of the segment. (pattern: <code>[^\x00]*</code>)
job_id	string	The unique identifier of the job that created this segment. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
logical_id	string	The logical identifier for the segment in the infrastructure code. (pattern: <code>[a-zA-Z][a-zA-Z0-9-]*</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>)
output_s3_configuration	object	The S3 location where segment artifacts are stored.
referenced_segments	array	A list of other segments that this segment depends on or references.
scope_tags	object	Scope tags for the segment.
segment_id	string	The unique identifier of the segment. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
segment_type	string	The type of the segment, such as VPC, subnet, or security group. (WORKLOAD, APPLIANCE)
target_account	string	The target AWS account where this segment will be deployed. (pattern: <code>.[0-9]{12,}.</code>)
updated_at	string (date-time)	The timestamp when the segment was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_network_migration_mapper_segments	select	region		Lists mapper segments, which represent logical groupings of network resources to be migrated together.
update_network_migration_mapper_segment	update	region, networkMigrationDefinitionID, networkMigrationExecutionID, segmentID		Updates a mapper segment's configuration, such as changing its scope tags.

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_mapper_segments

Lists mapper segments, which represent logical groupings of network resources to be migrated together.

SELECT
name,
checksum,
created_at,
description,
job_id,
logical_id,
network_migration_definition_id,
network_migration_execution_id,
output_s3_configuration,
referenced_segments,
scope_tags,
segment_id,
segment_type,
target_account,
updated_at
FROM aws.mgn.network_migration_mapper_segments
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_network_migration_mapper_segment

Updates a mapper segment's configuration, such as changing its scope tags.

UPDATE aws.mgn.network_migration_mapper_segments
SET 
networkMigrationDefinitionID = '{{ networkMigrationDefinitionID }}',
networkMigrationExecutionID = '{{ networkMigrationExecutionID }}',
segmentID = '{{ segmentID }}',
scopeTags = '{{ scopeTags }}'
WHERE 
region = '{{ region }}' --required
AND networkMigrationDefinitionID = '{{ networkMigrationDefinitionID }}' --required
AND networkMigrationExecutionID = '{{ networkMigrationExecutionID }}' --required
AND segmentID = '{{ segmentID }}' --required
RETURNING
name,
checksum,
created_at,
description,
job_id,
logical_id,
network_migration_definition_id,
network_migration_execution_id,
output_s3_configuration,
referenced_segments,
scope_tags,
segment_id,
segment_type,
target_account,
updated_at;