tcb env modify
Changes the package of an environment, or the resource states of a platform edition environment.
Usage
tcb env modify [options] -e <envId>
Flags
| Flag | Required | Description | Default |
|---|---|---|---|
--package <package> | No | Target package ID or number. Lists the available packages when omitted | — |
-e, --env-id <envId> | Yes | Environment ID | — |
--yes | No | Skips confirmation prompts | — |
Example
# Interactive change, lists the available packages
tcb env modify -e my-env-id
# Change to a specific package
tcb env modify --package baas_pf_standard -e my-env-id
Platform edition resource states
With --platform-id the command changes platform edition resource states, it is mutually exclusive with --package, and only the fields you pass are updated.
| Flag | Required | Description | Default |
|---|---|---|---|
--platform-id <platformId> | No | Platform edition resource pool ID, switches the command to resource state updates | — |
--status <status> | No | Environment state: ENABLE / DISABLE | — |
--storage-status <status> | No | Cloud storage state: ENABLE / DISABLE / READONLY | — |
--flexdb-status <status> | No | FlexDB document database state: ENABLE / DISABLE / READONLY | — |
# Disable a platform edition environment
tcb env modify --platform-id <platformId> -e my-env-id --status DISABLE --yes
# Set cloud storage to read-only
tcb env modify --platform-id <platformId> -e my-env-id --storage-status READONLY --yes
Versions
tcb env modify has been available since v3.0.0, platform edition state changes since v3.8.3.