Skip to main content

StandardS3EncryptionService

Description​

Adds configurable encryption to S3 Put and S3 Fetch operations.

Tags​

aws, decrypt, decryption, encrypt, encryption, key, s3, service

Properties​

In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Encryption Strategy *encryption-strategyNone
  • None
  • Server-side S3
  • Server-side KMS
  • Server-side Customer Key
  • Client-side KMS
  • Client-side Customer Key
Strategy to use for S3 data encryption and decryption.
Key ID or Key Materialkey-id-or-key-materialFor None and Server-side S3: not used. For Server-side KMS and Client-side KMS: the KMS Key ID must be configured. For Server-side Customer Key and Client-side Customer Key: the Key Material must be specified in Base64 encoded form. In case of Server-side Customer Key, the key must be an AES-256 key. In case of Client-side Customer Key, it can be an AES-256, AES-192 or AES-128 key.

Supports Expression Language, using Environment variables.
KMS Regionkms-regionUS West (Oregon)
  • 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)
The Region of the AWS Key Management Service. Only used in case of Client-side KMS.

State Management​

This component does not store state.

Restricted​

This component is not restricted.

System Resource Considerations​

This component does not specify system resource considerations.

See Also​