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	awscc.dms.migration_projects

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
migration_project_arn	string	The property describes an ARN of the migration project.
region	string	AWS region.

For more information, see AWS::DMS::MigrationProject.

Methods

Name	Resource	Accessible by	Required Params
create_resource	migration_projects	INSERT	region
delete_resource	migration_projects	DELETE	Identifier, region
update_resource	migration_projects	UPDATE	Identifier, PatchDocument, region
list_resources	migration_projects_list_only	SELECT	region
get_resource	migration_projects	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.dms.migration_projects
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ migration_project_arn }}';

list (identifiers only)

Lists all migration_projects in a region.

SELECT
  region,
  migration_project_arn
FROM awscc.dms.migration_projects_list_only
WHERE
  region = '{{ region }}';

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 awscc.dms.migration_projects (
  MigrationProjectName,
  MigrationProjectIdentifier,
  MigrationProjectCreationTime,
  InstanceProfileIdentifier,
  InstanceProfileName,
  InstanceProfileArn,
  TransformationRules,
  Description,
  SchemaConversionApplicationAttributes,
  SourceDataProviderDescriptors,
  TargetDataProviderDescriptors,
  Tags,
  region
)
SELECT
  '{{ migration_project_name }}',
  '{{ migration_project_identifier }}',
  '{{ 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 }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.dms.migration_projects (
  MigrationProjectName,
  MigrationProjectIdentifier,
  MigrationProjectCreationTime,
  InstanceProfileIdentifier,
  InstanceProfileName,
  InstanceProfileArn,
  TransformationRules,
  Description,
  SchemaConversionApplicationAttributes,
  SourceDataProviderDescriptors,
  TargetDataProviderDescriptors,
  Tags,
  region
)
SELECT
  '{{ migration_project_name }}',
  '{{ migration_project_identifier }}',
  '{{ 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 }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: migration_project
  props:
    - name: migration_project_name
      value: '{{ migration_project_name }}'
    - name: migration_project_identifier
      value: '{{ migration_project_identifier }}'
    - name: migration_project_creation_time
      value: '{{ migration_project_creation_time }}'
    - name: instance_profile_identifier
      value: '{{ instance_profile_identifier }}'
    - name: instance_profile_name
      value: '{{ instance_profile_name }}'
    - name: instance_profile_arn
      value: '{{ instance_profile_arn }}'
    - name: transformation_rules
      value: '{{ transformation_rules }}'
    - name: description
      value: '{{ description }}'
    - name: schema_conversion_application_attributes
      value:
        s3_bucket_path: '{{ s3_bucket_path }}'
        s3_bucket_role_arn: '{{ s3_bucket_role_arn }}'
    - name: source_data_provider_descriptors
      value:
        - data_provider_identifier: '{{ data_provider_identifier }}'
          data_provider_name: '{{ data_provider_name }}'
          data_provider_arn: '{{ data_provider_arn }}'
          secrets_manager_secret_id: '{{ secrets_manager_secret_id }}'
          secrets_manager_access_role_arn: '{{ secrets_manager_access_role_arn }}'
    - name: target_data_provider_descriptors
      value:
        - null
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.dms.migration_projects
SET PatchDocument = string('{{ {
    "MigrationProjectName": migration_project_name,
    "MigrationProjectIdentifier": migration_project_identifier,
    "MigrationProjectCreationTime": migration_project_creation_time,
    "InstanceProfileIdentifier": instance_profile_identifier,
    "InstanceProfileName": instance_profile_name,
    "InstanceProfileArn": instance_profile_arn,
    "TransformationRules": transformation_rules,
    "Description": description,
    "SchemaConversionApplicationAttributes": schema_conversion_application_attributes,
    "SourceDataProviderDescriptors": source_data_provider_descriptors,
    "TargetDataProviderDescriptors": target_data_provider_descriptors,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ migration_project_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.dms.migration_projects
WHERE
  Identifier = '{{ migration_project_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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:RemoveTagsFromResource,
dms:ListTagsForResource,
iam:PassRole

Delete

dms:DeleteMigrationProject

List

dms:ListMigrationProjects,
dms:DescribeMigrationProjects,
dms:ListTagsForResource