Type Alias PostObjectStorageBucketData

Type Declaration

• Optionalacl?: "private" | "public-read" | "authenticated-read" | "public-read-write"

  The S3 predefined collection of grantees and permissions set for the bucket, also referred to as a Canned ACL.

• Optionalcors_enabled?: boolean

  If set to false, cross-origin resource sharing (CORS) is disabled for all origins in the bucket.

• Optionalendpoint_type?: "E0" | "E1" | "E2" | "E3"

  The type of s3_endpoint available to the active user in this region. See Endpoint types for more information.

• label: string

  The name for this bucket.

  • A bucket name can contain from 3 to 63 alphanumeric characters, dashes (-), or dots (.).
  • A bucket name can't end in a dash and you can't use two consecutive dashes.
  • A bucket name can't start or end in a dot, and you can't use two consecutive dots. As a best practice, only use dots if a certificate you're using with your bucket requires it. (For example, if you're using a custom TLS certificate.)
  • A bucket name needs to be unique in the region where you're creating the bucket. The API only reserves labels for the region where active buckets are created and stored. If you want to reserve this bucket's label in another region, create a new bucket with the same label in the new region.

• Optionalregion?: string

  The id assigned to the data center (region) where this Object Storage bucket should be created.

  📘

  This supports legacy clusterId values that represented a specific region. For example, us-east-1 is the legacy reference for the us-east region.

• Optionals3_endpoint?: string

  The active user's S3-compatible endpoint URL, based on the endpoint_type and region.