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

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
data_provider_arn	string	The data provider ARN.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	data_providers	INSERT	Engine, region
delete_resource	data_providers	DELETE	Identifier, region
update_resource	data_providers	UPDATE	Identifier, PatchDocument, region
list_resources	data_providers_list_only	SELECT	region
get_resource	data_providers	SELECT	Identifier, region

SELECT examples

get (all properties)

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

list (identifiers only)

Lists all data_providers in a region.

SELECT
  region,
  data_provider_arn
FROM awscc.dms.data_providers_list_only
WHERE
  region = '{{ region }}';

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 awscc.dms.data_providers (
  Engine,
  region
)
SELECT
  '{{ engine }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.dms.data_providers (
  DataProviderName,
  DataProviderIdentifier,
  Description,
  Engine,
  ExactSettings,
  Settings,
  Tags,
  region
)
SELECT
  '{{ data_provider_name }}',
  '{{ data_provider_identifier }}',
  '{{ description }}',
  '{{ engine }}',
  '{{ exact_settings }}',
  '{{ settings }}',
  '{{ 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: data_provider
  props:
    - name: data_provider_name
      value: '{{ data_provider_name }}'
    - name: data_provider_identifier
      value: '{{ data_provider_identifier }}'
    - name: description
      value: '{{ description }}'
    - name: engine
      value: '{{ engine }}'
    - name: exact_settings
      value: '{{ exact_settings }}'
    - name: settings
      value:
        postgre_sql_settings:
          server_name: '{{ server_name }}'
          port: '{{ port }}'
          database_name: '{{ database_name }}'
          ssl_mode: '{{ ssl_mode }}'
          certificate_arn: '{{ certificate_arn }}'
        my_sql_settings:
          server_name: '{{ server_name }}'
          port: '{{ port }}'
          ssl_mode: null
          certificate_arn: '{{ certificate_arn }}'
        oracle_settings:
          server_name: '{{ server_name }}'
          port: '{{ port }}'
          database_name: '{{ database_name }}'
          ssl_mode: null
          certificate_arn: '{{ certificate_arn }}'
          asm_server: '{{ asm_server }}'
          secrets_manager_oracle_asm_secret_id: '{{ secrets_manager_oracle_asm_secret_id }}'
          secrets_manager_oracle_asm_access_role_arn: '{{ secrets_manager_oracle_asm_access_role_arn }}'
          secrets_manager_security_db_encryption_secret_id: '{{ secrets_manager_security_db_encryption_secret_id }}'
          secrets_manager_security_db_encryption_access_role_arn: '{{ secrets_manager_security_db_encryption_access_role_arn }}'
        microsoft_sql_server_settings:
          server_name: '{{ server_name }}'
          port: '{{ port }}'
          database_name: '{{ database_name }}'
          ssl_mode: null
          certificate_arn: '{{ certificate_arn }}'
        redshift_settings:
          server_name: '{{ server_name }}'
          port: '{{ port }}'
          database_name: '{{ database_name }}'
        maria_db_settings:
          server_name: '{{ server_name }}'
          port: '{{ port }}'
          ssl_mode: null
          certificate_arn: '{{ certificate_arn }}'
        doc_db_settings:
          server_name: '{{ server_name }}'
          port: '{{ port }}'
          database_name: '{{ database_name }}'
          ssl_mode: '{{ ssl_mode }}'
          certificate_arn: '{{ certificate_arn }}'
        mongo_db_settings:
          server_name: '{{ server_name }}'
          port: '{{ port }}'
          database_name: '{{ database_name }}'
          ssl_mode: null
          certificate_arn: '{{ certificate_arn }}'
          auth_type: '{{ auth_type }}'
          auth_source: '{{ auth_source }}'
          auth_mechanism: '{{ auth_mechanism }}'
        ibm_db2_luw_settings:
          server_name: '{{ server_name }}'
          port: '{{ port }}'
          database_name: '{{ database_name }}'
          ssl_mode: '{{ ssl_mode }}'
          certificate_arn: '{{ certificate_arn }}'
        ibm_db2z_os_settings:
          server_name: '{{ server_name }}'
          port: '{{ port }}'
          database_name: '{{ database_name }}'
          ssl_mode: null
          certificate_arn: '{{ certificate_arn }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.dms.data_providers
SET PatchDocument = string('{{ {
    "DataProviderName": data_provider_name,
    "DataProviderIdentifier": data_provider_identifier,
    "Description": description,
    "Engine": engine,
    "ExactSettings": exact_settings,
    "Settings": settings,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ data_provider_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.dms.data_providers
WHERE
  Identifier = '{{ data_provider_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 data_providers resource, the following permissions are required:

Create

dms:CreateDataProvider,
dms:ListDataProviders,
dms:DescribeDataProviders,
dms:AddTagsToResource,
dms:ListTagsForResource,
iam:GetRole,
iam:PassRole

Read

dms:ListDataProviders,
dms:DescribeDataProviders,
dms:ListTagsForResource

Update

dms:UpdateDataProvider,
dms:ModifyDataProvider,
dms:AddTagsToResource,
dms:RemoveTagsFromResource,
dms:ListTagsForResource

Delete

dms:DeleteDataProvider

List

dms:ListDataProviders,
dms:DescribeDataProviders,
dms:ListTagsForResource