Primeur Online Docs
Data Mover 1.20
Data Mover 1.20
  • 🚀GETTING STARTED
    • What is Primeur Data Mover
    • Main features of Primeur Data Mover
    • Primeur Data Mover deployment
    • Navigate through Primeur Data Mover
  • 👥Actors
    • Who are the actors
    • Create your first actor
    • Configure an actor 🚀
      • Users Tab
      • Groups Tab
      • VFS Tab
      • File Resource Tab
      • Connection Contract Tab
      • Client Connections Tab
    • Search files by actor
    • Actor Lineage 🚀
      • Aggregation of flows by protocol 🚀
      • Lineage with connection contracts 🚀
      • Lineage with input, mediation and output contracts 🚀
      • Lineage with any contract type 🚀
  • 🗄️VIRTUAL FILE SYSTEMS
    • Virtual File Systems (VFS) 🚀
      • Creating a VFS 🚀
      • Configuring a VFS
      • Adding Virtual Paths
      • Modifying and Deleting a VFS
    • Searching files in all VFS
    • Storage Classes 🚀
      • Storage Class: SMB v3 or later versions 🚀
      • Storage Class: Azure Blob Storage 🚀
      • Storage Class: Amazon S3 🚀
      • Storage Class: Google Storage 🚀
      • Storage Class: Local File System 🚀
    • Retention Classes
  • 📝Contracts
    • What is a contract
    • Create your first contract
      • Create an Input Contract
        • Define the contract info
        • Associate the contract with the actor
        • Define the contract actions
        • Set the contract variables
      • Create a Mediation Contract
      • Create an Output Contract
      • Create a Connection Contract
        • Create a contract clause
        • Associate the VFS with file processing rules
        • File Processing Rules
    • Managing contracts 🚀
    • File Resources
      • Creating File Resources
      • Navigating File Resources
      • How to use File Resources
  • 🧱Workflows
    • What is a workflow
    • Create your first workflow template
    • Trigger types
      • Trigger types for input contracts
      • Trigger types for mediation and output contracts
    • Service tasks
      • Standard service tasks
      • Triggerable service tasks 🚀
      • Spazio selectors and filebox metadata management
      • Error management
    • Variables
      • Variables in workflows and contracts
      • Handling process variables
    • Workflow templates
      • System workflow templates
        • Workflow templates for input contracts
        • Workflow templates for mediation contracts
        • Workflow templates for output contracts
      • Custom workflow templates
        • Workflow template toolbar
        • Workflow template Shape repository panel
        • Workflow template working area
        • Workflow template BPMN-diagram panel
      • Error workflow templates
    • Editing workflow templates
    • DataFlow Instance Context (DFIC) 🚀
  • 🧑‍⚖️FILE ROUTING
    • What is File Routing 🚀
    • Routing Rules
      • The Rules tab
      • The Categories tab
      • The Output tab
    • How to create a rule 🚀
      • Add metadata 🚀
      • Select ACTIONS
      • Select OUTPUTS
      • Policy for the selection of metadata rules
    • Configuration of the environment in Data One
      • Set up Storage Classes
      • Set up Retention Classes
      • Configure the Actor
      • Set up File Resources
    • Associate the Routing Rule with a Contract
    • Example
  • 🔓Security
    • Identity and Access Management
    • Users & Groups
      • Setting the password policy
      • Creating Internal Users 🚀
      • Creating Internal Groups
      • Creating External Users
      • Creating External Groups
    • Key Stores and Trust Stores
      • Key Store 🚀
        • Creating a Key 🚀
        • Creating a Certificate 🚀
        • Importing a Key or a Certificate
        • Creating a Symmetric key
        • Examples
      • Trust Store 🚀
        • Importing Keys 🚀
        • Importing Certificates
      • Untrusted Cache 🚀
      • Trusting Keys and Certificates
      • PGP Key Store and PGP Trust Store
        • PGP Key Store
        • Importing keys into the PGP Trust Store
    • ICAP
      • Configuring ICAP
      • Defining an ICAP rule
  • 🛸TRANSPORT PROTOCOLS AND CONNECTORS
    • Data Mover client and server roles
    • Client Connections
      • Client Connection: FTP
      • Client Connection: FTPS
      • Client Connection: SFTP
      • Client Connection: HTTP
      • Client Connection: HTTPS
      • Client Connection: PESIT
      • Client Connection: SMB v3 or later versions
      • Client Connection: POP3 or IMAP
      • Client Connection: SMTP
      • Client Connection: PR4/PR4S
      • Client Connection: PR5
      • Client Connection: PR5S
      • Client Connection: HDFS
      • Client Connection: HDFSS
      • Client Connection: Amazon S3 🚀
      • Client Connection: Google Cloud Storage
        • Credentials
      • Client Connection: Azure Blob Storage
      • Client Connection: IBM Sterling Connect:Direct
      • Appendix
    • Server Connections 🚀
      • Server Connection: FTP
      • Server Connection: FTPS
      • Server Connection: SFTP
      • Server Connection: HTTP
      • Server Connection: HTTPS
      • Server Connection: PeSIT
      • Server Connection: PR4
      • Server Connection: PR5
      • Server Connection: PR5S 🚀
      • Server Connection: IBM Sterling Connect:Direct
    • Stopping all servers in one go
  • 🎧FILE EVENT LISTENER
    • What is the File Event Listener
    • Configuring File Event Listeners
      • Setting the File Event Listener Engine
      • Defining a contract for the File Event Listener
      • Setting events to be monitored
    • RegEx Rules 🚀
    • Monitoring File Event Listeners
  • 📚INFRASTRUCTURE
    • STENG, Clusters and Servers
    • Adding a cluster and a STENG
    • Deleting a STENG
    • DMZ Gateways
    • DMZ Clusters
  • 🕒MONITORING
    • Jobs
      • Details about Jobs 🚀
      • jobman.sh CLI
    • Job Manager
    • Job Queues
      • Managing Job Queues
    • File Transfers
      • Ongoing
      • Finished
      • Reports
    • File Transfers Rules
      • Configuring Rules
  • 👑FILE MANAGER
    • What is the File Manager
    • Logging into File Manager
    • Managing the File Manager 🚀
      • The list of results
      • Creating new folders
      • Uploading files
      • Downloading files 🚀
      • Searching for files and folders
      • Deleting files 🚀
      • Bulk actions 🚀
    • File Manager and VFS
    • Customizing File Manager externals
      • The configuration-wui.json file 🚀
      • How to customize the Login window and the logo
      • How to customize the footer
      • How to configure the Upload with Metadata option
      • How to customize bulk actions 🚀
  • 💬LOGS & AUDIT
    • Logs 🚀
      • Logs options 🚀
      • Troubleshooting error analysis in Logs
    • Audit Options 🚀
      • Export audit logs 🚀
      • List of Audit entity types 🚀
      • Audit message codes 🚀
    • Log Notifiers 🚀
      • FEL message codes
  • 📩NOTIFICATION CHANNELS
    • What are Notification Channels
    • Configuring the default Email Notification Channel
    • Configuring a new Email Notification Channel
    • Trusting Certificates
    • Managing Templates
      • Data Watcher Macros
      • Contract Macros
      • ICAP Macros
      • Central Log Macros
      • Email Templates
      • Editing default templates
      • Loading a new template
  • 💻API
    • HTTP MFT Rest API
    • Job Manager APIs 🚀
    • SFTP Server sessions APIs 🚀
    • Audit Logs APIs 🚀
  • 🧐HOW TO...
    • ... use different DNS names - NEW! 🚀
    • ... configure a Cron Expression
    • ... configure an Application
    • ... customize a header
    • ... run searches in Data Watcher 🚀
    • ... use Data Shaper graphs in Data Mover contracts
    • ... modify DMCFG and deploy it
    • ... tune Data One data retention
    • ... fine tune Data Mover
  • 🗒️RELEASE NOTES
    • Data One 1.20.10
    • Data One 1.20.9
    • Data One 1.20.8
    • Data One 1.20.7
      • Data One 1.20.7.1
    • Data One 1.20.6
    • Data One 1.20.5
    • Data One 1.20.4
    • Data One 1.20.3
    • Data One 1.20.2
    • Data One 1.20.1
    • Data One 1.20.0
Powered by GitBook
On this page
  1. TRANSPORT PROTOCOLS AND CONNECTORS
  2. Client Connections

Client Connection: Amazon S3 🚀

Fields with the asterisk * are mandatory.

Properties
Description

NAME *

Name of the Amazon S3 connection you are creating. The maximum number of characters is 128. Blanks and these special characters: ' " | are not supported.

DESCRIPTION

Description of the Amazon S3 connection you are creating. The maximum number of characters is 2048.

STATUS

Enable or disable the client connection. Possible values:

  • Enabled (default value)

  • Disabled

CONNECTION TIMEOUT

Number of seconds without network activity to wait before closing a session due to inactivity. Default value: 60.

AUTHENTICATION TYPE

Select if authentication occurs with Access Key (BASIC) or with Security Token Service (STS):

  • BASIC (default)

ACCESS KEY ID *

This field appears when BASIC is selected. Enter the AWS access key ID.

SECRET ACCESS KEY *

This field appears when BASIC is selected. Enter the AWS secret access key.

ROLE ARN *

This field appears when STS is selected. Enter the role’s Amazon Resource Name (ARN). Format: arn:partition:service:region:namespace:relative-id

ROLE SESSION NAME *

This field appears when STS is selected. Enter the unique identifier role session name.

BUCKET NAME *

Enter the name of the S3 bucket. The minimum number of characters is 3 and the maximum is 63. Blanks are not supported.

REGION *

Select the Region of the S3 bucket specified in the BUCKET NAME field.

ENDPOINT URL

UPLOAD PART SIZE *

This is the size of each part in a multipart upload. By default, it is set to 5 MB. 🚀 The maximum value is 5000 MB. Multipart upload allows uploading an object (file) as a set of parts. Once uploaded, the object will be available as a unique part. This facilitates the upload, especially in case of pause and resume.

MAX RETRIES

Maximum number of retries. If this field is empty or set to 0, no retries will be executed and the job will be set to Failed if the first attempt is not successful. A high value corresponds to a high number of retrying attempts.

RETRY INTERVAL

This field will appear only if you have set the maximum numbers of retries to 1 or greater. Time (in seconds) waited before retrying executing a job. The lower the value, the more frequent the retrying attempts. If this field is empty or set to 0, no retries will be executed and the job will be set to Failed if the first attempt is not successful.

CONFIGURATION TEST

Understanding and managing Amazon S3 STS authentication

STS (Security Token Service) is an authentication mode that gives the user temporary access to use S3 API based on permissions given by another user’s credentials.

For example: user Anne has permission to upload and download a file. If user Bob connects using STS based on Anne’s credentials, Bob will have the same permissions as Anne.

Let’s see the steps to follow to authenticate with STS:

  1. Using the AWS console, add a new role or edit an existing one:

  1. Trust entities that can assume the role and the access conditions for the role. To do so, use the Edit Trust Relationship and configure the role:

  1. Update the existing json with a custom one. Here is an example:

{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"AWS": "arn:aws:iam::account_id:user/user_name"
},
"Action": "sts:AssumeRole"
}
]
}

Where:

  • account_id is the id of the user account in the aws console

  • user_name is the login of the user in the aws console

  1. In PRIMEUR Data One, update the global configuration adding basic user credential properties on the existing ghibli-speng-centralnode module and create a new s3 section.

Role name and role session name parameters are also needed. The role name is the Amazon Resource Name (ARN) of the role to assume. This information is available in the AWS Console:

The format used is arn:aws:iam::account_id:role/role_name. Where:

  • account_id is the id of the user account in the aws console

  • role_name is the name of the assumed role

The role session name is an identifier for the assumed role session.

PreviousClient Connection: HDFSSNextClient Connection: Google Cloud Storage

Last updated 21 hours ago

STS (Security Token Service) The STS authentication mode gives the user temporary access to use S3 api based on permissions given by credentials of another user. For example, if user A has permissions to upload and download a file, user B that connects using STS based on credentials of user A will inherit the same privileges. To learn more about STS authentication, please refer to below.

Enter the URL serving as the endpoint for the S3-compatible endpoint. When populated with a valid URL, this endpoint allows connections to S3-compatible storage services not provided by AWS. It is recommended to leave this field blank for standard AWS S3 connections. If you leave this parameter blank, the default AWS S3 endpoint for the above specified Region will be automatically determined and used. Otherwise, a valid Amazon AWS S3 URL or the URL of a non-AWS S3-compatible service provider must be provided. If you are connecting to an HTTPS endpoint, your S3 service provider's certificates must be imported into Data One Trust Store going to Setup → Trust Store → Certificates. 🚀 In case you are using AWS over HTTPS, the certificates to be imported can be download from this page: .

Use this section to test that the Cluster and the STENG are connected correctly. Select a Cluster and a STENG you want to test and click the TEST button. Data One automatically selects a Cluster and a STENG to test the connection. Note that a Cluster will be selected only if it is the only one available. A message with a green check will confirm a successful connection. A message with a red exclamation mark will warn about an unsuccessful connection. The message also details the reason why the connection fails. The connection might not be successful for different reasons, each of them depending on the transport type and the configuration. The first time you try to test the connection, if trusting certificates are missing, an error message detailing the unsuccessful connection will appear. In this case, go to the Setup → Untrusted Cache → Certificates tab and trust the relevant certificates. Note that trusting certificates in the Untrusted Cache page may not be sufficient to establish a successful connection. Refer to the section of this documentation for all the details.

🛸
https://www.amazontrust.com/repository/
Untrusted Cache
Understanding and managing Amazon S3 STS authentication