Skip to content

Support creating s3 pipeline with KMS key config #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

akamor
Copy link
Contributor

@akamor akamor commented Apr 18, 2025

No description provided.

@akamor akamor requested a review from zvika-tonic April 18, 2025 01:14
@@ -105,7 +106,8 @@ def create_s3_pipeline(
Whether to generate a redacted version of the file in addition to the parsed output. Default value is `False`.
aws_credentials_source: Optional[str]
For an Amazon S3 pipeline, how to obtain the AWS credentials. Options are `user_provided` and `from_environment`. For `user_provided`, you provide the credentials in the `credentials` parameter. For `from_environment`, the credentials are read from your Textual instance.

kms_key_arn: Optional[str]
When provided, the KMS key denoted by the ARN will be used to encrypted files prior to writing to output location via SSE-KMS. This value cannot be changed later.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When provided, the KMS key denoted by the ARN will be used to encrypted files prior to writing to output location via SSE-KMS. This value cannot be changed later.
When provided, the KMS key denoted by the ARN will be used by AWS to encrypt files prior to writing to output location via SSE-KMS. This value cannot be changed later.

Copy link

@zvika-tonic zvika-tonic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@akamor I never set this up and ran it, so haven't tested your change myself.
A few questions:

  1. Is this repo the only Textual SDK we have? I remember seeing something in Solar, but assuming it was consolidated to this repo.
  2. Is the purpose here to expose the configuration and documentation for the KMS ability, as well as test that creating a pipeline with this setting does not cause any failure? (you're not testing the actual encryption setting on S3, neither you should at this context)
  3. Do you want me to set it up for testing? Maybe next week when we're all in person that would be easy to troubleshoot if something doesn't work with the Python dependencies.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants