data_providers

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

Overview

Name	data_providers
Type	Resource
Id	aws.dms.data_providers

Fields

The following fields are returned by SELECT queries:

describe_data_providers

Name	Datatype	Description
data_providers	array	A description of data providers.
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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_data_providers	select	region		Returns a paginated list of data providers for your account in the current region. Required permissions: dms:ListDataProviders. For more information, see Actions, resources, and condition keys for Database Migration Service.
create_data_provider	insert	region, Engine, Settings		Creates a data provider using the provided settings. A data provider stores a data store type and location information about your database. Required permissions: dms:CreateDataProvider. For more information, see Actions, resources, and condition keys for Database Migration Service.
modify_data_provider	update	region, DataProviderIdentifier		Modifies the specified data provider using the provided settings. Required permissions: dms:UpdateDataProvider. For more information, see Actions, resources, and condition keys for Database Migration Service. You must remove the data provider from all migration projects before you can modify it.
delete_data_provider	delete	region		Deletes the specified data provider. Required permissions: dms:DeleteDataProvider. For more information, see Actions, resources, and condition keys for Database Migration Service. All migration projects associated with the data provider must be deleted or modified before you can delete the data provider.

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_data_providers

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

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

INSERT examples

create_data_provider

Creates a data provider using the provided settings. A data provider stores a data store type and location information about your database. Required permissions: dms:CreateDataProvider. For more information, see Actions, resources, and condition keys for Database Migration Service.

INSERT INTO aws.dms.data_providers (
DataProviderName,
Description,
Engine,
Virtual,
Settings,
Tags,
region
)
SELECT 
'{{ DataProviderName }}',
'{{ Description }}',
'{{ Engine }}' /* required */,
{{ Virtual }},
'{{ Settings }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
data_provider
;

Manifest

# Description fields are for documentation purposes
- name: data_providers
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the data_providers resource.
  - name: DataProviderName
    value: "{{ DataProviderName }}"
    description: |
      A user-friendly name for the data provider.
  - name: Description
    value: "{{ Description }}"
    description: |
      A user-friendly description of the data provider.
  - name: Engine
    value: "{{ Engine }}"
    description: |
      The type of database engine for the data provider. Valid values: aurora, aurora-postgresql, db2, db2-zos, docdb, mariadb, mongodb, mysql, oracle, postgres, redshift, sqlserver, and sybase. A value of aurora represents Amazon Aurora MySQL-Compatible Edition.
  - name: Virtual
    value: {{ Virtual }}
    description: |
      Indicates whether the data provider is virtual.
  - name: Settings
    description: |
      The settings in JSON format for a data provider.
    value:
      RedshiftSettings:
        ServerName: "{{ ServerName }}"
        Port: {{ Port }}
        DatabaseName: "{{ DatabaseName }}"
        S3Path: "{{ S3Path }}"
        S3AccessRoleArn: "{{ S3AccessRoleArn }}"
      PostgreSqlSettings:
        ServerName: "{{ ServerName }}"
        Port: {{ Port }}
        DatabaseName: "{{ DatabaseName }}"
        SslMode: "{{ SslMode }}"
        CertificateArn: "{{ CertificateArn }}"
        S3Path: "{{ S3Path }}"
        S3AccessRoleArn: "{{ S3AccessRoleArn }}"
      MySqlSettings:
        ServerName: "{{ ServerName }}"
        Port: {{ Port }}
        SslMode: "{{ SslMode }}"
        CertificateArn: "{{ CertificateArn }}"
        S3Path: "{{ S3Path }}"
        S3AccessRoleArn: "{{ S3AccessRoleArn }}"
      OracleSettings:
        ServerName: "{{ ServerName }}"
        Port: {{ Port }}
        DatabaseName: "{{ DatabaseName }}"
        SslMode: "{{ SslMode }}"
        CertificateArn: "{{ CertificateArn }}"
        AsmServer: "{{ AsmServer }}"
        SecretsManagerOracleAsmSecretId: "{{ SecretsManagerOracleAsmSecretId }}"
        SecretsManagerOracleAsmAccessRoleArn: "{{ SecretsManagerOracleAsmAccessRoleArn }}"
        SecretsManagerSecurityDbEncryptionSecretId: "{{ SecretsManagerSecurityDbEncryptionSecretId }}"
        SecretsManagerSecurityDbEncryptionAccessRoleArn: "{{ SecretsManagerSecurityDbEncryptionAccessRoleArn }}"
        S3Path: "{{ S3Path }}"
        S3AccessRoleArn: "{{ S3AccessRoleArn }}"
      SybaseAseSettings:
        ServerName: "{{ ServerName }}"
        Port: {{ Port }}
        DatabaseName: "{{ DatabaseName }}"
        SslMode: "{{ SslMode }}"
        EncryptPassword: {{ EncryptPassword }}
        CertificateArn: "{{ CertificateArn }}"
      MicrosoftSqlServerSettings:
        ServerName: "{{ ServerName }}"
        Port: {{ Port }}
        DatabaseName: "{{ DatabaseName }}"
        SslMode: "{{ SslMode }}"
        CertificateArn: "{{ CertificateArn }}"
        S3Path: "{{ S3Path }}"
        S3AccessRoleArn: "{{ S3AccessRoleArn }}"
      DocDbSettings:
        ServerName: "{{ ServerName }}"
        Port: {{ Port }}
        DatabaseName: "{{ DatabaseName }}"
        SslMode: "{{ SslMode }}"
        CertificateArn: "{{ CertificateArn }}"
      MariaDbSettings:
        ServerName: "{{ ServerName }}"
        Port: {{ Port }}
        SslMode: "{{ SslMode }}"
        CertificateArn: "{{ CertificateArn }}"
        S3Path: "{{ S3Path }}"
        S3AccessRoleArn: "{{ S3AccessRoleArn }}"
      IbmDb2LuwSettings:
        ServerName: "{{ ServerName }}"
        Port: {{ Port }}
        DatabaseName: "{{ DatabaseName }}"
        SslMode: "{{ SslMode }}"
        CertificateArn: "{{ CertificateArn }}"
        EncryptionAlgorithm: {{ EncryptionAlgorithm }}
        SecurityMechanism: {{ SecurityMechanism }}
        S3Path: "{{ S3Path }}"
        S3AccessRoleArn: "{{ S3AccessRoleArn }}"
      IbmDb2zOsSettings:
        ServerName: "{{ ServerName }}"
        Port: {{ Port }}
        DatabaseName: "{{ DatabaseName }}"
        SslMode: "{{ SslMode }}"
        CertificateArn: "{{ CertificateArn }}"
        S3Path: "{{ S3Path }}"
        S3AccessRoleArn: "{{ S3AccessRoleArn }}"
      MongoDbSettings:
        ServerName: "{{ ServerName }}"
        Port: {{ Port }}
        DatabaseName: "{{ DatabaseName }}"
        SslMode: "{{ SslMode }}"
        CertificateArn: "{{ CertificateArn }}"
        AuthType: "{{ AuthType }}"
        AuthSource: "{{ AuthSource }}"
        AuthMechanism: "{{ AuthMechanism }}"
  - name: Tags
    description: |
      One or more tags to be assigned to the data provider.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
        ResourceArn: "{{ ResourceArn }}"

UPDATE examples

modify_data_provider

Modifies the specified data provider using the provided settings. Required permissions: dms:UpdateDataProvider. For more information, see Actions, resources, and condition keys for Database Migration Service. You must remove the data provider from all migration projects before you can modify it.

UPDATE aws.dms.data_providers
SET 
DataProviderIdentifier = '{{ DataProviderIdentifier }}',
DataProviderName = '{{ DataProviderName }}',
Description = '{{ Description }}',
Engine = '{{ Engine }}',
Virtual = {{ Virtual }},
ExactSettings = {{ ExactSettings }},
Settings = '{{ Settings }}'
WHERE 
region = '{{ region }}' --required
AND DataProviderIdentifier = '{{ DataProviderIdentifier }}' --required
RETURNING
data_provider;

DELETE examples

delete_data_provider

Deletes the specified data provider. Required permissions: dms:DeleteDataProvider. For more information, see Actions, resources, and condition keys for Database Migration Service. All migration projects associated with the data provider must be deleted or modified before you can delete the data provider.

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