> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sync.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Amazon DynamoDB

export const CommonAuthSchemeAwscognitosrp = () => {
  return <>
      <p>To connect with your Amazon Web Services (AWS) Cognito credentials, specify the following properties:</p>
      <ul>
        <li><strong>Auth Scheme:</strong> Select <strong>AwsCognitoSrp</strong>.</li>
        <li><strong>User:</strong> Enter the username of the user that is registered in the user pool.</li>
        <li><strong>Password:</strong> Enter the password of the user that is registered in the user pool.</li>
        <li><strong>AWS Cognito Region:</strong> Select the hosting region for Amazon Web Services (AWS) Cognito. The default region is <strong>NORTHERNVIRGINIA</strong>.</li>
        <li><strong>AWS User Pool Id:</strong> Enter your AWS user-pool identifier (Id).</li>
        <li><strong>AWS User Pool Client App Id:</strong> Enter your AWS user-pool client application Id.</li>
        <li>(Optional) <strong>AWS User Pool Client App Secret:</strong> Enter the secret for your user-pool client.</li>
        <li><strong>AWS Region:</strong> Select the hosting region for your Amazon Web Services. The default region is <strong>NORTHERNVIRGINIA</strong>.</li>
      </ul>
    </>;
};

export const CommonAuthSchemeAwscognitobasic = () => {
  return <>
      <p>To connect with your Amazon Web Services (AWS) Cognito credentials, specify the following properties:</p>
      <ul>
        <li><strong>Auth Scheme:</strong> Select <strong>AwsCognitoBasic</strong>.</li>
        <li><strong>User:</strong> Enter the username of the user that is registered in the user pool.</li>
        <li><strong>Password:</strong> Enter the password of the user that is registered in the user pool.</li>
        <li><strong>AWS Cognito Region:</strong> Select the region for your Amazon Web Services (AWS) user pool. The default region is <strong>NORTHERNVIRGINIA</strong>.</li>
        <li><strong>AWS User Pool Id:</strong> Enter your AWS user-pool identifier (Id).</li>
        <li><strong>AWS User Pool Client App Id:</strong> Enter your AWS user-pool client application Id.</li>
        <li>(Optional) <strong>AWS User Pool Client App Secret:</strong> Enter the secret for your user-pool client.</li>
      </ul>
    </>;
};

export const CommonAuthSchemePingfederateSso = () => {
  return <>
      <p>To connect with single sign-on via PingFederate, specify the following properties:</p>
      <ul>
        <li><strong>Auth Scheme:</strong> Select <strong>PingFederate</strong>.</li>
        <li><strong>User:</strong> Enter the username that you use to authenticate to your PingFederate account.</li>
        <li><strong>Password:</strong> Enter the password that you use to authenticate to your PingFederate account.</li>
        <li><strong>SSO Login URL:</strong> Enter the login URL that is used by your SSO provider.</li>
        <li><strong>SSO Properties:</strong> Enter a comma-separated list of the single sign-on (SSO) properties that you want to use (for example, <em>SSOProperty1</em>=<em>Value1</em>;<em>SSOProperty2</em>=<em>Value2</em>;...).</li>
        <li><strong>SSO Exchange UrI:</strong> Enter the Partner Service Identifier URI that is configured in your PingFederate server instance. The URI is available under <strong>SP Connections &gt; SP Connection &gt; WS-Trust &gt; Protocol Settings</strong>.</li>
      </ul>
    </>;
};

export const CommonAuthSchemeOktaSso = ({siteName = "CData Sync", siteNameShort = "Sync", datasource = "the data source"}) => {
  return <>
      <p>To connect with single sign-on (SSO) via Okta, specify the following properties:</p>
      <ul>
        <li><strong>Auth Scheme:</strong> Select <strong>OKTA</strong>.</li>
        <li><strong>User:</strong> Enter the username that you use to authenticate to your Okta account.</li>
        <li><strong>Password:</strong> Enter the password that you use to authenticate to your Okta account.</li>
        <li><strong>SSO Login URL:</strong> Enter the login URL that is used by your SSO provider.</li>
        <li><strong>SSO Properties:</strong> Enter a semicolon-separated list of the single sign-on (SSO) properties that you want to use (for example, <em>SSOProperty1</em>=<em>Value1</em>;<em>SSOProperty2</em>=<em>Value2</em>;...).</li>
      </ul>
    </>;
};

export const CommonAuthSchemeAwscredentialsfile = ({siteName = "CData Sync", siteNameShort = "Sync", datasource = "the data source"}) => {
  return <>
      <p>To connect with a credentials file, specify the following properties:</p>
      <ul>
        <li><strong>Auth Scheme:</strong> Select <strong>AwsCredentialsFile</strong>.</li>
        <li><strong>AWS Credentials File:</strong> Enter the location of your Amazon Web Services (AWS) credentials file.</li>
        <li>(Optional) <strong>AWS Credentials File Profile:</strong> Enter the name of the AWS profile that you want to use from the credentials file that you specify. If you do not enter a profile name, {siteNameShort} uses the profile named <strong>default</strong>.</li>
      </ul>
    </>;
};

export const CommonAuthSchemeAwsmfa = () => {
  return <>
      <p>To connect with your multifactor authentication credentials, specify the following properties:</p>
      <ul>
        <li><strong>Auth Scheme:</strong> Select <strong>AwsMFA</strong>.</li>
        <li><strong>MFA Serial Number:</strong> Enter the serial number for your multifactor authentication (MFA) device, if you are using such a device.</li>
        <li><strong>MFA Token:</strong> Enter the temporary token that is available from your MFA device.</li>
        <li>(Optional) <strong>Temporary Token Duration:</strong> Enter the amount of time (in seconds) a temporary token will last. The default duration is <strong>3600</strong>.</li>
      </ul>
    </>;
};

export const CommonAuthSchemeAwsec2roles = ({siteName = "CData Sync", siteNameShort = "Sync", datasource = "the data source"}) => {
  return <>
      <p>
        When you run {siteName} on an EC2 instance, {siteName} can authenticate by using the IAM role that is assigned to the instance. Select <strong>AwsEC2Roles</strong> for <strong>Auth Scheme</strong> to use that role. No additional properties are required.
      </p>
    </>;
};

export const CommonAuthSchemeAwsiamroles = ({siteName = "CData Sync", siteNameShort = "Sync", datasource = "the data source"}) => {
  return <>
      <p>To connect with your IAM user credentials, specify the following properties:</p>
      <ul>
        <li><strong>Auth Scheme:</strong> Select <strong>AwsIAMRoles</strong>.</li>
        <li><strong>User:</strong> Enter the username that you use to authenticate to your {datasource} account.</li>
        <li><strong>AWS Access Key:</strong> Enter your Amazon Web Services (AWS) account access key. You can locate this value on your AWS security credentials page.</li>
        <li><strong>AWS Secret Key:</strong> Enter your AWS account secret key. You can locate this value on your AWS security credentials page.</li>
        <li><strong>AWS Role ARN:</strong> Enter the Amazon Resource Name (ARN) for the role with which you want to authenticate.</li>
        <li>(Optional) <strong>AWS External Id:</strong> Enter the unique identifier that is required when you assume a role in another account.</li>
      </ul>
    </>;
};

export const CommonAuthSchemeAwsrootkeys = ({siteName = "CData Sync", siteNameShort = "Sync", datasource = "the data source"}) => {
  return <>
      <p>To connect with your account root credentials, specify the following properties:</p>
      <ul>
        <li><strong>Auth Scheme:</strong> Select <strong>AwsRootKeys</strong>.</li>
        <li><strong>AWS Access Key:</strong> Enter your Amazon Web Services (AWS) account access key. You can locate this value on your AWS security credentials page.</li>
        <li><strong>AWS Secret Key:</strong> Enter your AWS account secret key. You can locate this value on your AWS security credentials page.</li>
      </ul>
    </>;
};

export const CommonAuthSchemeAdfsSso = () => {
  return <>
      <p>To connect with single sign-on (SSO) via ADFS, specify the following properties:</p>
      <ul>
        <li><strong>Auth Scheme:</strong> Select <strong>ADFS</strong>.</li>
        <li><strong>User:</strong> Enter the username that you use to authenticate to your ADFS account.</li>
        <li><strong>Password:</strong> Enter the password that you use to authenticate to your ADFS account.</li>
        <li><strong>SSO Login URL:</strong> Enter the login URL that is used by your SSO provider.</li>
        <li><strong>SSO Properties:</strong> Enter a semicolon-separated list of the single sign-on (SSO) properties that you want to use (for example, <em>SSOProperty1</em>=<em>Value1</em>;<em>SSOProperty2</em>=<em>Value2</em>;...).</li>
        <li><strong>SSO Exchange UrI:</strong> Enter the Partner Service Identifier URI that is configured in your PingFederate server instance. The URI is available under <strong>SP Connections &gt; SP Connection &gt; WS-Trust &gt; Protocol Settings</strong>.</li>
      </ul>
    </>;
};

export const CommonDatasourceMoreInformation = ({datasource = "the data source", advancedurl = "", siteName = "CData Sync", driverVersion = ""}) => {
  return <>
      <p>
        For more information about interactions between {siteName} and {datasource}, see{' '}
        <a href={`https://cdn.cdata.com/help/${advancedurl}${driverVersion}/synch/default.htm`}>
          {datasource} Connector for {siteName}
        </a>.
      </p>
    </>;
};

export const CommonDatasourceAddConnector = ({datasource = "the data source", title = "the connector", destination = false, siteNameShort = "Sync"}) => {
  return <>
      <p>
        To enable {siteNameShort} to use data from {datasource}, you first must add the
        connector, as follows:
      </p>
      <ol>
        <li>Open the <strong>Connections</strong> page of the {siteNameShort} dashboard.</li>
        <li>Click <strong>Add Connection</strong> to open the <strong>Select Connectors</strong> page.</li>
        <li>
          Click the <strong>{destination ? "Destinations" : "Sources"}</strong> tab and locate
          the <strong>{title}</strong> row.
        </li>
        <li>
          Click the <strong>Configure Connection</strong> icon at the end of that row to open
          the <strong>New Connection</strong> page. This action opens the{' '}
          <strong>Add Connection</strong> dialog box.
          <br />
          <strong>Note:</strong> If the <strong>Configure Connection</strong> icon is not
          available, click the <strong>Download Connector</strong> icon to install
          the {title} connector.
        </li>
        <li>Enter a name for your connection in the <strong>Add Connection</strong> dialog box.</li>
        <li>Click <strong>Add</strong> to open the <strong>Settings</strong> tab for your connector.</li>
      </ol>
      <p>
        For more information about installing new connectors, see{' '}
        <a href="../connections">Connections</a>.
      </p>
    </>;
};

export const CommonDatasourceIntroSource = ({datasource = "the data source", siteName = "CData Sync"}) => {
  return <p>
      You can use the {datasource} connector from the {siteName} application to capture data
      from {datasource} and move it to any supported destination. To do so, you need to add
      the connector, authenticate to the connector, and complete your connection.
    </p>;
};

export const driverVersion = "M";

export const siteNameShort = "Sync";

export const siteName = "CData Sync";

export const datasource = "Amazon DynamoDB";
export const pageTitle = "Amazon DynamoDB";
export const advancedurl = "DD";

<CommonDatasourceIntroSource datasource={datasource} siteName={siteName} />

## Add the Amazon DynamoDB Connector

<CommonDatasourceAddConnector datasource={datasource} title={pageTitle} destination={false} siteNameShort={siteNameShort} />

## Authenticate to Amazon DynamoDB

After you add the connector, you need to set the required properties.

{siteName} supports authenticating to {pageTitle} in several ways. Select your authentication method below to proceed to the relevant section that contains the authentication details.

* [**ADFS**](#active-directory-federation-services)
* [**Aws Root Keys**](#aws-root-keys) (default)
* [**Aws IAM Roles**](#aws-iam-roles)
* [**AwsEC2Roles**](#aws-ec2-roles)
* [**Aws Multifactor Authentication**](#aws-multifactor-authentication)
* [**Aws Credentials File**](#aws-credentials-file)
* [**Okta**](#okta)
* [**PingFederate**](#pingfederate)
* [**Aws Cognito Basic**](#aws-cognito-basic)
* [**Aws Cognito Secure Remote Password**](#aws-cognito-secure-remote-password)

### Active Directory Federation Services

<CommonAuthSchemeAdfsSso siteName={siteName} siteNameShort={siteNameShort} datasource={datasource} />

* (Optional) **Use Lake Formation:** Select **True** if you want the AWS Lake Formation service to retrieve temporary credentials. These temporary credentials enforce access policies against the user based on the configured IAM role. You can use this service when you authenticate through Okta, ADFS, and PingFederate, while providing a Security Assertion Markup Language (SAML) assertion. The default setting for **Use Lake Formation** is **False**.

### AWS Root Keys

<CommonAuthSchemeAwsrootkeys siteName={siteName} siteNameShort={siteNameShort} datasource={datasource} />

### AWS IAM Roles

<CommonAuthSchemeAwsiamroles siteName={siteName} siteNameShort={siteNameShort} datasource={datasource} />

### AWS EC2 Roles

<CommonAuthSchemeAwsec2roles siteName={siteName} siteNameShort={siteNameShort} datasource={datasource} />

### AWS Multifactor Authentication

<CommonAuthSchemeAwsmfa siteName={siteName} siteNameShort={siteNameShort} datasource={datasource} />

### AWS Credentials File

<CommonAuthSchemeAwscredentialsfile siteName={siteName} siteNameShort={siteNameShort} datasource={datasource} />

### Okta

<CommonAuthSchemeOktaSso siteName={siteName} siteNameShort={siteNameShort} datasource={datasource} />

* (Optional) **Use Lake Formation:** Select **True** if you want the AWS Lake Formation service to retrieve temporary credentials. These temporary credentials enforce access policies against the user based on the configured IAM role. You can use this service when you authenticate through Okta, ADFS, and PingFederate, while providing a Security Assertion Markup Language (SAML) assertion. The default setting for **Use Lake Formation** is **False**.

### PingFederate

<CommonAuthSchemePingfederateSso siteName={siteName} siteNameShort={siteNameShort} datasource={datasource} />

* (Optional) **Use Lake Formation:** Select **True** if you want the AWS Lake Formation service to retrieve temporary credentials. These temporary credentials enforce access policies against the user based on the configured IAM role. You can use this service when you authenticate through Okta, ADFS, and PingFederate, while providing a Security Assertion Markup Language (SAML) assertion. The default setting for **Use Lake Formation** is **False**.

### AWS Cognito Basic

<CommonAuthSchemeAwscognitobasic siteName={siteName} siteNameShort={siteNameShort} datasource={datasource} />

### AWS Cognito Secure Remote Password

<CommonAuthSchemeAwscognitosrp siteName={siteName} siteNameShort={siteNameShort} datasource={datasource} />

## Complete Your Connection

To complete your connection:

1. For **AWS Region**, select the region that hosts your Amazon Web Services. The default region is **NORTHERNVIRGINIA**.
2. Define advanced connection settings on the **Advanced** tab. (In most cases, though, you should not need these settings.)
3. Click **Create & Test** to create your connection.

## More Information

<CommonDatasourceMoreInformation datasource={datasource} advancedurl={advancedurl} siteName={siteName} driverVersion={driverVersion} />