data_providers

Creates, updates, deletes or gets a data_provider resource or lists data_providers in a region

Overview

Name	data_providers
Type	Resource
Description	Resource schema for AWS::DMS::DataProvider
Id	aws.dms.data_providers

Fields

Name	Datatype	Description
data_provider_name	string	The property describes a name to identify the data provider.
data_provider_identifier	string	The property describes an identifier for the data provider. It is used for describing/deleting/modifying can be name/arn
data_provider_arn	string	The data provider ARN.
data_provider_creation_time	string	The data provider creation time.
description	string	The optional description of the data provider.
engine	string	The property describes a data engine for the data provider.
exact_settings	boolean	The property describes the exact settings which can be modified
settings	object	The property identifies the exact type of settings for the data provider.
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	Engine, 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 data_providers in a region.

SELECT
region,
data_provider_name,
data_provider_identifier,
data_provider_arn,
data_provider_creation_time,
description,
engine,
exact_settings,
settings,
tags
FROM aws.dms.data_providers
WHERE region = 'us-east-1';

Gets all properties from an individual data_provider.

SELECT
region,
data_provider_name,
data_provider_identifier,
data_provider_arn,
data_provider_creation_time,
description,
engine,
exact_settings,
settings,
tags
FROM aws.dms.data_providers
WHERE region = 'us-east-1' AND data__Identifier = '<DataProviderArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.dms.data_providers (
 Engine,
 region
)
SELECT 
'{{ Engine }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.dms.data_providers (
 DataProviderName,
 DataProviderIdentifier,
 Description,
 Engine,
 ExactSettings,
 Settings,
 Tags,
 region
)
SELECT 
 '{{ DataProviderName }}',
 '{{ DataProviderIdentifier }}',
 '{{ Description }}',
 '{{ Engine }}',
 '{{ ExactSettings }}',
 '{{ Settings }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: data_provider
    props:
      - name: DataProviderName
        value: '{{ DataProviderName }}'
      - name: DataProviderIdentifier
        value: '{{ DataProviderIdentifier }}'
      - name: Description
        value: '{{ Description }}'
      - name: Engine
        value: '{{ Engine }}'
      - name: ExactSettings
        value: '{{ ExactSettings }}'
      - name: Settings
        value:
          PostgreSqlSettings:
            ServerName: '{{ ServerName }}'
            Port: '{{ Port }}'
            DatabaseName: '{{ DatabaseName }}'
            SslMode: '{{ SslMode }}'
            CertificateArn: '{{ CertificateArn }}'
          MySqlSettings:
            ServerName: '{{ ServerName }}'
            Port: '{{ Port }}'
            SslMode: null
            CertificateArn: '{{ CertificateArn }}'
          OracleSettings:
            ServerName: '{{ ServerName }}'
            Port: '{{ Port }}'
            DatabaseName: '{{ DatabaseName }}'
            SslMode: null
            CertificateArn: '{{ CertificateArn }}'
            AsmServer: '{{ AsmServer }}'
            SecretsManagerOracleAsmSecretId: '{{ SecretsManagerOracleAsmSecretId }}'
            SecretsManagerOracleAsmAccessRoleArn: '{{ SecretsManagerOracleAsmAccessRoleArn }}'
            SecretsManagerSecurityDbEncryptionSecretId: '{{ SecretsManagerSecurityDbEncryptionSecretId }}'
            SecretsManagerSecurityDbEncryptionAccessRoleArn: '{{ SecretsManagerSecurityDbEncryptionAccessRoleArn }}'
          MicrosoftSqlServerSettings:
            ServerName: '{{ ServerName }}'
            Port: '{{ Port }}'
            DatabaseName: '{{ DatabaseName }}'
            SslMode: null
            CertificateArn: '{{ CertificateArn }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

dms:CreateDataProvider,
dms:ListDataProviders,
dms:DescribeDataProviders,
dms:AddTagsToResource,
dms:ListTagsForResource

Read

dms:ListDataProviders,
dms:DescribeDataProviders,
dms:ListTagsForResource

Update

dms:UpdateDataProvider,
dms:ModifyDataProvider,
dms:AddTagsToResource,
dms:RemoveTagsToResource,
dms:ListTagsForResource

Delete

dms:DeleteDataProvider

List

dms:ListDataProviders,
dms:DescribeDataProviders,
dms:ListTagsForResource