mgn / Client / create_network_migration_definition

create_network_migration_definition

mgn.Client.create_network_migration_definition(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.create_network_migration_definition(
    name='string',
    description='string',
    sourceConfigurations=[
        {
            'sourceEnvironment': 'NSX'|'VSPHERE'|'FORTIGATE_FIREWALL'|'PALO_ALTO_FIREWALL'|'CISCO_ACI'|'LOGICAL_MODEL'|'MODELIZE_IT'|'AWS_DISCOVERY_COLLECTOR',
            'sourceS3Configuration': {
                's3Bucket': 'string',
                's3BucketOwner': 'string',
                's3Key': 'string'
            }
        },
    ],
    targetS3Configuration={
        's3Bucket': 'string',
        's3BucketOwner': 'string'
    },
    targetNetwork={
        'topology': 'ISOLATED_VPC'|'HUB_AND_SPOKE',
        'inboundCidr': 'string',
        'outboundCidr': 'string',
        'inspectionCidr': 'string'
    },
    targetDeployment='SINGLE_ACCOUNT'|'MULTI_ACCOUNT',
    vpcProvisioningStrategy='CREATE_NEW'|'USE_EXISTING',
    cidrMappings=[
        {
            'originalCidr': 'string',
            'updatedCidr': 'string'
        },
    ],
    tags={
        'string': 'string'
    },
    scopeTags={
        'string': 'string'
    }
)
Parameters:

  • name (string) –

    [REQUIRED]

    The name of the network migration definition.

  • description (string) – A description of the network migration definition.

  • sourceConfigurations (list) –

    A list of source configurations for the network migration.

    • (dict) –

      Configuration for a migration source environment.

      • sourceEnvironment (string) – [REQUIRED]

        The source environment type.

      • sourceS3Configuration (dict) – [REQUIRED]

        The S3 configuration for the source data.

        • s3Bucket (string) – [REQUIRED]

          The name of the S3 bucket containing source data.

        • s3BucketOwner (string) – [REQUIRED]

          The AWS account ID of the S3 bucket owner.

        • s3Key (string) – [REQUIRED]

          The S3 key (path) for the source data.

  • targetS3Configuration (dict) –

    [REQUIRED]

    The S3 configuration for storing the target network artifacts.

    • s3Bucket (string) – [REQUIRED]

      The name of the S3 bucket for target artifacts.

    • s3BucketOwner (string) – [REQUIRED]

      The AWS account ID of the S3 bucket owner.

  • targetNetwork (dict) –

    [REQUIRED]

    The target network configuration including topology and CIDR ranges.

    • topology (string) – [REQUIRED]

      The network topology type for the target environment.

    • inboundCidr (string) –

      The CIDR block for inbound traffic in the target network.

    • outboundCidr (string) –

      The CIDR block for outbound traffic in the target network.

    • inspectionCidr (string) –

      The CIDR block for inspection traffic in the target network.

  • targetDeployment (string) – The target deployment configuration for the migrated network.

  • vpcProvisioningStrategy (string) – Specifies whether to create new target VPCs or use existing ones. Set to CREATE_NEW to provision new target VPCs as part of the migration, or USE_EXISTING to migrate into existing VPCs in the target account.

  • cidrMappings (list) –

    A list of CIDR mappings that map original source CIDR ranges to updated target CIDR ranges. CIDR mappings can be provided only when vpcProvisioningStrategy is set to USE_EXISTING.

    • (dict) –

      Maps a source CIDR range to the corresponding target CIDR range to use in the target network.

      • originalCidr (string) – [REQUIRED]

        The original CIDR range in the source network.

      • updatedCidr (string) – [REQUIRED]

        The updated CIDR range to use in the target network.

  • tags (dict) –

    Tags to assign to the network migration definition.

    • (string) –

      • (string) –

  • scopeTags (dict) –

    Scope tags for the network migration definition to control access and organization.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'networkMigrationDefinitionID': 'string',
    'name': 'string',
    'description': 'string',
    'sourceConfigurations': [
        {
            'sourceEnvironment': 'NSX'|'VSPHERE'|'FORTIGATE_FIREWALL'|'PALO_ALTO_FIREWALL'|'CISCO_ACI'|'LOGICAL_MODEL'|'MODELIZE_IT'|'AWS_DISCOVERY_COLLECTOR',
            'sourceS3Configuration': {
                's3Bucket': 'string',
                's3BucketOwner': 'string',
                's3Key': 'string'
            }
        },
    ],
    'targetS3Configuration': {
        's3Bucket': 'string',
        's3BucketOwner': 'string'
    },
    'targetNetwork': {
        'topology': 'ISOLATED_VPC'|'HUB_AND_SPOKE',
        'inboundCidr': 'string',
        'outboundCidr': 'string',
        'inspectionCidr': 'string'
    },
    'targetDeployment': 'SINGLE_ACCOUNT'|'MULTI_ACCOUNT',
    'vpcProvisioningStrategy': 'CREATE_NEW'|'USE_EXISTING',
    'cidrMappings': [
        {
            'originalCidr': 'string',
            'updatedCidr': 'string'
        },
    ],
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    },
    'scopeTags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    • arn (string) –

      The Amazon Resource Name (ARN) of the network migration definition.

    • networkMigrationDefinitionID (string) –

      The unique identifier of the network migration definition.

    • name (string) –

      The name of the network migration definition.

    • description (string) –

      A description of the network migration definition.

    • sourceConfigurations (list) –

      A list of source configurations for the network migration.

      • (dict) –

        Configuration for a migration source environment.

        • sourceEnvironment (string) –

          The source environment type.

        • sourceS3Configuration (dict) –

          The S3 configuration for the source data.

          • s3Bucket (string) –

            The name of the S3 bucket containing source data.

          • s3BucketOwner (string) –

            The AWS account ID of the S3 bucket owner.

          • s3Key (string) –

            The S3 key (path) for the source data.

    • targetS3Configuration (dict) –

      The S3 configuration for storing the target network artifacts.

      • s3Bucket (string) –

        The name of the S3 bucket for target artifacts.

      • s3BucketOwner (string) –

        The AWS account ID of the S3 bucket owner.

    • targetNetwork (dict) –

      The target network configuration including topology and CIDR ranges.

      • topology (string) –

        The network topology type for the target environment.

      • inboundCidr (string) –

        The CIDR block for inbound traffic in the target network.

      • outboundCidr (string) –

        The CIDR block for outbound traffic in the target network.

      • inspectionCidr (string) –

        The CIDR block for inspection traffic in the target network.

    • targetDeployment (string) –

      The target deployment configuration for the migrated network.

    • vpcProvisioningStrategy (string) –

      Indicates whether the migration creates new target VPCs or uses existing ones. CREATE_NEW provisions new target VPCs; USE_EXISTING migrates into existing VPCs in the target account.

    • cidrMappings (list) –

      A list of CIDR mappings that map original source CIDR ranges to updated target CIDR ranges. CIDR mappings apply only when vpcProvisioningStrategy is set to USE_EXISTING.

      • (dict) –

        Maps a source CIDR range to the corresponding target CIDR range to use in the target network.

        • originalCidr (string) –

          The original CIDR range in the source network.

        • updatedCidr (string) –

          The updated CIDR range to use in the target network.

    • createdAt (datetime) –

      The timestamp when the network migration definition was created.

    • updatedAt (datetime) –

      The timestamp when the network migration definition was last updated.

    • tags (dict) –

      Tags assigned to the network migration definition.

      • (string) –

        • (string) –

    • scopeTags (dict) –

      Scope tags for the network migration definition.

      • (string) –

        • (string) –

Exceptions