This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::DMS::DataProvider
<a name="aws-resource-dms-dataprovider"></a>

Provides information that defines a data provider.

## Syntax
<a name="aws-resource-dms-dataprovider-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-dms-dataprovider-syntax.json"></a>

```
{
  "Type" : "AWS::DMS::DataProvider",
  "Properties" : {
      "[DataProviderIdentifier](#cfn-dms-dataprovider-dataprovideridentifier)" : String,
      "[DataProviderName](#cfn-dms-dataprovider-dataprovidername)" : String,
      "[Description](#cfn-dms-dataprovider-description)" : String,
      "[Engine](#cfn-dms-dataprovider-engine)" : String,
      "[ExactSettings](#cfn-dms-dataprovider-exactsettings)" : Boolean,
      "[Settings](#cfn-dms-dataprovider-settings)" : Settings,
      "[Tags](#cfn-dms-dataprovider-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-dms-dataprovider-syntax.yaml"></a>

```
Type: AWS::DMS::DataProvider
Properties:
  [DataProviderIdentifier](#cfn-dms-dataprovider-dataprovideridentifier): String
  [DataProviderName](#cfn-dms-dataprovider-dataprovidername): String
  [Description](#cfn-dms-dataprovider-description): String
  [Engine](#cfn-dms-dataprovider-engine): String
  [ExactSettings](#cfn-dms-dataprovider-exactsettings): Boolean
  [Settings](#cfn-dms-dataprovider-settings): 
    Settings
  [Tags](#cfn-dms-dataprovider-tags): 
    - Tag
```

## Properties
<a name="aws-resource-dms-dataprovider-properties"></a>

`DataProviderIdentifier`  <a name="cfn-dms-dataprovider-dataprovideridentifier"></a>
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.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DataProviderName`  <a name="cfn-dms-dataprovider-dataprovidername"></a>
The name of the data provider.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-dms-dataprovider-description"></a>
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.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Engine`  <a name="cfn-dms-dataprovider-engine"></a>
The type of database engine for the data provider. Valid values include `"aurora"`, `"aurora-postgresql"`, `"mysql"`, `"oracle"`, `"postgres"`, `"sqlserver"`, `redshift`, `mariadb`, `mongodb`, `db2`, `db2-zos`, `docdb`, and `sybase`. A value of `"aurora"` represents Amazon Aurora MySQL-Compatible Edition.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `aurora | aurora_postgresql | mysql | oracle | postgres | sqlserver | redshift | mariadb | mongodb | docdb | db2 | db2_zos | sybase`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExactSettings`  <a name="cfn-dms-dataprovider-exactsettings"></a>
Property description not available.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Settings`  <a name="cfn-dms-dataprovider-settings"></a>
The settings in JSON format for a data provider.  
*Required*: No  
*Type*: [Settings](aws-properties-dms-dataprovider-settings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-dms-dataprovider-tags"></a>
Property description not available.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-dms-dataprovider-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-dms-dataprovider-return-values"></a>

### Ref
<a name="aws-resource-dms-dataprovider-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-dms-dataprovider-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-dms-dataprovider-return-values-fn--getatt-fn--getatt"></a>

`DataProviderArn`  <a name="DataProviderArn-fn::getatt"></a>
The Amazon Resource Name (ARN) string that uniquely identifies the data provider.

`DataProviderCreationTime`  <a name="DataProviderCreationTime-fn::getatt"></a>
The time the data provider was created.

# AWS::DMS::DataProvider DocDbSettings
<a name="aws-properties-dms-dataprovider-docdbsettings"></a>

Provides information that defines a DocumentDB endpoint.

## Syntax
<a name="aws-properties-dms-dataprovider-docdbsettings-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dms-dataprovider-docdbsettings-syntax.json"></a>

```
{
  "[CertificateArn](#cfn-dms-dataprovider-docdbsettings-certificatearn)" : String,
  "[DatabaseName](#cfn-dms-dataprovider-docdbsettings-databasename)" : String,
  "[Port](#cfn-dms-dataprovider-docdbsettings-port)" : Integer,
  "[ServerName](#cfn-dms-dataprovider-docdbsettings-servername)" : String,
  "[SslMode](#cfn-dms-dataprovider-docdbsettings-sslmode)" : String
}
```

### YAML
<a name="aws-properties-dms-dataprovider-docdbsettings-syntax.yaml"></a>

```
  [CertificateArn](#cfn-dms-dataprovider-docdbsettings-certificatearn): String
  [DatabaseName](#cfn-dms-dataprovider-docdbsettings-databasename): String
  [Port](#cfn-dms-dataprovider-docdbsettings-port): Integer
  [ServerName](#cfn-dms-dataprovider-docdbsettings-servername): String
  [SslMode](#cfn-dms-dataprovider-docdbsettings-sslmode): String
```

## Properties
<a name="aws-properties-dms-dataprovider-docdbsettings-properties"></a>

`CertificateArn`  <a name="cfn-dms-dataprovider-docdbsettings-certificatearn"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DatabaseName`  <a name="cfn-dms-dataprovider-docdbsettings-databasename"></a>
 The database name on the DocumentDB source endpoint.   
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Port`  <a name="cfn-dms-dataprovider-docdbsettings-port"></a>
 The port value for the DocumentDB source endpoint.   
*Required*: Yes  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ServerName`  <a name="cfn-dms-dataprovider-docdbsettings-servername"></a>
 The name of the server on the DocumentDB source endpoint.   
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SslMode`  <a name="cfn-dms-dataprovider-docdbsettings-sslmode"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Allowed values*: `none | require | verify-full`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DMS::DataProvider IbmDb2LuwSettings
<a name="aws-properties-dms-dataprovider-ibmdb2luwsettings"></a>

<a name="aws-properties-dms-dataprovider-ibmdb2luwsettings-description"></a>The `IbmDb2LuwSettings` property type specifies Property description not available. for an [AWS::DMS::DataProvider](aws-resource-dms-dataprovider.md).

## Syntax
<a name="aws-properties-dms-dataprovider-ibmdb2luwsettings-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dms-dataprovider-ibmdb2luwsettings-syntax.json"></a>

```
{
  "[CertificateArn](#cfn-dms-dataprovider-ibmdb2luwsettings-certificatearn)" : String,
  "[DatabaseName](#cfn-dms-dataprovider-ibmdb2luwsettings-databasename)" : String,
  "[Port](#cfn-dms-dataprovider-ibmdb2luwsettings-port)" : Integer,
  "[ServerName](#cfn-dms-dataprovider-ibmdb2luwsettings-servername)" : String,
  "[SslMode](#cfn-dms-dataprovider-ibmdb2luwsettings-sslmode)" : String
}
```

### YAML
<a name="aws-properties-dms-dataprovider-ibmdb2luwsettings-syntax.yaml"></a>

```
  [CertificateArn](#cfn-dms-dataprovider-ibmdb2luwsettings-certificatearn): String
  [DatabaseName](#cfn-dms-dataprovider-ibmdb2luwsettings-databasename): String
  [Port](#cfn-dms-dataprovider-ibmdb2luwsettings-port): Integer
  [ServerName](#cfn-dms-dataprovider-ibmdb2luwsettings-servername): String
  [SslMode](#cfn-dms-dataprovider-ibmdb2luwsettings-sslmode): String
```

## Properties
<a name="aws-properties-dms-dataprovider-ibmdb2luwsettings-properties"></a>

`CertificateArn`  <a name="cfn-dms-dataprovider-ibmdb2luwsettings-certificatearn"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DatabaseName`  <a name="cfn-dms-dataprovider-ibmdb2luwsettings-databasename"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Port`  <a name="cfn-dms-dataprovider-ibmdb2luwsettings-port"></a>
Property description not available.  
*Required*: Yes  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ServerName`  <a name="cfn-dms-dataprovider-ibmdb2luwsettings-servername"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SslMode`  <a name="cfn-dms-dataprovider-ibmdb2luwsettings-sslmode"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `none | verify-ca`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DMS::DataProvider IbmDb2zOsSettings
<a name="aws-properties-dms-dataprovider-ibmdb2zossettings"></a>

<a name="aws-properties-dms-dataprovider-ibmdb2zossettings-description"></a>The `IbmDb2zOsSettings` property type specifies Property description not available. for an [AWS::DMS::DataProvider](aws-resource-dms-dataprovider.md).

## Syntax
<a name="aws-properties-dms-dataprovider-ibmdb2zossettings-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dms-dataprovider-ibmdb2zossettings-syntax.json"></a>

```
{
  "[CertificateArn](#cfn-dms-dataprovider-ibmdb2zossettings-certificatearn)" : String,
  "[DatabaseName](#cfn-dms-dataprovider-ibmdb2zossettings-databasename)" : String,
  "[Port](#cfn-dms-dataprovider-ibmdb2zossettings-port)" : Integer,
  "[ServerName](#cfn-dms-dataprovider-ibmdb2zossettings-servername)" : String,
  "[SslMode](#cfn-dms-dataprovider-ibmdb2zossettings-sslmode)" : String
}
```

### YAML
<a name="aws-properties-dms-dataprovider-ibmdb2zossettings-syntax.yaml"></a>

```
  [CertificateArn](#cfn-dms-dataprovider-ibmdb2zossettings-certificatearn): String
  [DatabaseName](#cfn-dms-dataprovider-ibmdb2zossettings-databasename): String
  [Port](#cfn-dms-dataprovider-ibmdb2zossettings-port): Integer
  [ServerName](#cfn-dms-dataprovider-ibmdb2zossettings-servername): String
  [SslMode](#cfn-dms-dataprovider-ibmdb2zossettings-sslmode): String
```

## Properties
<a name="aws-properties-dms-dataprovider-ibmdb2zossettings-properties"></a>

`CertificateArn`  <a name="cfn-dms-dataprovider-ibmdb2zossettings-certificatearn"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DatabaseName`  <a name="cfn-dms-dataprovider-ibmdb2zossettings-databasename"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Port`  <a name="cfn-dms-dataprovider-ibmdb2zossettings-port"></a>
Property description not available.  
*Required*: Yes  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ServerName`  <a name="cfn-dms-dataprovider-ibmdb2zossettings-servername"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SslMode`  <a name="cfn-dms-dataprovider-ibmdb2zossettings-sslmode"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `none | verify-ca`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DMS::DataProvider MariaDbSettings
<a name="aws-properties-dms-dataprovider-mariadbsettings"></a>

<a name="aws-properties-dms-dataprovider-mariadbsettings-description"></a>The `MariaDbSettings` property type specifies Property description not available. for an [AWS::DMS::DataProvider](aws-resource-dms-dataprovider.md).

## Syntax
<a name="aws-properties-dms-dataprovider-mariadbsettings-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dms-dataprovider-mariadbsettings-syntax.json"></a>

```
{
  "[CertificateArn](#cfn-dms-dataprovider-mariadbsettings-certificatearn)" : String,
  "[Port](#cfn-dms-dataprovider-mariadbsettings-port)" : Integer,
  "[ServerName](#cfn-dms-dataprovider-mariadbsettings-servername)" : String,
  "[SslMode](#cfn-dms-dataprovider-mariadbsettings-sslmode)" : String
}
```

### YAML
<a name="aws-properties-dms-dataprovider-mariadbsettings-syntax.yaml"></a>

```
  [CertificateArn](#cfn-dms-dataprovider-mariadbsettings-certificatearn): String
  [Port](#cfn-dms-dataprovider-mariadbsettings-port): Integer
  [ServerName](#cfn-dms-dataprovider-mariadbsettings-servername): String
  [SslMode](#cfn-dms-dataprovider-mariadbsettings-sslmode): String
```

## Properties
<a name="aws-properties-dms-dataprovider-mariadbsettings-properties"></a>

`CertificateArn`  <a name="cfn-dms-dataprovider-mariadbsettings-certificatearn"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Port`  <a name="cfn-dms-dataprovider-mariadbsettings-port"></a>
Property description not available.  
*Required*: Yes  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ServerName`  <a name="cfn-dms-dataprovider-mariadbsettings-servername"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SslMode`  <a name="cfn-dms-dataprovider-mariadbsettings-sslmode"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `none | require | verify-ca | verify-full`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DMS::DataProvider MicrosoftSqlServerSettings
<a name="aws-properties-dms-dataprovider-microsoftsqlserversettings"></a>

Provides information that defines a Microsoft SQL Server endpoint.

## Syntax
<a name="aws-properties-dms-dataprovider-microsoftsqlserversettings-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dms-dataprovider-microsoftsqlserversettings-syntax.json"></a>

```
{
  "[CertificateArn](#cfn-dms-dataprovider-microsoftsqlserversettings-certificatearn)" : String,
  "[DatabaseName](#cfn-dms-dataprovider-microsoftsqlserversettings-databasename)" : String,
  "[Port](#cfn-dms-dataprovider-microsoftsqlserversettings-port)" : Integer,
  "[ServerName](#cfn-dms-dataprovider-microsoftsqlserversettings-servername)" : String,
  "[SslMode](#cfn-dms-dataprovider-microsoftsqlserversettings-sslmode)" : String
}
```

### YAML
<a name="aws-properties-dms-dataprovider-microsoftsqlserversettings-syntax.yaml"></a>

```
  [CertificateArn](#cfn-dms-dataprovider-microsoftsqlserversettings-certificatearn): String
  [DatabaseName](#cfn-dms-dataprovider-microsoftsqlserversettings-databasename): String
  [Port](#cfn-dms-dataprovider-microsoftsqlserversettings-port): Integer
  [ServerName](#cfn-dms-dataprovider-microsoftsqlserversettings-servername): String
  [SslMode](#cfn-dms-dataprovider-microsoftsqlserversettings-sslmode): String
```

## Properties
<a name="aws-properties-dms-dataprovider-microsoftsqlserversettings-properties"></a>

`CertificateArn`  <a name="cfn-dms-dataprovider-microsoftsqlserversettings-certificatearn"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DatabaseName`  <a name="cfn-dms-dataprovider-microsoftsqlserversettings-databasename"></a>
Database name for the endpoint.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Port`  <a name="cfn-dms-dataprovider-microsoftsqlserversettings-port"></a>
Endpoint TCP port.  
*Required*: Yes  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ServerName`  <a name="cfn-dms-dataprovider-microsoftsqlserversettings-servername"></a>
Fully qualified domain name of the endpoint. For an Amazon RDS SQL Server instance, this is the output of [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html), in the `[Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html).Address` field.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SslMode`  <a name="cfn-dms-dataprovider-microsoftsqlserversettings-sslmode"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `none | require | verify-ca | verify-full`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DMS::DataProvider MongoDbSettings
<a name="aws-properties-dms-dataprovider-mongodbsettings"></a>

Provides information that defines a MongoDB endpoint.

## Syntax
<a name="aws-properties-dms-dataprovider-mongodbsettings-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dms-dataprovider-mongodbsettings-syntax.json"></a>

```
{
  "[AuthMechanism](#cfn-dms-dataprovider-mongodbsettings-authmechanism)" : String,
  "[AuthSource](#cfn-dms-dataprovider-mongodbsettings-authsource)" : String,
  "[AuthType](#cfn-dms-dataprovider-mongodbsettings-authtype)" : String,
  "[CertificateArn](#cfn-dms-dataprovider-mongodbsettings-certificatearn)" : String,
  "[DatabaseName](#cfn-dms-dataprovider-mongodbsettings-databasename)" : String,
  "[Port](#cfn-dms-dataprovider-mongodbsettings-port)" : Integer,
  "[ServerName](#cfn-dms-dataprovider-mongodbsettings-servername)" : String,
  "[SslMode](#cfn-dms-dataprovider-mongodbsettings-sslmode)" : String
}
```

### YAML
<a name="aws-properties-dms-dataprovider-mongodbsettings-syntax.yaml"></a>

```
  [AuthMechanism](#cfn-dms-dataprovider-mongodbsettings-authmechanism): String
  [AuthSource](#cfn-dms-dataprovider-mongodbsettings-authsource): String
  [AuthType](#cfn-dms-dataprovider-mongodbsettings-authtype): String
  [CertificateArn](#cfn-dms-dataprovider-mongodbsettings-certificatearn): String
  [DatabaseName](#cfn-dms-dataprovider-mongodbsettings-databasename): String
  [Port](#cfn-dms-dataprovider-mongodbsettings-port): Integer
  [ServerName](#cfn-dms-dataprovider-mongodbsettings-servername): String
  [SslMode](#cfn-dms-dataprovider-mongodbsettings-sslmode): String
```

## Properties
<a name="aws-properties-dms-dataprovider-mongodbsettings-properties"></a>

`AuthMechanism`  <a name="cfn-dms-dataprovider-mongodbsettings-authmechanism"></a>
 The authentication mechanism you use to access the MongoDB source endpoint.  
For the default value, in MongoDB version 2.x, `"default"` is `"mongodb_cr"`. For MongoDB version 3.x or later, `"default"` is `"scram_sha_1"`. This setting isn't used when `AuthType` is set to `"no"`.  
*Required*: No  
*Type*: String  
*Allowed values*: `default | mongodb_cr | scram_sha_1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AuthSource`  <a name="cfn-dms-dataprovider-mongodbsettings-authsource"></a>
 The MongoDB database name. This setting isn't used when `AuthType` is set to `"no"`.   
The default is `"admin"`.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AuthType`  <a name="cfn-dms-dataprovider-mongodbsettings-authtype"></a>
 The authentication type you use to access the MongoDB source endpoint.  
When when set to `"no"`, user name and password parameters are not used and can be empty.   
*Required*: No  
*Type*: String  
*Allowed values*: `no | password`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CertificateArn`  <a name="cfn-dms-dataprovider-mongodbsettings-certificatearn"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DatabaseName`  <a name="cfn-dms-dataprovider-mongodbsettings-databasename"></a>
 The database name on the MongoDB source endpoint.   
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Port`  <a name="cfn-dms-dataprovider-mongodbsettings-port"></a>
 The port value for the MongoDB source endpoint.   
*Required*: Yes  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ServerName`  <a name="cfn-dms-dataprovider-mongodbsettings-servername"></a>
 The name of the server on the MongoDB source endpoint. For MongoDB Atlas, provide the server name for any of the servers in the replication set.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SslMode`  <a name="cfn-dms-dataprovider-mongodbsettings-sslmode"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Allowed values*: `none | require | verify-full`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DMS::DataProvider MySqlSettings
<a name="aws-properties-dms-dataprovider-mysqlsettings"></a>

Provides information that defines a MySQL endpoint.

## Syntax
<a name="aws-properties-dms-dataprovider-mysqlsettings-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dms-dataprovider-mysqlsettings-syntax.json"></a>

```
{
  "[CertificateArn](#cfn-dms-dataprovider-mysqlsettings-certificatearn)" : String,
  "[Port](#cfn-dms-dataprovider-mysqlsettings-port)" : Integer,
  "[ServerName](#cfn-dms-dataprovider-mysqlsettings-servername)" : String,
  "[SslMode](#cfn-dms-dataprovider-mysqlsettings-sslmode)" : String
}
```

### YAML
<a name="aws-properties-dms-dataprovider-mysqlsettings-syntax.yaml"></a>

```
  [CertificateArn](#cfn-dms-dataprovider-mysqlsettings-certificatearn): String
  [Port](#cfn-dms-dataprovider-mysqlsettings-port): Integer
  [ServerName](#cfn-dms-dataprovider-mysqlsettings-servername): String
  [SslMode](#cfn-dms-dataprovider-mysqlsettings-sslmode): String
```

## Properties
<a name="aws-properties-dms-dataprovider-mysqlsettings-properties"></a>

`CertificateArn`  <a name="cfn-dms-dataprovider-mysqlsettings-certificatearn"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Port`  <a name="cfn-dms-dataprovider-mysqlsettings-port"></a>
Endpoint TCP port.  
*Required*: Yes  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ServerName`  <a name="cfn-dms-dataprovider-mysqlsettings-servername"></a>
The host name of the endpoint database.   
For an Amazon RDS MySQL instance, this is the output of [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html), in the `[Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html).Address` field.  
For an Aurora MySQL instance, this is the output of [DescribeDBClusters](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.html), in the `Endpoint` field.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SslMode`  <a name="cfn-dms-dataprovider-mysqlsettings-sslmode"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `none | require | verify-ca | verify-full`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DMS::DataProvider OracleSettings
<a name="aws-properties-dms-dataprovider-oraclesettings"></a>

Provides information that defines an Oracle endpoint.

## Syntax
<a name="aws-properties-dms-dataprovider-oraclesettings-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dms-dataprovider-oraclesettings-syntax.json"></a>

```
{
  "[AsmServer](#cfn-dms-dataprovider-oraclesettings-asmserver)" : String,
  "[CertificateArn](#cfn-dms-dataprovider-oraclesettings-certificatearn)" : String,
  "[DatabaseName](#cfn-dms-dataprovider-oraclesettings-databasename)" : String,
  "[Port](#cfn-dms-dataprovider-oraclesettings-port)" : Integer,
  "[SecretsManagerOracleAsmAccessRoleArn](#cfn-dms-dataprovider-oraclesettings-secretsmanageroracleasmaccessrolearn)" : String,
  "[SecretsManagerOracleAsmSecretId](#cfn-dms-dataprovider-oraclesettings-secretsmanageroracleasmsecretid)" : String,
  "[SecretsManagerSecurityDbEncryptionAccessRoleArn](#cfn-dms-dataprovider-oraclesettings-secretsmanagersecuritydbencryptionaccessrolearn)" : String,
  "[SecretsManagerSecurityDbEncryptionSecretId](#cfn-dms-dataprovider-oraclesettings-secretsmanagersecuritydbencryptionsecretid)" : String,
  "[ServerName](#cfn-dms-dataprovider-oraclesettings-servername)" : String,
  "[SslMode](#cfn-dms-dataprovider-oraclesettings-sslmode)" : String
}
```

### YAML
<a name="aws-properties-dms-dataprovider-oraclesettings-syntax.yaml"></a>

```
  [AsmServer](#cfn-dms-dataprovider-oraclesettings-asmserver): String
  [CertificateArn](#cfn-dms-dataprovider-oraclesettings-certificatearn): String
  [DatabaseName](#cfn-dms-dataprovider-oraclesettings-databasename): String
  [Port](#cfn-dms-dataprovider-oraclesettings-port): Integer
  [SecretsManagerOracleAsmAccessRoleArn](#cfn-dms-dataprovider-oraclesettings-secretsmanageroracleasmaccessrolearn): String
  [SecretsManagerOracleAsmSecretId](#cfn-dms-dataprovider-oraclesettings-secretsmanageroracleasmsecretid): String
  [SecretsManagerSecurityDbEncryptionAccessRoleArn](#cfn-dms-dataprovider-oraclesettings-secretsmanagersecuritydbencryptionaccessrolearn): String
  [SecretsManagerSecurityDbEncryptionSecretId](#cfn-dms-dataprovider-oraclesettings-secretsmanagersecuritydbencryptionsecretid): String
  [ServerName](#cfn-dms-dataprovider-oraclesettings-servername): String
  [SslMode](#cfn-dms-dataprovider-oraclesettings-sslmode): String
```

## Properties
<a name="aws-properties-dms-dataprovider-oraclesettings-properties"></a>

`AsmServer`  <a name="cfn-dms-dataprovider-oraclesettings-asmserver"></a>
For an Oracle source endpoint, your ASM server address. You can set this value from the `asm_server` value. You set `asm_server` as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see [Configuration for change data capture (CDC) on an Oracle source database](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration).  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CertificateArn`  <a name="cfn-dms-dataprovider-oraclesettings-certificatearn"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DatabaseName`  <a name="cfn-dms-dataprovider-oraclesettings-databasename"></a>
Database name for the endpoint.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Port`  <a name="cfn-dms-dataprovider-oraclesettings-port"></a>
Endpoint TCP port.  
*Required*: Yes  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SecretsManagerOracleAsmAccessRoleArn`  <a name="cfn-dms-dataprovider-oraclesettings-secretsmanageroracleasmaccessrolearn"></a>
Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the `SecretsManagerOracleAsmSecret`. This `SecretsManagerOracleAsmSecret` has the secret value that allows access to the Oracle ASM of the endpoint.  
You can specify one of two sets of values for these permissions. You can specify the values for this setting and `SecretsManagerOracleAsmSecretId`. Or you can specify clear-text values for `AsmUser`, `AsmPassword`, and `AsmServerName`. You can't specify both. For more information on creating this `SecretsManagerOracleAsmSecret` and the `SecretsManagerOracleAsmAccessRoleArn` and `SecretsManagerOracleAsmSecretId` required to access it, see [Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*.
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SecretsManagerOracleAsmSecretId`  <a name="cfn-dms-dataprovider-oraclesettings-secretsmanageroracleasmsecretid"></a>
Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN, partial ARN, or friendly name of the `SecretsManagerOracleAsmSecret` that contains the Oracle ASM connection details for the Oracle endpoint.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SecretsManagerSecurityDbEncryptionAccessRoleArn`  <a name="cfn-dms-dataprovider-oraclesettings-secretsmanagersecuritydbencryptionaccessrolearn"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SecretsManagerSecurityDbEncryptionSecretId`  <a name="cfn-dms-dataprovider-oraclesettings-secretsmanagersecuritydbencryptionsecretid"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ServerName`  <a name="cfn-dms-dataprovider-oraclesettings-servername"></a>
Fully qualified domain name of the endpoint.  
For an Amazon RDS Oracle instance, this is the output of [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html), in the `[Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html).Address` field.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SslMode`  <a name="cfn-dms-dataprovider-oraclesettings-sslmode"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `none | require | verify-ca | verify-full`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DMS::DataProvider PostgreSqlSettings
<a name="aws-properties-dms-dataprovider-postgresqlsettings"></a>

Provides information that defines a PostgreSQL endpoint.

## Syntax
<a name="aws-properties-dms-dataprovider-postgresqlsettings-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dms-dataprovider-postgresqlsettings-syntax.json"></a>

```
{
  "[CertificateArn](#cfn-dms-dataprovider-postgresqlsettings-certificatearn)" : String,
  "[DatabaseName](#cfn-dms-dataprovider-postgresqlsettings-databasename)" : String,
  "[Port](#cfn-dms-dataprovider-postgresqlsettings-port)" : Integer,
  "[ServerName](#cfn-dms-dataprovider-postgresqlsettings-servername)" : String,
  "[SslMode](#cfn-dms-dataprovider-postgresqlsettings-sslmode)" : String
}
```

### YAML
<a name="aws-properties-dms-dataprovider-postgresqlsettings-syntax.yaml"></a>

```
  [CertificateArn](#cfn-dms-dataprovider-postgresqlsettings-certificatearn): String
  [DatabaseName](#cfn-dms-dataprovider-postgresqlsettings-databasename): String
  [Port](#cfn-dms-dataprovider-postgresqlsettings-port): Integer
  [ServerName](#cfn-dms-dataprovider-postgresqlsettings-servername): String
  [SslMode](#cfn-dms-dataprovider-postgresqlsettings-sslmode): String
```

## Properties
<a name="aws-properties-dms-dataprovider-postgresqlsettings-properties"></a>

`CertificateArn`  <a name="cfn-dms-dataprovider-postgresqlsettings-certificatearn"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DatabaseName`  <a name="cfn-dms-dataprovider-postgresqlsettings-databasename"></a>
Database name for the endpoint.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Port`  <a name="cfn-dms-dataprovider-postgresqlsettings-port"></a>
Endpoint TCP port. The default is 5432.  
*Required*: Yes  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ServerName`  <a name="cfn-dms-dataprovider-postgresqlsettings-servername"></a>
The host name of the endpoint database.   
For an Amazon RDS PostgreSQL instance, this is the output of [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html), in the `[Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html).Address` field.  
For an Aurora PostgreSQL instance, this is the output of [DescribeDBClusters](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.html), in the `Endpoint` field.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SslMode`  <a name="cfn-dms-dataprovider-postgresqlsettings-sslmode"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `none | require | verify-ca | verify-full`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DMS::DataProvider RedshiftSettings
<a name="aws-properties-dms-dataprovider-redshiftsettings"></a>

Provides information that defines an Amazon Redshift endpoint.

## Syntax
<a name="aws-properties-dms-dataprovider-redshiftsettings-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dms-dataprovider-redshiftsettings-syntax.json"></a>

```
{
  "[DatabaseName](#cfn-dms-dataprovider-redshiftsettings-databasename)" : String,
  "[Port](#cfn-dms-dataprovider-redshiftsettings-port)" : Integer,
  "[ServerName](#cfn-dms-dataprovider-redshiftsettings-servername)" : String
}
```

### YAML
<a name="aws-properties-dms-dataprovider-redshiftsettings-syntax.yaml"></a>

```
  [DatabaseName](#cfn-dms-dataprovider-redshiftsettings-databasename): String
  [Port](#cfn-dms-dataprovider-redshiftsettings-port): Integer
  [ServerName](#cfn-dms-dataprovider-redshiftsettings-servername): String
```

## Properties
<a name="aws-properties-dms-dataprovider-redshiftsettings-properties"></a>

`DatabaseName`  <a name="cfn-dms-dataprovider-redshiftsettings-databasename"></a>
The name of the Amazon Redshift data warehouse (service) that you are working with.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Port`  <a name="cfn-dms-dataprovider-redshiftsettings-port"></a>
The port number for Amazon Redshift. The default value is 5439.  
*Required*: Yes  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ServerName`  <a name="cfn-dms-dataprovider-redshiftsettings-servername"></a>
The name of the Amazon Redshift cluster you are using.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DMS::DataProvider Settings
<a name="aws-properties-dms-dataprovider-settings"></a>

<a name="aws-properties-dms-dataprovider-settings-description"></a>The `Settings` property type specifies Property description not available. for an [AWS::DMS::DataProvider](aws-resource-dms-dataprovider.md).

## Syntax
<a name="aws-properties-dms-dataprovider-settings-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dms-dataprovider-settings-syntax.json"></a>

```
{
  "[DocDbSettings](#cfn-dms-dataprovider-settings-docdbsettings)" : DocDbSettings,
  "[IbmDb2LuwSettings](#cfn-dms-dataprovider-settings-ibmdb2luwsettings)" : IbmDb2LuwSettings,
  "[IbmDb2zOsSettings](#cfn-dms-dataprovider-settings-ibmdb2zossettings)" : IbmDb2zOsSettings,
  "[MariaDbSettings](#cfn-dms-dataprovider-settings-mariadbsettings)" : MariaDbSettings,
  "[MicrosoftSqlServerSettings](#cfn-dms-dataprovider-settings-microsoftsqlserversettings)" : MicrosoftSqlServerSettings,
  "[MongoDbSettings](#cfn-dms-dataprovider-settings-mongodbsettings)" : MongoDbSettings,
  "[MySqlSettings](#cfn-dms-dataprovider-settings-mysqlsettings)" : MySqlSettings,
  "[OracleSettings](#cfn-dms-dataprovider-settings-oraclesettings)" : OracleSettings,
  "[PostgreSqlSettings](#cfn-dms-dataprovider-settings-postgresqlsettings)" : PostgreSqlSettings,
  "[RedshiftSettings](#cfn-dms-dataprovider-settings-redshiftsettings)" : RedshiftSettings,
  "[SybaseAseSettings](#cfn-dms-dataprovider-settings-sybaseasesettings)" : SybaseAseSettings
}
```

### YAML
<a name="aws-properties-dms-dataprovider-settings-syntax.yaml"></a>

```
  [DocDbSettings](#cfn-dms-dataprovider-settings-docdbsettings): 
    DocDbSettings
  [IbmDb2LuwSettings](#cfn-dms-dataprovider-settings-ibmdb2luwsettings): 
    IbmDb2LuwSettings
  [IbmDb2zOsSettings](#cfn-dms-dataprovider-settings-ibmdb2zossettings): 
    IbmDb2zOsSettings
  [MariaDbSettings](#cfn-dms-dataprovider-settings-mariadbsettings): 
    MariaDbSettings
  [MicrosoftSqlServerSettings](#cfn-dms-dataprovider-settings-microsoftsqlserversettings): 
    MicrosoftSqlServerSettings
  [MongoDbSettings](#cfn-dms-dataprovider-settings-mongodbsettings): 
    MongoDbSettings
  [MySqlSettings](#cfn-dms-dataprovider-settings-mysqlsettings): 
    MySqlSettings
  [OracleSettings](#cfn-dms-dataprovider-settings-oraclesettings): 
    OracleSettings
  [PostgreSqlSettings](#cfn-dms-dataprovider-settings-postgresqlsettings): 
    PostgreSqlSettings
  [RedshiftSettings](#cfn-dms-dataprovider-settings-redshiftsettings): 
    RedshiftSettings
  [SybaseAseSettings](#cfn-dms-dataprovider-settings-sybaseasesettings): 
    SybaseAseSettings
```

## Properties
<a name="aws-properties-dms-dataprovider-settings-properties"></a>

`DocDbSettings`  <a name="cfn-dms-dataprovider-settings-docdbsettings"></a>
Property description not available.  
*Required*: No  
*Type*: [DocDbSettings](aws-properties-dms-dataprovider-docdbsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IbmDb2LuwSettings`  <a name="cfn-dms-dataprovider-settings-ibmdb2luwsettings"></a>
Property description not available.  
*Required*: No  
*Type*: [IbmDb2LuwSettings](aws-properties-dms-dataprovider-ibmdb2luwsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IbmDb2zOsSettings`  <a name="cfn-dms-dataprovider-settings-ibmdb2zossettings"></a>
Property description not available.  
*Required*: No  
*Type*: [IbmDb2zOsSettings](aws-properties-dms-dataprovider-ibmdb2zossettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MariaDbSettings`  <a name="cfn-dms-dataprovider-settings-mariadbsettings"></a>
Property description not available.  
*Required*: No  
*Type*: [MariaDbSettings](aws-properties-dms-dataprovider-mariadbsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MicrosoftSqlServerSettings`  <a name="cfn-dms-dataprovider-settings-microsoftsqlserversettings"></a>
Property description not available.  
*Required*: No  
*Type*: [MicrosoftSqlServerSettings](aws-properties-dms-dataprovider-microsoftsqlserversettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MongoDbSettings`  <a name="cfn-dms-dataprovider-settings-mongodbsettings"></a>
Property description not available.  
*Required*: No  
*Type*: [MongoDbSettings](aws-properties-dms-dataprovider-mongodbsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MySqlSettings`  <a name="cfn-dms-dataprovider-settings-mysqlsettings"></a>
Property description not available.  
*Required*: No  
*Type*: [MySqlSettings](aws-properties-dms-dataprovider-mysqlsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OracleSettings`  <a name="cfn-dms-dataprovider-settings-oraclesettings"></a>
Property description not available.  
*Required*: No  
*Type*: [OracleSettings](aws-properties-dms-dataprovider-oraclesettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PostgreSqlSettings`  <a name="cfn-dms-dataprovider-settings-postgresqlsettings"></a>
Property description not available.  
*Required*: No  
*Type*: [PostgreSqlSettings](aws-properties-dms-dataprovider-postgresqlsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RedshiftSettings`  <a name="cfn-dms-dataprovider-settings-redshiftsettings"></a>
Property description not available.  
*Required*: No  
*Type*: [RedshiftSettings](aws-properties-dms-dataprovider-redshiftsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SybaseAseSettings`  <a name="cfn-dms-dataprovider-settings-sybaseasesettings"></a>
Property description not available.  
*Required*: No  
*Type*: [SybaseAseSettings](aws-properties-dms-dataprovider-sybaseasesettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DMS::DataProvider SybaseAseSettings
<a name="aws-properties-dms-dataprovider-sybaseasesettings"></a>

<a name="aws-properties-dms-dataprovider-sybaseasesettings-description"></a>The `SybaseAseSettings` property type specifies Property description not available. for an [AWS::DMS::DataProvider](aws-resource-dms-dataprovider.md).

## Syntax
<a name="aws-properties-dms-dataprovider-sybaseasesettings-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dms-dataprovider-sybaseasesettings-syntax.json"></a>

```
{
  "[CertificateArn](#cfn-dms-dataprovider-sybaseasesettings-certificatearn)" : String,
  "[DatabaseName](#cfn-dms-dataprovider-sybaseasesettings-databasename)" : String,
  "[EncryptPassword](#cfn-dms-dataprovider-sybaseasesettings-encryptpassword)" : Boolean,
  "[Port](#cfn-dms-dataprovider-sybaseasesettings-port)" : Integer,
  "[ServerName](#cfn-dms-dataprovider-sybaseasesettings-servername)" : String,
  "[SslMode](#cfn-dms-dataprovider-sybaseasesettings-sslmode)" : String
}
```

### YAML
<a name="aws-properties-dms-dataprovider-sybaseasesettings-syntax.yaml"></a>

```
  [CertificateArn](#cfn-dms-dataprovider-sybaseasesettings-certificatearn): String
  [DatabaseName](#cfn-dms-dataprovider-sybaseasesettings-databasename): String
  [EncryptPassword](#cfn-dms-dataprovider-sybaseasesettings-encryptpassword): Boolean
  [Port](#cfn-dms-dataprovider-sybaseasesettings-port): Integer
  [ServerName](#cfn-dms-dataprovider-sybaseasesettings-servername): String
  [SslMode](#cfn-dms-dataprovider-sybaseasesettings-sslmode): String
```

## Properties
<a name="aws-properties-dms-dataprovider-sybaseasesettings-properties"></a>

`CertificateArn`  <a name="cfn-dms-dataprovider-sybaseasesettings-certificatearn"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DatabaseName`  <a name="cfn-dms-dataprovider-sybaseasesettings-databasename"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EncryptPassword`  <a name="cfn-dms-dataprovider-sybaseasesettings-encryptpassword"></a>
Property description not available.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Port`  <a name="cfn-dms-dataprovider-sybaseasesettings-port"></a>
Property description not available.  
*Required*: Yes  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ServerName`  <a name="cfn-dms-dataprovider-sybaseasesettings-servername"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SslMode`  <a name="cfn-dms-dataprovider-sybaseasesettings-sslmode"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `none | require | verify-ca`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DMS::DataProvider Tag
<a name="aws-properties-dms-dataprovider-tag"></a>

A user-defined key-value pair that describes metadata added to an AWS DMS resource and that is used by operations such as the following:
+  `AddTagsToResource` 
+  `ListTagsForResource` 
+  `RemoveTagsFromResource` 

## Syntax
<a name="aws-properties-dms-dataprovider-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dms-dataprovider-tag-syntax.json"></a>

```
{
  "[Key](#cfn-dms-dataprovider-tag-key)" : String,
  "[Value](#cfn-dms-dataprovider-tag-value)" : String
}
```

### YAML
<a name="aws-properties-dms-dataprovider-tag-syntax.yaml"></a>

```
  [Key](#cfn-dms-dataprovider-tag-key): String
  [Value](#cfn-dms-dataprovider-tag-value): String
```

## Properties
<a name="aws-properties-dms-dataprovider-tag-properties"></a>

`Key`  <a name="cfn-dms-dataprovider-tag-key"></a>
A key is the required name of the tag. The string value can be 1-128 Unicode characters in length and can't be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '\$1', '.', '/', '=', '\$1', '-' (Java regular expressions: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1").  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-dms-dataprovider-tag-value"></a>
A value is the optional value of the tag. The string value can be 1-256 Unicode characters in length and can't be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '\$1', '.', '/', '=', '\$1', '-' (Java regular expressions: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1").  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)