Amazon S3

Version 24.1.8910


Amazon S3


You can use the Amazon S3 connector from the CData Sync application to move data from any supported source to the Amazon S3 destination. To do so, you need to add the connector, authenticate to the connector, and complete your connection.

Add the Amazon S3 Connector

To enable Sync to use data from Amazon S3, you first must add the connector, as follows:

  1. Open the Connections page of the Sync dashboard.

  2. Click Add Connection to open the Select Connectors page.

  3. Click the Destinations tab and locate the Amazon S3 row.

  4. Click the Configure Connection icon at the end of that row to open the New Connection page. If the Configure Connection icon is not available, click the Download Connector icon to install the Amazon S3 connector. For more information about installing new connectors, see Connections.

Authenticate to Amazon S3

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

  • Connection Name - Enter a connection name of your choice.

  • Bucket - Enter the name of the bucket to which you want to replicate data.

CData Sync supports authenticating to Amazon S3 in several ways. Select your authentication method below to proceed to the relevant section that contains the authentication details.

AwsRootKeys

To connect with your account root credentials, specify the following properties:

  • Auth Scheme - Select AwsRootKeys.

  • AWS Access Key - Enter the access key that is associated with your Amazon Web Services (AWS) account. This value is accessible from your AWS security credentials page.

  • AWS Secret Key - Enter the secret key that is associated with your AWS account. This value is accessible from your AWS security credentials page.

ADFS

To connect with single sign-on (SSO) via ADFS, specify the following properties:

  • Auth Scheme - Select ADFS.

  • User - Enter the username that you use to authenticate to ADFS.

  • Password - Enter the password that you use to authenticate to ADFS.

  • SSO Login URL - Enter the login URL that is used by your SSO provider.

AwsIAMRoles

To connect with your IAM user credentials, specify the following properties:

  • Auth Scheme - Select AwsIAMRoles.

  • AWS Access Key - Enter the Amazon Web Services access key for the IAM user role that you want to assume.

  • AWS Secret Key - Enter the Amazon Web Services secret key for the IAM user role that you want to assume.

  • AWS Role ARN - Enter the Amazon Resource Name (ARN) for the role with which you want to authenticate.

  • AWS External Id - Enter the unique identifier that is required when you assume a role in another account.

AWS EC2 Roles

When you run CData Sync on an EC2 instance, CData Sync can authenticate by using the IAM role that is assigned to the instance. Select AwsEC2Roles for Auth Scheme to use that role. No additional properties are required.

AwsMFA

To connect with your multifactor-authentication credentials, specify the following properties:

  • Auth Scheme - Select AwsMFA.

  • MFA Serial Number - Enter the serial number for your multifactor authentication (MFA) device, if you are using such a device.

  • MFA Token - Enter the temporary token that is available from your MFA device.

  • Temporary Token Duration - Enter the temporary token duration that you want for your temporary token. The default duration (in seconds) is 3600.

AWS Credentials File

To connect with a credentials file, specify the following properties:

  • Auth Scheme - Select AwsCredentialsFile.

  • AWS Credentials File - Enter the location of your Amazon Web Services (AWS) credentials file.

  • AWS Credentials File Profile (optional) - 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, Sync uses the profile named default.

Okta

To connect with single sign-on (SSO) via Okta, specify the following properties:

  • Auth Scheme - Select Okta.

  • User - Enter the username that you use to authenticate to Okta.

  • Password - Enter the password that you use to authenticate to Okta.

  • SSO Login URL - Enter the login URL that is used by your SSO provider.

  • SSO Properties - Enter the SSO properties (in a comma-separated list) that you want to use.

PingFederate

To connect with single sign-on via PingFederate, specify the following properties:

  • Auth Scheme - Select PingFederate.

  • User - Enter the username that you use to authenticate to PingFederate.

  • Password - Enter the password that you use to authenticate to PingFederate.

  • SSO Login URL - Enter the login URL that is used by your SSO provider.

  • SSO Properties - Enter the SSO properties (in a comma-separated list) that you want to use.

  • SSO Exchange Url - Enter the Partner Service Identifier URI that is configured in your PingFederate server instance. The URI is available under SP Connections > SP Connection > WS-Trust > Protocol Settings.

AwsCognitoBasic

To connect with your Amazon Web Services (AWS) Cognito credentials, specify the following properties:

  • Auth Scheme - Select AwsCognitoBasic.

  • AWS Cognito Region - Select the region for your user pool.

  • AWS User Pool Id - Enter your Amazon Web Services (AWS) user-pool Id.

  • AWS User Pool Client App Id - Enter your AWS user-pool client application Id.

  • AWS Identity Pool Id - Enter the identity-pool Id of the that is linked with your user pool.

  • AWS User Pool Client App Secret - Enter the secret for your user-pool client.

AwsCognitoSrp

To connect with your Amazon Web Services (AWS) Cognito credentials, specify the following properties:

  • Auth Scheme - Select AwsCognitoSrp.

  • AWS Cognito Region - Select the region for your user pool.

  • AWS User Pool Id - Enter your Amazon Web Services (AWS) user-pool Id.

  • AWS User Pool Client App Id - Enter your AWS user-pool client application Id.

  • AWS Identity Pool Id - Enter the identity-pool Id of the that is linked with your user pool.

  • AWS User Pool Client App Secret - Enter the secret for your user-pool client.

Complete Your Connection

To complete your connection:

  1. Specify these settings:

    • AWS Region - Select the hosting region for Amazon Web Services.

    • File Format - Select the file format that you want to use. CData Sync supports the CSV, PARQUET, and AVRO file formats.

  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

For more information about interactions between CData Sync and Amazon S3, see Amazon S3 Connector for CData Sync.