migration_projects

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

Overview

Name	migration_projects
Type	Resource
Id	aws.dms.migration_projects

Fields

The following fields are returned by SELECT queries:

describe_migration_projects

Name	Datatype	Description
marker	string	Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
migration_projects	array	A description of migration projects.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_migration_projects	select	region		Returns a paginated list of migration projects for your account in the current region. Required permissions: dms:ListMigrationProjects. For more information, see Actions, resources, and condition keys for Database Migration Service.
create_migration_project	insert	region, SourceDataProviderDescriptors, TargetDataProviderDescriptors, InstanceProfileIdentifier		Creates the migration project using the specified parameters. You can run this action only after you create an instance profile and data providers using CreateInstanceProfile and CreateDataProvider. Required permissions: dms:CreateMigrationProject. For more information, see Actions, resources, and condition keys for Database Migration Service.
modify_migration_project	update	region, MigrationProjectIdentifier		Modifies the specified migration project using the provided parameters. Required permissions: dms:UpdateMigrationProject. For more information, see Actions, resources, and condition keys for Database Migration Service. The migration project must be closed before you can modify it.
delete_migration_project	delete	region		Deletes the specified migration project. Required permissions: dms:DeleteMigrationProject. For more information, see Actions, resources, and condition keys for Database Migration Service. The migration project must be closed before you can delete it.
start_extension_pack_association	exec	region, MigrationProjectIdentifier		Queues the installation of the extension pack on your target database. If other requests created by Start* operations are already in the migration project's queue, the installation begins after they complete. This operation requires a non-virtual target data provider. If the extension pack already exists, the operation reinstalls it. To ensure compatibility, reconvert your database objects if the version has changed since your last conversion. For more information, see Using extension packs in DMS Schema Conversion. To check the status of the request, call DescribeExtensionPackAssociations using the returned RequestIdentifier as a filter. Required permissions: dms:AssociateExtensionPack. For more information, see Actions, resources, and condition keys for Database Migration Service.

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

describe_migration_projects

Returns a paginated list of migration projects for your account in the current region. Required permissions: dms:ListMigrationProjects. For more information, see Actions, resources, and condition keys for Database Migration Service.

SELECT
marker,
migration_projects
FROM aws.dms.migration_projects
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_migration_project

Creates the migration project using the specified parameters. You can run this action only after you create an instance profile and data providers using CreateInstanceProfile and CreateDataProvider. Required permissions: dms:CreateMigrationProject. For more information, see Actions, resources, and condition keys for Database Migration Service.

INSERT INTO aws.dms.migration_projects (
MigrationProjectName,
SourceDataProviderDescriptors,
TargetDataProviderDescriptors,
InstanceProfileIdentifier,
TransformationRules,
Description,
Tags,
SchemaConversionApplicationAttributes,
region
)
SELECT 
'{{ MigrationProjectName }}',
'{{ SourceDataProviderDescriptors }}' /* required */,
'{{ TargetDataProviderDescriptors }}' /* required */,
'{{ InstanceProfileIdentifier }}' /* required */,
'{{ TransformationRules }}',
'{{ Description }}',
'{{ Tags }}',
'{{ SchemaConversionApplicationAttributes }}',
'{{ region }}'
RETURNING
migration_project
;

Manifest

# Description fields are for documentation purposes
- name: migration_projects
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the migration_projects resource.
  - name: MigrationProjectName
    value: "{{ MigrationProjectName }}"
    description: |
      A user-friendly name for the migration project.
  - name: SourceDataProviderDescriptors
    description: |
      Information about the source data provider, including the name, ARN, and Secrets Manager parameters.
    value:
      - DataProviderIdentifier: "{{ DataProviderIdentifier }}"
        SecretsManagerSecretId: "{{ SecretsManagerSecretId }}"
        SecretsManagerAccessRoleArn: "{{ SecretsManagerAccessRoleArn }}"
  - name: TargetDataProviderDescriptors
    description: |
      Information about the target data provider, including the name, ARN, and Amazon Web Services Secrets Manager parameters.
    value:
      - DataProviderIdentifier: "{{ DataProviderIdentifier }}"
        SecretsManagerSecretId: "{{ SecretsManagerSecretId }}"
        SecretsManagerAccessRoleArn: "{{ SecretsManagerAccessRoleArn }}"
  - name: InstanceProfileIdentifier
    value: "{{ InstanceProfileIdentifier }}"
    description: |
      The identifier of the associated instance profile. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.
  - name: TransformationRules
    value: "{{ TransformationRules }}"
    description: |
      A JSON string that specifies the transformation rules for the migration project. Transformation rules let you customize how DMS Schema Conversion converts your source database objects, including renaming, adding prefixes or suffixes, and changing data types. For the transformation rule format and examples, see Transformation rules in DMS Schema Conversion. Homogeneous data migrations do not support transformation rules.
  - name: Description
    value: "{{ Description }}"
    description: |
      A user-friendly description of the migration project.
  - name: Tags
    description: |
      One or more tags to be assigned to the migration project.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
        ResourceArn: "{{ ResourceArn }}"
  - name: SchemaConversionApplicationAttributes
    description: |
      The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.
    value:
      S3BucketPath: "{{ S3BucketPath }}"
      S3BucketRoleArn: "{{ S3BucketRoleArn }}"

UPDATE examples

modify_migration_project

Modifies the specified migration project using the provided parameters. Required permissions: dms:UpdateMigrationProject. For more information, see Actions, resources, and condition keys for Database Migration Service. The migration project must be closed before you can modify it.

UPDATE aws.dms.migration_projects
SET 
MigrationProjectIdentifier = '{{ MigrationProjectIdentifier }}',
MigrationProjectName = '{{ MigrationProjectName }}',
SourceDataProviderDescriptors = '{{ SourceDataProviderDescriptors }}',
TargetDataProviderDescriptors = '{{ TargetDataProviderDescriptors }}',
InstanceProfileIdentifier = '{{ InstanceProfileIdentifier }}',
TransformationRules = '{{ TransformationRules }}',
Description = '{{ Description }}',
SchemaConversionApplicationAttributes = '{{ SchemaConversionApplicationAttributes }}'
WHERE 
region = '{{ region }}' --required
AND MigrationProjectIdentifier = '{{ MigrationProjectIdentifier }}' --required
RETURNING
migration_project;

DELETE examples

delete_migration_project

Deletes the specified migration project. Required permissions: dms:DeleteMigrationProject. For more information, see Actions, resources, and condition keys for Database Migration Service. The migration project must be closed before you can delete it.

DELETE FROM aws.dms.migration_projects
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

start_extension_pack_association

Queues the installation of the extension pack on your target database. If other requests created by Start* operations are already in the migration project's queue, the installation begins after they complete. This operation requires a non-virtual target data provider. If the extension pack already exists, the operation reinstalls it. To ensure compatibility, reconvert your database objects if the version has changed since your last conversion. For more information, see Using extension packs in DMS Schema Conversion. To check the status of the request, call DescribeExtensionPackAssociations using the returned RequestIdentifier as a filter. Required permissions: dms:AssociateExtensionPack. For more information, see Actions, resources, and condition keys for Database Migration Service.

EXEC aws.dms.migration_projects.start_extension_pack_association 
@region='{{ region }}' --required 
@@json=
'{
"MigrationProjectIdentifier": "{{ MigrationProjectIdentifier }}"
}'
;