Skip to main content

Function: artifactStoreConfigSchema()

artifactStoreConfigSchema(): TObject<{ s3: TObject<{ bucket: TString; credentials: TUnsafe<SecretRefValue>; endpoint: TString; forcePathStyle: TOptional<TBoolean>; maxAttempts: TOptional<TInteger>; region: TOptional<TString>; requestTimeoutMs: TOptional<TInteger>; }>; }>

Defined in: packages/artifact-store/src/config.ts:53

Builds the schema.

  • s3.endpoint: scheme, host and port of the store, no path. Required.
  • s3.bucket: the bucket every key lives in. Required.
  • s3.credentials: a secret:// reference to one file holding <access key id>:<secret access key>. Required.
  • s3.region: the signing region. Optional, default DEFAULT_REGION.
  • s3.forcePathStyle: address the bucket in the path rather than the host name. Optional, default true, which the stack's store needs.
  • s3.maxAttempts: 1 to MAX_ATTEMPTS_LIMIT, default DEFAULT_MAX_ATTEMPTS.
  • s3.requestTimeoutMs: 100 to 120000, default DEFAULT_REQUEST_TIMEOUT_MS.

Returns​

TObject<{ s3: TObject<{ bucket: TString; credentials: TUnsafe<SecretRefValue>; endpoint: TString; forcePathStyle: TOptional<TBoolean>; maxAttempts: TOptional<TInteger>; region: TOptional<TString>; requestTimeoutMs: TOptional<TInteger>; }>; }>

A TypeBox object schema.