S3 file system support#

Примечание

Ниже приведена оригинальная документация Trino. Скоро мы ее переведем на русский язык и дополним полезными примерами.

Trino includes a native implementation to access Amazon S3 and compatible storage systems with a catalog using the Delta Lake, Hive, Hudi, or Iceberg connectors. While Trino is designed to support S3-compatible storage systems, only AWS S3 and MinIO are tested for compatibility. For other storage systems, perform your own testing and consult your vendor for more information.

Enable the native implementation with fs.native-s3.enabled=true in your catalog properties file.

General configuration#

Use the following properties to configure general aspects of S3 file system support:

Property	Description
`fs.native-s3.enabled`	Activate the native implementation for S3 storage support. Defaults to `false`. Set to `true` to use S3 and enable all other properties.
`s3.endpoint`	Required endpoint URL for S3.
`s3.region`	Required region name for S3.
`s3.path-style-access`	Use path-style access for all requests to S3
`s3.exclusive-create`	Whether conditional write is supported by the S3-compatible storage. Defaults to `true`.
`s3.canned-acl`	Canned ACL to use when uploading files to S3. Defaults to `NONE`, which has the same effect as `PRIVATE`. If the files are to be uploaded to an S3 bucket owned by a different AWS user, the canned ACL may be set to one of the following: `PRIVATE`, `PUBLIC_READ`, `PUBLIC_READ_WRITE`, `AUTHENTICATED_READ`, `BUCKET_OWNER_READ`, or `BUCKET_OWNER_FULL_CONTROL`.
`s3.sse.type`	Set the type of S3 server-side encryption (SSE) to use. Defaults to `NONE` for no encryption. Other valid values are `S3` for encryption by S3 managed keys, and `KMS` for encryption with a key from the AWS Key Management Service (KMS). Note that S3 automatically uses SSE so `NONE` and `S3` are equivalent. S3-compatible systems might behave differently.
`s3.sse.kms-key-id`	The identifier of a key in KMS to use for SSE.
`s3.streaming.part-size`	Part size for S3 streaming upload. Values between `5MB` and `256MB` are valid. Defaults to `16MB`.
`s3.requester-pays`	Switch to activate billing transfer cost to the requester. Defaults to `false`.
`s3.max-connections`	Maximum number of connections to S3. Defaults to `500`.
`s3.connection-ttl`	Maximum time duration allowed to reuse connections in the connection pool before being replaced.
`s3.connection-max-idle-time`	Maximum time duration allowed for connections to remain idle in the connection pool before being closed.
`s3.socket-connect-timeout`	Maximum time duration allowed for socket connection requests to complete before timing out.
`s3.socket-read-timeout`	Maximum time duration for socket read operations before timing out.
`s3.tcp-keep-alive`	Enable TCP keep alive on created connections. Defaults to `false`.
`s3.http-proxy`	URL of a HTTP proxy server to use for connecting to S3.
`s3.http-proxy.secure`	Set to `true` to enable HTTPS for the proxy server.
`s3.http-proxy.username`	Proxy username to use if connecting through a proxy server.
`s3.http-proxy.password`	Proxy password to use if connecting through a proxy server.
`s3.http-proxy.non-proxy-hosts`	Hosts list to access without going through the proxy server.
`s3.http-proxy.preemptive-basic-auth`	Whether to attempt to authenticate preemptively against proxy server when using base authorization, defaults to `false`.
`s3.retry-mode`	Specifies how the AWS SDK attempts retries. Default value is `LEGACY`. Other allowed values are `STANDARD` and `ADAPTIVE`. The `STANDARD` mode includes a standard set of errors that are retried. `ADAPTIVE` mode includes the functionality of `STANDARD` mode with automatic client-side throttling.
`s3.max-error-retries`	Specifies maximum number of retries the client will make on errors. Defaults to `10`.
`s3.use-web-identity-token-credentials-provider`	Set to `true` to only use the web identity token credentials provider, instead of the default providers chain. This can be useful when running Trino on Amazon EKS and using IAM roles for service accounts (IRSA) Defaults to `false`.

Authentication#

Use the following properties to configure the authentication to S3 with access and secret keys, STS, or an IAM role:

Property	Description
`s3.aws-access-key`	AWS access key to use for authentication.
`s3.aws-secret-key`	AWS secret key to use for authentication.
`s3.sts.endpoint`	The endpoint URL of the AWS Security Token Service to use for authenticating to S3.
`s3.sts.region`	AWS region of the STS service.
`s3.iam-role`	ARN of an IAM role to assume when connecting to S3.
`s3.role-session-name`	Role session name to use when connecting to S3. Defaults to `trino-filesystem`.
`s3.external-id`	External ID for the IAM role trust policy when connecting to S3.

Security mapping#

Trino supports flexible security mapping for S3, allowing for separate credentials or IAM roles for specific users or S3 locations. The IAM role for a specific query can be selected from a list of allowed roles by providing it as an extra credential.

Each security mapping entry may specify one or more match criteria. If multiple criteria are specified, all criteria must match. The following match criteria are available:

user: Regular expression to match against username. Example: alice|bob
group: Regular expression to match against any of the groups that the user belongs to. Example: finance|sales
prefix: S3 URL prefix. You can specify an entire bucket or a path within a bucket. The URL must start with s3:// but also matches for s3a or s3n. Example: s3://bucket-name/abc/xyz/

The security mapping must provide one or more configuration settings:

accessKey and secretKey: AWS access key and secret key. This overrides any globally configured credentials, such as access key or instance credentials.
iamRole: IAM role to use if no user provided role is specified as an extra credential. This overrides any globally configured IAM role. This role is allowed to be specified as an extra credential, although specifying it explicitly has no effect.
roleSessionName: Optional role session name to use with iamRole. This can only be used when iamRole is specified. If roleSessionName includes the string ${USER}, then the ${USER} portion of the string is replaced with the current session’s username. If roleSessionName is not specified, it defaults to trino-session.
allowedIamRoles: IAM roles that are allowed to be specified as an extra credential. This is useful because a particular AWS account may have permissions to use many roles, but a specific user should only be allowed to use a subset of those roles.
kmsKeyId: ID of KMS-managed key to be used for client-side encryption.
allowedKmsKeyIds: KMS-managed key IDs that are allowed to be specified as an extra credential. If list cotains *, then any key can be specified via extra credential.
endpoint: The S3 storage endpoint server. This optional property can be used to override S3 endpoints on a per-bucket basis.
region: The S3 region to connect to. This optional property can be used to override S3 regions on a per-bucket basis.

The security mapping entries are processed in the order listed in the JSON configuration. Therefore, specific mappings must be specified before less specific mappings. For example, the mapping list might have URL prefix s3://abc/xyz/ followed by s3://abc/ to allow different configuration for a specific path within a bucket than for other paths within the bucket. You can specify the default configuration by not including any match criteria for the last entry in the list.

In addition to the preceding rules, the default mapping can contain the optional useClusterDefault boolean property set to true to use the default S3 configuration. It cannot be used with any other configuration settings.

If no mapping entry matches and no default is configured, access is denied.

The configuration JSON is read from a file via s3.security-mapping.config-file or from an HTTP endpoint via s3.security-mapping.config-uri.

Example JSON configuration:

{
  "mappings": [
    {
      "prefix": "s3://bucket-name/abc/",
      "iamRole": "arn:aws:iam::123456789101:role/test_path"
    },
    {
      "user": "bob|charlie",
      "iamRole": "arn:aws:iam::123456789101:role/test_default",
      "allowedIamRoles": [
        "arn:aws:iam::123456789101:role/test1",
        "arn:aws:iam::123456789101:role/test2",
        "arn:aws:iam::123456789101:role/test3"
      ]
    },
    {
      "prefix": "s3://special-bucket/",
      "accessKey": "AKIAxxxaccess",
      "secretKey": "iXbXxxxsecret"
    },
    {
      "prefix": "s3://regional-bucket/",
      "iamRole": "arn:aws:iam::123456789101:role/regional-user",
      "endpoint": "https://bucket.vpce-1a2b3c4d-5e6f.s3.us-east-1.vpce.amazonaws.com",
      "region": "us-east-1"
    },
    {
      "prefix": "s3://encrypted-bucket/",
      "kmsKeyId": "kmsKey_10"
    },
    {
      "user": "test.*",
      "iamRole": "arn:aws:iam::123456789101:role/test_users"
    },
    {
      "group": "finance",
      "iamRole": "arn:aws:iam::123456789101:role/finance_users"
    },
    {
      "iamRole": "arn:aws:iam::123456789101:role/default"
    }
  ]
}

Security mapping properties#
Property name	Description
`s3.security-mapping.enabled`	Activate the security mapping feature. Defaults to `false`. Must be set to `true` for all other properties be used.
`s3.security-mapping.config-file`	Path to the JSON configuration file containing security mappings.
`s3.security-mapping.config-uri`	HTTP endpoint URI containing security mappings.
`s3.security-mapping.json-pointer`	A JSON pointer (RFC 6901) to mappings inside the JSON retrieved from the configuration file or HTTP endpoint. The default is the root of the document.
`s3.security-mapping.iam-role-credential-name`	The name of the extra credential used to provide the IAM role.
`s3.security-mapping.kms-key-id-credential-name`	The name of the extra credential used to provide the KMS-managed key ID.
`s3.security-mapping.refresh-period`	How often to refresh the security mapping configuration, specified as a duration. By default, the configuration is not refreshed.
`s3.security-mapping.colon-replacement`	The character or characters to be used instead of a colon character when specifying an IAM role name as an extra credential. Any instances of this replacement value in the extra credential value are converted to a colon. Choose a value not used in any of your IAM ARNs.