CopyS3Object

The Controller Service that is used to obtain AWS credentials provider

Display Name: AWS Credentials Provider Service
Description: The Controller Service that is used to obtain AWS credentials provider
API Name: AWS Credentials Provider service
Service Interface: org.apache.nifi.processors.aws.credentials.provider.service.AWSCredentialsProviderService
Service Implementations: org.apache.nifi.processors.aws.credentials.provider.service.AWSCredentialsProviderControllerService
Expression Language Scope: Not Supported
Sensitive: false
Required: true

Amazon Canned ACL for an object, one of: BucketOwnerFullControl, BucketOwnerRead, LogDeliveryWrite, AuthenticatedRead, PublicReadWrite, PublicRead, Private; will be ignored if any other ACL/permission/owner property is specified

Display Name: Canned ACL
Description: Amazon Canned ACL for an object, one of: BucketOwnerFullControl, BucketOwnerRead, LogDeliveryWrite, AuthenticatedRead, PublicReadWrite, PublicRead, Private; will be ignored if any other ACL/permission/owner property is specified
API Name: canned-acl
Default Value: ${s3.permissions.cannedacl}
Expression Language Scope: Environment variables and FlowFile Attributes
Sensitive: false
Required: false

Communications Timeout

The amount of time to wait in order to establish a connection to AWS or receive data from AWS before timing out.

Display Name: Communications Timeout
Description: The amount of time to wait in order to establish a connection to AWS or receive data from AWS before timing out.
API Name: Communications Timeout
Default Value: 30 secs
Expression Language Scope: Not Supported
Sensitive: false
Required: true

Custom Signer Class Name

Fully qualified class name of the custom signer class. The signer must implement com.amazonaws.auth.Signer interface.

Display Name

Custom Signer Class Name

Description

Fully qualified class name of the custom signer class. The signer must implement com.amazonaws.auth.Signer interface.

API Name

custom-signer-class-name

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true

Dependencies

Signer Override is set to any of [CustomSignerType]

Custom Signer Module Location

Comma-separated list of paths to files and/or directories which contain the custom signer's JAR file and its dependencies (if any).

Display Name

Custom Signer Module Location

Description

Comma-separated list of paths to files and/or directories which contain the custom signer's JAR file and its dependencies (if any).

API Name

custom-signer-module-location

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false

Dependencies

Signer Override is set to any of [CustomSignerType]

Destination Bucket

The bucket that will receive the copy.

Display Name: Destination Bucket
Description: The bucket that will receive the copy.
API Name: Destination Bucket
Expression Language Scope: Environment variables and FlowFile Attributes
Sensitive: false
Required: true

Destination Key

The target key in the target bucket

Display Name: Destination Key
Description: The target key in the target bucket
API Name: Destination Key
Default Value: ${filename}-1
Expression Language Scope: Environment variables and FlowFile Attributes
Sensitive: false
Required: true

Endpoint Override URL

Endpoint URL to use instead of the AWS default including scheme, host, port, and path. The AWS libraries select an endpoint URL based on the AWS region, but this property overrides the selected endpoint URL, allowing use with other S3-compatible endpoints.

Display Name: Endpoint Override URL
Description: Endpoint URL to use instead of the AWS default including scheme, host, port, and path. The AWS libraries select an endpoint URL based on the AWS region, but this property overrides the selected endpoint URL, allowing use with other S3-compatible endpoints.
API Name: Endpoint Override URL
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: false

FullControl User List

A comma-separated list of Amazon User ID's or E-mail addresses that specifies who should have Full Control for an object

Display Name: FullControl User List
Description: A comma-separated list of Amazon User ID's or E-mail addresses that specifies who should have Full Control for an object
API Name: FullControl User List
Default Value: ${s3.permissions.full.users}
Expression Language Scope: Environment variables and FlowFile Attributes
Sensitive: false
Required: false

Owner

The Amazon ID to use for the object's owner

Display Name: Owner
Description: The Amazon ID to use for the object's owner
API Name: Owner
Default Value: ${s3.owner}
Expression Language Scope: Environment variables and FlowFile Attributes
Sensitive: false
Required: false

Proxy Configuration Service

Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP + AuthN

Display Name: Proxy Configuration Service
Description: Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP + AuthN
API Name: proxy-configuration-service
Service Interface: org.apache.nifi.proxy.ProxyConfigurationService
Service Implementations: org.apache.nifi.proxy.StandardProxyConfigurationService
Expression Language Scope: Not Supported
Sensitive: false
Required: false

Read ACL User List

A comma-separated list of Amazon User ID's or E-mail addresses that specifies who should have permissions to read the Access Control List for an object

Display Name: Read ACL User List
Description: A comma-separated list of Amazon User ID's or E-mail addresses that specifies who should have permissions to read the Access Control List for an object
API Name: Read ACL User List
Default Value: ${s3.permissions.readacl.users}
Expression Language Scope: Environment variables and FlowFile Attributes
Sensitive: false
Required: false

Read Permission User List

A comma-separated list of Amazon User ID's or E-mail addresses that specifies who should have Read Access for an object

Display Name: Read Permission User List
Description: A comma-separated list of Amazon User ID's or E-mail addresses that specifies who should have Read Access for an object
API Name: Read Permission User List
Default Value: ${s3.permissions.read.users}
Expression Language Scope: Environment variables and FlowFile Attributes
Sensitive: false
Required: false

Region

The AWS Region to connect to.

Display Name

Region

Description

The AWS Region to connect to.

API Name

Region

Default Value

us-west-2

Allowable Values

AWS GovCloud (US)
AWS GovCloud (US-East)
US East (N. Virginia)
US East (Ohio)
US West (N. California)
US West (Oregon)
EU (Ireland)
EU (London)
EU (Paris)
EU (Frankfurt)
EU (Zurich)
EU (Stockholm)
EU (Milan)
EU (Spain)
Asia Pacific (Hong Kong)
Asia Pacific (Mumbai)
Asia Pacific (Hyderabad)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Jakarta)
Asia Pacific (Melbourne)
Asia Pacific (Tokyo)
Asia Pacific (Seoul)
Asia Pacific (Osaka)
South America (Sao Paulo)
China (Beijing)
China (Ningxia)
Canada (Central)
Canada West (Calgary)
Middle East (UAE)
Middle East (Bahrain)
Africa (Cape Town)
US ISO East
US ISOB East (Ohio)
US ISO West
Israel (Tel Aviv)
Use 's3.region' Attribute

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Signer Override

The AWS S3 library uses Signature Version 4 by default but this property allows you to specify the Version 2 signer to support older S3-compatible services or even to plug in your own custom signer implementation.

Display Name

Signer Override

Description

The AWS S3 library uses Signature Version 4 by default but this property allows you to specify the Version 2 signer to support older S3-compatible services or even to plug in your own custom signer implementation.

API Name

Signer Override

Default Value

Default Signature

Allowable Values

Default Signature
Signature Version 4
Signature Version 2
Custom Signature

Expression Language Scope

Not Supported

Sensitive

false

Required

false

Source Bucket

The bucket that contains the file to be copied.

Display Name: Source Bucket
Description: The bucket that contains the file to be copied.
API Name: Source Bucket
Default Value: ${s3.bucket}
Expression Language Scope: Environment variables and FlowFile Attributes
Sensitive: false
Required: true

Source Key

The source key in the source bucket

Display Name: Source Key
Description: The source key in the source bucket
API Name: Source Key
Default Value: ${filename}
Expression Language Scope: Environment variables and FlowFile Attributes
Sensitive: false
Required: true

SSL Context Service

Specifies an optional SSL Context Service that, if provided, will be used to create connections

Display Name: SSL Context Service
Description: Specifies an optional SSL Context Service that, if provided, will be used to create connections
API Name: SSL Context Service
Service Interface: org.apache.nifi.ssl.SSLContextService
Service Implementations: org.apache.nifi.ssl.StandardRestrictedSSLContextService

org.apache.nifi.ssl.StandardSSLContextService
Expression Language Scope: Not Supported
Sensitive: false
Required: false

Write ACL User List

A comma-separated list of Amazon User ID's or E-mail addresses that specifies who should have permissions to change the Access Control List for an object

Display Name: Write ACL User List
Description: A comma-separated list of Amazon User ID's or E-mail addresses that specifies who should have permissions to change the Access Control List for an object
API Name: Write ACL User List
Default Value: ${s3.permissions.writeacl.users}
Expression Language Scope: Environment variables and FlowFile Attributes
Sensitive: false
Required: false

Write Permission User List

A comma-separated list of Amazon User ID's or E-mail addresses that specifies who should have Write Access for an object

Display Name: Write Permission User List
Description: A comma-separated list of Amazon User ID's or E-mail addresses that specifies who should have Write Access for an object
API Name: Write Permission User List
Default Value: ${s3.permissions.write.users}
Expression Language Scope: Environment variables and FlowFile Attributes
Sensitive: false
Required: false

Name	Description
failure	If the Processor is unable to process a given FlowFile, it will be routed to this Relationship.
success	FlowFiles are routed to this Relationship after they have been successfully processed.

CopyS3Object 2.0.0