migration_projects

Creates, updates, deletes or gets a migration_project resource or lists migration_projects in a region

Overview

Name	migration_projects
Type	Resource
Description	Resource schema for AWS::DMS::MigrationProject
Id	aws.dms.migration_projects

Fields

Name	Datatype	Description
migration_project_name	string	The property describes a name to identify the migration project.
migration_project_identifier	string	The property describes an identifier for the migration project. It is used for describing/deleting/modifying can be name/arn
migration_project_arn	string	The property describes an ARN of the migration project.
migration_project_creation_time	string	The property describes a creating time of the migration project.
instance_profile_identifier	string	The property describes an instance profile identifier for the migration project. For create
instance_profile_name	string	The property describes an instance profile name for the migration project. For read
instance_profile_arn	string	The property describes an instance profile arn for the migration project. For read
transformation_rules	string	The property describes transformation rules for the migration project.
description	string	The optional description of the migration project.
schema_conversion_application_attributes	object	The property describes schema conversion application attributes for the migration project.
source_data_provider_descriptors	array	The property describes source data provider descriptors for the migration project.
target_data_provider_descriptors	array	The property describes target data provider descriptors for the migration project.
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all migration_projects in a region.

SELECT
region,
migration_project_name,
migration_project_identifier,
migration_project_arn,
migration_project_creation_time,
instance_profile_identifier,
instance_profile_name,
instance_profile_arn,
transformation_rules,
description,
schema_conversion_application_attributes,
source_data_provider_descriptors,
target_data_provider_descriptors,
tags
FROM aws.dms.migration_projects
WHERE region = 'us-east-1';

Gets all properties from an individual migration_project.

SELECT
region,
migration_project_name,
migration_project_identifier,
migration_project_arn,
migration_project_creation_time,
instance_profile_identifier,
instance_profile_name,
instance_profile_arn,
transformation_rules,
description,
schema_conversion_application_attributes,
source_data_provider_descriptors,
target_data_provider_descriptors,
tags
FROM aws.dms.migration_projects
WHERE region = 'us-east-1' AND data__Identifier = '<MigrationProjectArn>';

INSERT example

Use the following StackQL query and manifest file to create a new migration_project resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.dms.migration_projects (
 MigrationProjectName,
 MigrationProjectIdentifier,
 MigrationProjectCreationTime,
 InstanceProfileIdentifier,
 InstanceProfileName,
 InstanceProfileArn,
 TransformationRules,
 Description,
 SchemaConversionApplicationAttributes,
 SourceDataProviderDescriptors,
 TargetDataProviderDescriptors,
 Tags,
 region
)
SELECT 
'{{ MigrationProjectName }}',
 '{{ MigrationProjectIdentifier }}',
 '{{ MigrationProjectCreationTime }}',
 '{{ InstanceProfileIdentifier }}',
 '{{ InstanceProfileName }}',
 '{{ InstanceProfileArn }}',
 '{{ TransformationRules }}',
 '{{ Description }}',
 '{{ SchemaConversionApplicationAttributes }}',
 '{{ SourceDataProviderDescriptors }}',
 '{{ TargetDataProviderDescriptors }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.dms.migration_projects (
 MigrationProjectName,
 MigrationProjectIdentifier,
 MigrationProjectCreationTime,
 InstanceProfileIdentifier,
 InstanceProfileName,
 InstanceProfileArn,
 TransformationRules,
 Description,
 SchemaConversionApplicationAttributes,
 SourceDataProviderDescriptors,
 TargetDataProviderDescriptors,
 Tags,
 region
)
SELECT 
 '{{ MigrationProjectName }}',
 '{{ MigrationProjectIdentifier }}',
 '{{ MigrationProjectCreationTime }}',
 '{{ InstanceProfileIdentifier }}',
 '{{ InstanceProfileName }}',
 '{{ InstanceProfileArn }}',
 '{{ TransformationRules }}',
 '{{ Description }}',
 '{{ SchemaConversionApplicationAttributes }}',
 '{{ SourceDataProviderDescriptors }}',
 '{{ TargetDataProviderDescriptors }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: migration_project
    props:
      - name: MigrationProjectName
        value: '{{ MigrationProjectName }}'
      - name: MigrationProjectIdentifier
        value: '{{ MigrationProjectIdentifier }}'
      - name: MigrationProjectCreationTime
        value: '{{ MigrationProjectCreationTime }}'
      - name: InstanceProfileIdentifier
        value: '{{ InstanceProfileIdentifier }}'
      - name: InstanceProfileName
        value: '{{ InstanceProfileName }}'
      - name: InstanceProfileArn
        value: '{{ InstanceProfileArn }}'
      - name: TransformationRules
        value: '{{ TransformationRules }}'
      - name: Description
        value: '{{ Description }}'
      - name: SchemaConversionApplicationAttributes
        value:
          S3BucketPath: '{{ S3BucketPath }}'
          S3BucketRoleArn: '{{ S3BucketRoleArn }}'
      - name: SourceDataProviderDescriptors
        value:
          - DataProviderIdentifier: '{{ DataProviderIdentifier }}'
            DataProviderName: '{{ DataProviderName }}'
            DataProviderArn: '{{ DataProviderArn }}'
            SecretsManagerSecretId: '{{ SecretsManagerSecretId }}'
            SecretsManagerAccessRoleArn: '{{ SecretsManagerAccessRoleArn }}'
      - name: TargetDataProviderDescriptors
        value:
          - null
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.dms.migration_projects
WHERE data__Identifier = '<MigrationProjectArn>'
AND region = 'us-east-1';

Permissions

To operate on the migration_projects resource, the following permissions are required:

Create

dms:CreateMigrationProject,
dms:ListMigrationProjects,
dms:DescribeMigrationProjects,
dms:AddTagsToResource,
dms:ListTagsForResource,
iam:PassRole

Read

dms:DescribeMigrationProjects,
dms:ListMigrationProjects,
dms:ListTagsForResource

Update

dms:UpdateMigrationProject,
dms:ModifyMigrationProject,
dms:AddTagsToResource,
dms:RemoveTagsToResource,
dms:ListTagsForResource,
iam:PassRole

Delete

dms:DeleteMigrationProject

List

dms:ListMigrationProjects,
dms:DescribeMigrationProjects,
dms:ListTagsForResource