Label*

Default Value:S3 File Writer
Example: S3 File Writer

Specify the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline.

File name*

Default Value: s3:///

Examples: 

• s3:///mybucket@s3.eu-west-1.amazonaws.com/test.json
• _filename (A key/value pair with "filename" key should be defined as a pipeline parameter)
• $filename (A key/value pair with "filename" key should be defined the input document)

s3:///<S3_bucket_name>@s3.<region_name>.amazonaws.com/<path>

{
        "filename": "s3:///mybucket/qatest/user_manual.json",
        "result": "overwritten",
        "original": {
            "content-type" : "application/json"
        }
    }

File action*

Default Value:OVERWRITE 
Example: IGNORE 

Specify the action to perform if the file already exists. The available options are:

• OVERWRITE - The Snap attempts to write the file without checking for the file's existence for a better performance, and the "fileAction" field will be "overwritten" in the output view data.
• IGNORE - The Snap will not overwrite the file and will do nothing but write the status and file name to its output view.
• ERROR-  The error displays in the Pipeline Run Log. If an error view is defined, the error will be written there as well.

s3:///<S3_bucket_name>@s3.<region_name>.amazonaws.com/<path>

write an empty file when the incoming binary document has empty data. If there is no incoming document at the input view of the Snap, no file is written regardless of the value of the property.

Write header file

Default Value: Deselected

Validate after write

DefaultValue: Deselected

Select this checkbox to

Write header file

Default Value: Deselected

Select this checkbox to write a header file whose name is generated by appending ".header" to the value of the File name property. The header file provides metadata about the file such as content disposition or content type. The same header information is also included in the output view data, as shown in the "Expected output" section above, under the key "original". 

The binary data stream in the input view may contain header information about the binary data in the form of a document with key-value pair data.

Validate after write

DefaultValue: Deselected

Select this checkbox to allow the Snap to check if the file exists after writing the file.

Number of retries

Minimum value: 0

allow the Snap to check if the file exists after writing the file.

Number of retries

Minimum value: 0

Default Value: 0
Example: 3

Retry interval (seconds)

Minimum value: 1

Default Value: 1
Example: 3

Specify the

minimum number of

seconds for which the Snap must

Retry interval (seconds)

Minimum value: 1

Default Value: 1
Example: 3

Specify the minimum number of seconds for which the Snap must wait before attempting recovery from a network failure.

Buffer size(MB)

Default Value: 10 MB

Specify the data (in MB) to load into the S3 bucket, at a time.

wait before attempting recovery from a network failure.

Buffer size(MB)

Default Value: 10 MB

Maximum upload threads

Default Value: 10
Example:3

Refer to Upload Part for more information on uploading to S3. 

Maximum upload threadsAWS Canned ACL

Default Value: 10None
Example: 3PublicRead

Specify the maximum number of threads to be used for the concurrent multipart upload. The minimum value allowed is 1.

AWS Canned ACL

Default Value: None
Example: PublicRead

The predefined ACL grants (from AWS) to use when writing a file to S3. Choose a Canned ACL from the available options:

• None
• Private
• PublicRead
• PublicReadWrite
• AuthenticatedRead
• LogDeliveryWrite
• BucketOwnerRead
• BucketOwnerFullControl
• AwsExecRead

Watch the video for more information about AWS Canned ACL.

Learn more about AWS Canned ACLs.

Access Control List

Use this field set to define the Access Control List (ACL) to the specified S3 file. This filed set contains the following fields:

• Grantee
• Read
• View permissions
• Full control

Select a grantee from the suggested list or enter a valid email address or a canonical ID associated to an AWS account. Canonical AWS ID can be obtained in the Security Credentials page of the AWS console.

Examples:      

• "Everyone"
• "Authenticated user"
•  an email address used to create AWS account
• a canonical AWS ID, e.g. "1700891f3927e316dc4c9e18c789b32131880f48d3e03ac110aaf695b212573e"

"Everyone” option allows anyone in the world to access the file (authenticated or anonymous). Even when the bucket is protected with permission and if the file operation in the Snap under ACL->Grantee is set to 'Everyone', any user (authenticated or anonymous) can access the file. So, we highly recommend not to use this option as its unsafe. 

The predefined ACL grants (from AWS) to use when writing a file to S3. Choose a Canned ACL from the available options:

• None
• Private
• PublicRead
• PublicReadWrite
• AuthenticatedRead
• LogDeliveryWrite
• BucketOwnerRead
• BucketOwnerFullControl
• AwsExecRead

Watch the video for more information about AWS Canned ACL.

Learn more about AWS Canned ACLs.

Access Control List

Use this field set to define the Access Control List (ACL) to the specified S3 file. This filed set contains the following fields:

• Grantee
• Read
• View permissions
• Full control

This field set contains the following fields:

• Key
• Value

Specify the key name of the object metadata.

Use this field set to define key-value pairs for

object

tags of an S3 object.

This Object tags enable you to categorize existing and new objects using key-value combinations. For details about the object tags, see Object Tagging. This field set contains the following fields:

• Key
• Value

Specify the key name of the object tag.

Snap Execution

Specify the key name of the object

tag.

Use this field set to define key-value pairs for object tags of an S3 object. Object tags enable you to categorize existing and new objects using key-value combinations. For details about the object tags, see Object Tagging. This field set contains the following fields:

• Key
• Value

Snap Execution