sharing.s3.query

Sent on sharing.s3 changes.

Type: object

SharingS3AddedEvent

Type: object
No Additional Properties

Id

Type: integer

SharingS3Entry

Type: object
No Additional Properties

Id

Type: integer

Unique identifier for the bucket.

Name

Type: string

Bucket name, following the S3 rules. Three to 63 characters of lowercase letters, digits, dots and hyphens, starting and ending with a letter or digit, no adjacent dots, and never an IPv4 address.

Must match regular expression: ^[a-z0-9][a-z0-9.-]*[a-z0-9]$

Must be at least 3 characters long

Must be at most 63 characters long

Dataset

Type: string

The ZFS dataset the bucket is. Created by sharing.s3.create and owned by it. Objects live in the s3data directory under its mount point, which the S3 service creates on its next start, owned by owner. Under the MULTIPROTOCOL permissions model the filesystem permissions on that tree govern S3 callers too, so a grantee other than the owner reaches only what they allow; set an ACL on the directory as for any share. Under S3 they are ignored and the grants decide instead.

Must be at least 1 characters long

Enabled

Type: boolean Default: true

Whether the bucket is served. Toggling restarts the S3 service.

Owner

Type: string

Account that owns the bucket and bypasses its grants, owns the s3data directory when the S3 service creates it, and owns every object written under the BUCKET_OWNER_ENFORCED object ownership setting. Given by name, held by uid: the name is resolved when set and again whenever the bucket is read, so a renamed account reads as its new name, a reused name never inherits the bucket, and an account that no longer exists reads as its uid. Changing the owner later moves the grants, not the directory.

Must be at least 1 characters long

Owner Uid

Type: integer

The uid that owns the bucket.

Grants

Type: array of object Default: []

Who may access the bucket and how, beyond its owner.

 No Additional Items
Each item of this array must be:

S3GrantEntry

Type: object
No Additional Properties

Principal Type

Type: enum (of string)

Who the grant applies to. A user, a group, or everyone with a valid access key.

Must be one of:
  • "USER"
  • "GROUP"
  • "EVERYONE"

Xid

Default: null

The uid of the user or the gid of the group. Required for USER and GROUP, forbidden for EVERYONE.

Type: integer
Type: null

Access

Type: enum (of string)

What the grant allows. READONLY, WRITEONLY and READWRITE allow the matching operations. DENY refuses every operation for the principal and outranks the bucket owner.

Must be one of:
  • "READONLY"
  • "WRITEONLY"
  • "READWRITE"
  • "DENY"

Name

Type: string

Name of the user or group the grant applies to, resolved for display. Empty for EVERYONE.

Permissions Model

Type: enum (of string) Default: "S3"

How the S3 service treats the filesystem permissions on the bucket's tree. S3 when the S3 service is the only door: those permissions are ignored in their entirety, and access is decided by the bucket's grants and, where object_ownership supports them, its S3 ACLs. MULTIPROTOCOL when SMB or NFS share the tree: the filesystem ACL is enforced as well as the grants, so an ACL set on the tree governs S3 callers too and narrowing it takes effect for them immediately. S3 ACLs are not supported on such a bucket at all, whatever object_ownership says, since no stored S3 record may decide what a write from another protocol could contradict. Which account an S3 operation runs as is object_ownership's answer, not this one's.

Must be one of:
  • "S3"
  • "MULTIPROTOCOL"

Object Ownership

Type: enum (of string) Default: "BUCKET_OWNER_ENFORCED"

S3 Object Ownership, the bucket-level setting that controls ownership of objects uploaded to the bucket and disables or enables ACLs, and what GetBucketOwnershipControls reports. BUCKET_OWNER_ENFORCED (the default): ACLs are disabled, and the bucket owner automatically owns and has full control over every object in the bucket. ACLs no longer affect permissions to data in the bucket, and the bucket uses its grants to define access control. Requests to set or update ACLs fail with AccessControlListNotSupported; requests to read ACLs are supported. Only uploads with bucket owner full control ACLs, or uploads that do not specify an ACL, are accepted. BUCKET_OWNER_PREFERRED: the bucket owner owns and has full control over new objects that other accounts write to the bucket with the bucket-owner-full-control canned ACL. Objects uploaded with other ACLs are owned by the writing account. ACLs can be updated and can grant permissions. OBJECT_WRITER: the account that uploads an object owns the object, has full control over it, and can grant other users access to it through ACLs. A MULTIPROTOCOL bucket is always OBJECT_WRITER whatever is given here, and its ACLs stay disabled: the other protocols' users own the filesystem permissions on the tree.

Must be one of:
  • "BUCKET_OWNER_ENFORCED"
  • "BUCKET_OWNER_PREFERRED"
  • "OBJECT_WRITER"

Versioning

Type: enum (of string) Default: "OFF"

Bucket versioning state. One-way: a bucket that has been ENABLED or SUSPENDED cannot return to OFF here, only move between those two, so its stored versions never go unreachable. sharing.s3.force_disable_versioning is the one destructive way back, and it destroys every prior object version. NOTE: this is a licensed feature.

Must be one of:
  • "OFF"
  • "ENABLED"
  • "SUSPENDED"

Snapshot Versions

Type: array of string Default: []

Patterns over the names of the bucket dataset's ZFS snapshots, * and ? the only metacharacters, each matched against a whole name. Every snapshot a pattern selects serves each object's state frozen in it as a read-only version: listed by ListObjectVersions and read by its version id. Empty disables surfacing object versions from ZFS snapshots.

 No Additional Items
Each item of this array must be:
Type: string

Must be at least 1 characters long

Snapshot Versions Max

Type: integer Default: 64

How many of the newest selected snapshots one ListObjectVersions listing consults. Bounds the listing alone: a selected snapshot beyond it still serves by its version id.

Value must be greater or equal to 1 and lesser or equal to 4294967295

Multipart Etag

Type: enum (of string) Default: "COMPOSITE"

What the ETag of an object assembled from a multipart upload is. COMPOSITE is the S3 construction: each part's ETag is the MD5 of its bytes and the object's is the MD5 of those digests with the part count appended, which costs an MD5 pass over every part. MINTED skips that pass for a part whose upload carried no Content-MD5 and gives the object an opaque token instead. Choose it only where nothing writing the bucket reads its ETags, such as a backup target that declares its own checksums: a client that recomputes the composite to verify or resume an upload sees a value it cannot match.

Must be one of:
  • "COMPOSITE"
  • "MINTED"

Object Lock

Type: boolean Default: false

Whether object lock is enabled. Requires versioning to be ENABLED and a permissions model other than MULTIPROTOCOL: a locked bucket is the S3 service's alone. One-way: the lock is latched on the bucket's dataset and cannot be disabled once enabled. NOTE: this is a licensed feature.

Object Lock Default Mode

Default: null

Retention mode of the default object lock rule, or null for no default rule.

Type: enum (of string)
Must be one of:
  • "GOVERNANCE"
  • "COMPLIANCE"
Type: null

Object Lock Default Days

Default: null

Retention period of the default object lock rule in days, up to 36500 (a hundred years).

Type: integer

Value must be greater or equal to 1 and lesser or equal to 36500

Type: null

Audit

Default: null

Actions audited on this bucket, ALL, or an empty list to audit nothing. null inherits the service's default_audit. CreateBucket and ListAllMyBuckets never match here — the service default_audit governs both — while DeleteBucket does match this bucket's own deletion. NOTE: this is a licensed feature.

Type: array of enum (of string)
No Additional Items
Each item of this array must be:
Type: enum (of string)
Must be one of:
  • "GetObject"
  • "PutObject"
  • "DeleteObject"
  • "GetObjectTagging"
  • "PutObjectTagging"
  • "DeleteObjectTagging"
  • "ListBucket"
  • "GetBucketLocation"
  • "ListBucketMultipartUploads"
  • "ListMultipartUploadParts"
  • "AbortMultipartUpload"
  • "PutObjectRetention"
  • "PutObjectLegalHold"
  • "ListAllMyBuckets"
  • "GetObjectAcl"
  • "PutObjectAcl"
  • "GetBucketAcl"
  • "PutBucketAcl"
  • "PutBucketVersioning"
  • "CreateBucket"
  • "DeleteBucket"
Type: const
Specific value: "ALL"
Type: null

Audit Overflow

Default: null

Overflow behavior for this bucket's audit records, or null to inherit the service's default.

Type: enum (of string)
Must be one of:
  • "DROP"
  • "BACKPRESSURE"
Type: null

Locked

Default: null

Whether the bucket's dataset is locked. Read only.

Type: boolean
Type: null

SharingS3ChangedEvent

Type: object
No Additional Properties

Id

Type: integer

SharingS3Entry

Type: object
No Additional Properties

Id

Type: integer

Unique identifier for the bucket.

Name

Type: string

Bucket name, following the S3 rules. Three to 63 characters of lowercase letters, digits, dots and hyphens, starting and ending with a letter or digit, no adjacent dots, and never an IPv4 address.

Must match regular expression: ^[a-z0-9][a-z0-9.-]*[a-z0-9]$

Must be at least 3 characters long

Must be at most 63 characters long

Dataset

Type: string

The ZFS dataset the bucket is. Created by sharing.s3.create and owned by it. Objects live in the s3data directory under its mount point, which the S3 service creates on its next start, owned by owner. Under the MULTIPROTOCOL permissions model the filesystem permissions on that tree govern S3 callers too, so a grantee other than the owner reaches only what they allow; set an ACL on the directory as for any share. Under S3 they are ignored and the grants decide instead.

Must be at least 1 characters long

Enabled

Type: boolean Default: true

Whether the bucket is served. Toggling restarts the S3 service.

Owner

Type: string

Account that owns the bucket and bypasses its grants, owns the s3data directory when the S3 service creates it, and owns every object written under the BUCKET_OWNER_ENFORCED object ownership setting. Given by name, held by uid: the name is resolved when set and again whenever the bucket is read, so a renamed account reads as its new name, a reused name never inherits the bucket, and an account that no longer exists reads as its uid. Changing the owner later moves the grants, not the directory.

Must be at least 1 characters long

Owner Uid

Type: integer

The uid that owns the bucket.

Grants

Type: array of object Default: []

Who may access the bucket and how, beyond its owner.

 No Additional Items
Each item of this array must be:

S3GrantEntry

Type: object
No Additional Properties

Principal Type

Type: enum (of string)

Who the grant applies to. A user, a group, or everyone with a valid access key.

Must be one of:
  • "USER"
  • "GROUP"
  • "EVERYONE"

Xid

Default: null

The uid of the user or the gid of the group. Required for USER and GROUP, forbidden for EVERYONE.

Type: integer
Type: null

Access

Type: enum (of string)

What the grant allows. READONLY, WRITEONLY and READWRITE allow the matching operations. DENY refuses every operation for the principal and outranks the bucket owner.

Must be one of:
  • "READONLY"
  • "WRITEONLY"
  • "READWRITE"
  • "DENY"

Name

Type: string

Name of the user or group the grant applies to, resolved for display. Empty for EVERYONE.

Permissions Model

Type: enum (of string) Default: "S3"

How the S3 service treats the filesystem permissions on the bucket's tree. S3 when the S3 service is the only door: those permissions are ignored in their entirety, and access is decided by the bucket's grants and, where object_ownership supports them, its S3 ACLs. MULTIPROTOCOL when SMB or NFS share the tree: the filesystem ACL is enforced as well as the grants, so an ACL set on the tree governs S3 callers too and narrowing it takes effect for them immediately. S3 ACLs are not supported on such a bucket at all, whatever object_ownership says, since no stored S3 record may decide what a write from another protocol could contradict. Which account an S3 operation runs as is object_ownership's answer, not this one's.

Must be one of:
  • "S3"
  • "MULTIPROTOCOL"

Object Ownership

Type: enum (of string) Default: "BUCKET_OWNER_ENFORCED"

S3 Object Ownership, the bucket-level setting that controls ownership of objects uploaded to the bucket and disables or enables ACLs, and what GetBucketOwnershipControls reports. BUCKET_OWNER_ENFORCED (the default): ACLs are disabled, and the bucket owner automatically owns and has full control over every object in the bucket. ACLs no longer affect permissions to data in the bucket, and the bucket uses its grants to define access control. Requests to set or update ACLs fail with AccessControlListNotSupported; requests to read ACLs are supported. Only uploads with bucket owner full control ACLs, or uploads that do not specify an ACL, are accepted. BUCKET_OWNER_PREFERRED: the bucket owner owns and has full control over new objects that other accounts write to the bucket with the bucket-owner-full-control canned ACL. Objects uploaded with other ACLs are owned by the writing account. ACLs can be updated and can grant permissions. OBJECT_WRITER: the account that uploads an object owns the object, has full control over it, and can grant other users access to it through ACLs. A MULTIPROTOCOL bucket is always OBJECT_WRITER whatever is given here, and its ACLs stay disabled: the other protocols' users own the filesystem permissions on the tree.

Must be one of:
  • "BUCKET_OWNER_ENFORCED"
  • "BUCKET_OWNER_PREFERRED"
  • "OBJECT_WRITER"

Versioning

Type: enum (of string) Default: "OFF"

Bucket versioning state. One-way: a bucket that has been ENABLED or SUSPENDED cannot return to OFF here, only move between those two, so its stored versions never go unreachable. sharing.s3.force_disable_versioning is the one destructive way back, and it destroys every prior object version. NOTE: this is a licensed feature.

Must be one of:
  • "OFF"
  • "ENABLED"
  • "SUSPENDED"

Snapshot Versions

Type: array of string Default: []

Patterns over the names of the bucket dataset's ZFS snapshots, * and ? the only metacharacters, each matched against a whole name. Every snapshot a pattern selects serves each object's state frozen in it as a read-only version: listed by ListObjectVersions and read by its version id. Empty disables surfacing object versions from ZFS snapshots.

 No Additional Items
Each item of this array must be:
Type: string

Must be at least 1 characters long

Snapshot Versions Max

Type: integer Default: 64

How many of the newest selected snapshots one ListObjectVersions listing consults. Bounds the listing alone: a selected snapshot beyond it still serves by its version id.

Value must be greater or equal to 1 and lesser or equal to 4294967295

Multipart Etag

Type: enum (of string) Default: "COMPOSITE"

What the ETag of an object assembled from a multipart upload is. COMPOSITE is the S3 construction: each part's ETag is the MD5 of its bytes and the object's is the MD5 of those digests with the part count appended, which costs an MD5 pass over every part. MINTED skips that pass for a part whose upload carried no Content-MD5 and gives the object an opaque token instead. Choose it only where nothing writing the bucket reads its ETags, such as a backup target that declares its own checksums: a client that recomputes the composite to verify or resume an upload sees a value it cannot match.

Must be one of:
  • "COMPOSITE"
  • "MINTED"

Object Lock

Type: boolean Default: false

Whether object lock is enabled. Requires versioning to be ENABLED and a permissions model other than MULTIPROTOCOL: a locked bucket is the S3 service's alone. One-way: the lock is latched on the bucket's dataset and cannot be disabled once enabled. NOTE: this is a licensed feature.

Object Lock Default Mode

Default: null

Retention mode of the default object lock rule, or null for no default rule.

Type: enum (of string)
Must be one of:
  • "GOVERNANCE"
  • "COMPLIANCE"
Type: null

Object Lock Default Days

Default: null

Retention period of the default object lock rule in days, up to 36500 (a hundred years).

Type: integer

Value must be greater or equal to 1 and lesser or equal to 36500

Type: null

Audit

Default: null

Actions audited on this bucket, ALL, or an empty list to audit nothing. null inherits the service's default_audit. CreateBucket and ListAllMyBuckets never match here — the service default_audit governs both — while DeleteBucket does match this bucket's own deletion. NOTE: this is a licensed feature.

Type: array of enum (of string)
No Additional Items
Each item of this array must be:
Type: enum (of string)
Must be one of:
  • "GetObject"
  • "PutObject"
  • "DeleteObject"
  • "GetObjectTagging"
  • "PutObjectTagging"
  • "DeleteObjectTagging"
  • "ListBucket"
  • "GetBucketLocation"
  • "ListBucketMultipartUploads"
  • "ListMultipartUploadParts"
  • "AbortMultipartUpload"
  • "PutObjectRetention"
  • "PutObjectLegalHold"
  • "ListAllMyBuckets"
  • "GetObjectAcl"
  • "PutObjectAcl"
  • "GetBucketAcl"
  • "PutBucketAcl"
  • "PutBucketVersioning"
  • "CreateBucket"
  • "DeleteBucket"
Type: const
Specific value: "ALL"
Type: null

Audit Overflow

Default: null

Overflow behavior for this bucket's audit records, or null to inherit the service's default.

Type: enum (of string)
Must be one of:
  • "DROP"
  • "BACKPRESSURE"
Type: null

Locked

Default: null

Whether the bucket's dataset is locked. Read only.

Type: boolean
Type: null

SharingS3RemovedEvent

Type: object
No Additional Properties

Id

Type: integer


Required roles: SHARING_S3_READ