interface CfnDataProviderProps

Language	Type name
.NET	`Amazon.CDK.AWS.DMS.CfnDataProviderProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsdms#CfnDataProviderProps`
Java	`software.amazon.awscdk.services.dms.CfnDataProviderProps`
Python	`aws_cdk.aws_dms.CfnDataProviderProps`
TypeScript	`aws-cdk-lib` » `aws_dms` » `CfnDataProviderProps`

Properties for defining a CfnDataProvider.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_dms as dms } from 'aws-cdk-lib';
const cfnDataProviderProps: dms.CfnDataProviderProps = {
  engine: 'engine',

  // the properties below are optional
  dataProviderIdentifier: 'dataProviderIdentifier',
  dataProviderName: 'dataProviderName',
  description: 'description',
  exactSettings: false,
  settings: {
    microsoftSqlServerSettings: {
      databaseName: 'databaseName',
      port: 123,
      serverName: 'serverName',
      sslMode: 'sslMode',

      // the properties below are optional
      certificateArn: 'certificateArn',
    },
    mySqlSettings: {
      port: 123,
      serverName: 'serverName',
      sslMode: 'sslMode',

      // the properties below are optional
      certificateArn: 'certificateArn',
    },
    oracleSettings: {
      databaseName: 'databaseName',
      port: 123,
      serverName: 'serverName',
      sslMode: 'sslMode',

      // the properties below are optional
      asmServer: 'asmServer',
      certificateArn: 'certificateArn',
      secretsManagerOracleAsmAccessRoleArn: 'secretsManagerOracleAsmAccessRoleArn',
      secretsManagerOracleAsmSecretId: 'secretsManagerOracleAsmSecretId',
      secretsManagerSecurityDbEncryptionAccessRoleArn: 'secretsManagerSecurityDbEncryptionAccessRoleArn',
      secretsManagerSecurityDbEncryptionSecretId: 'secretsManagerSecurityDbEncryptionSecretId',
    },
    postgreSqlSettings: {
      databaseName: 'databaseName',
      port: 123,
      serverName: 'serverName',
      sslMode: 'sslMode',

      // the properties below are optional
      certificateArn: 'certificateArn',
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
engine	`string`	The type of database engine for the data provider.
dataProviderIdentifier?	`string`	The identifier of the data provider.
dataProviderName?	`string`	The name of the data provider.
description?	`string`	A description of the data provider.
exactSettings?	`boolean \|` `IResolvable`	The property describes the exact settings which can be modified.
settings?	`IResolvable` `\|` `SettingsProperty`	The settings in JSON format for a data provider.
tags?	`CfnTag[]`	An array of key-value pairs to apply to this resource.

engine

Type: string

The type of database engine for the data provider.

Valid values include "aurora" , "aurora-postgresql" , "mysql" , "oracle" , "postgres" , "sqlserver" , redshift , mariadb , mongodb , and docdb . A value of "aurora" represents Amazon Aurora MySQL-Compatible Edition.

dataProviderIdentifier?

Type: string (optional)

The identifier of the data provider.

Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.

dataProviderName?

Type: string (optional)

The name of the data provider.

description?

Type: string (optional)

A description of the data provider.

Descriptions can have up to 31 characters. A description can contain only ASCII letters, digits, and hyphens ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter.

exactSettings?

Type: boolean | IResolvable (optional, default: false)

The property describes the exact settings which can be modified.

settings?

Type: IResolvable | SettingsProperty (optional)

The settings in JSON format for a data provider.

tags?

Type: CfnTag[] (optional)

An array of key-value pairs to apply to this resource.