Skip to content

[FLINK-39581] Document the available config params in a single place for s3 native connector#28076

Open
Samrat002 wants to merge 1 commit intoapache:masterfrom
Samrat002:FLINK-39581
Open

[FLINK-39581] Document the available config params in a single place for s3 native connector#28076
Samrat002 wants to merge 1 commit intoapache:masterfrom
Samrat002:FLINK-39581

Conversation

@Samrat002
Copy link
Copy Markdown
Contributor

What is the purpose of the change

Document the available config params in a single place for s3 native connector

Brief change log

Link to README in the doc page , making a single source of truth

Verifying this change

Screenshot 2026-04-30 at 10 57 41 PM

Does this pull request potentially affect one of the following parts:

  • Dependencies (does it add or upgrade a dependency): (yes / no)
  • The public API, i.e., is any changed class annotated with @Public(Evolving): (yes / no)
  • The serializers: (yes / no / don't know)
  • The runtime per-record code paths (performance sensitive): (yes / no / don't know)
  • Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn, ZooKeeper: (yes / no / don't know)
  • The S3 file system connector: (yes / no / don't know)

Documentation

  • Does this pull request introduce a new feature? (yes / no)
  • If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)

Was generative AI tooling used to co-author this PR?

No

  • Yes (please specify the tool below)

@Samrat002
Copy link
Copy Markdown
Contributor Author

cc: @gaborgsomogyi

@flinkbot
Copy link
Copy Markdown
Collaborator

flinkbot commented Apr 30, 2026

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run azure re-run the last Azure build

Copy link
Copy Markdown
Contributor

@spuru9 spuru9 left a comment

Choose a reason for hiding this comment

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

LGTM, just a small nit.

```

When `fs.s3.aws.credentials.provider` is not set, the Native S3 FileSystem automatically builds a credentials chain in the following order: delegation tokens, static credentials (if `s3.access-key` and `s3.secret-key` are configured), and the AWS SDK v2 `DefaultCredentialsProvider` (environment variables, instance profiles, etc.). You only need to set this option if you require a custom provider chain.
View the detailed configuration at [native-s3-fs](https://github.com/apache/flink/tree/master/flink-filesystems/flink-s3-fs-native)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

nit: for someone opening the configuration, https://github.com/apache/flink/tree/master/flink-filesystems/flink-s3-fs-native#configuration-options might be a better place to link.
Work both ways, just a food for thought.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

+1 on this

@github-actions github-actions Bot added the community-reviewed PR has been reviewed by the community. label May 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community-reviewed PR has been reviewed by the community.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants