create¶
Description¶
Creates a Stack.
Required Parameters¶
-
--compartment-id,-c[text]¶
The OCID of the compartment to create the Stack in.
-
--display-name[text]¶
A user-friendly name. Should be unique per compartment. Avoid entering confidential information.
-
--services[text]¶
List of services to be onboarded for the stack.
Accepted values are:
ADB, DATAFLOW, GENAI, GGCS, OBJECTSTORAGE
-
--stack-templates[text]¶
List of templates to be onboarded for the stack.
Accepted values are:
AISERVICES, DATALAKE, DATAPIPELINE, DATATRANSFORMATION
Optional Parameters¶
-
--adb[complex type]¶
ADB details if adb is included in the services.
This option is a JSON list with items of type AdbDetail. For documentation on AdbDetail please see our API reference: https://docs.cloud.oracle.com/api/#/en/stack/20250830/datatypes/AdbDetail. This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.
The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example
in a file, modifying it as needed and then passing it back in via the file:// syntax.
-
--dataflow[complex type]¶
DATAFLOW details if dataflow is included in the services.
This option is a JSON list with items of type DataflowDetail. For documentation on DataflowDetail please see our API reference: https://docs.cloud.oracle.com/api/#/en/stack/20250830/datatypes/DataflowDetail. This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.
The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example
in a file, modifying it as needed and then passing it back in via the file:// syntax.
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example:
{"Operations": {"CostCenter": "42"}}
This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.
The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example
in a file, modifying it as needed and then passing it back in via the file:// syntax.
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example:
{"Department": "Finance"}
This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.
The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example
in a file, modifying it as needed and then passing it back in via the file:// syntax.
-
--from-json[text]¶
Provide input to this command as a JSON document from a file using the file://path-to/file syntax.
The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.
Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.
For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
-
--genai[complex type]¶
GenAi Details if genai is included in services.
This option is a JSON list with items of type GenAiDetail. For documentation on GenAiDetail please see our API reference: https://docs.cloud.oracle.com/api/#/en/stack/20250830/datatypes/GenAiDetail. This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.
The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example
in a file, modifying it as needed and then passing it back in via the file:// syntax.
-
--ggcs[complex type]¶
GGCS details if ggcs is included in the services.
This option is a JSON list with items of type GgcsDetail. For documentation on GgcsDetail please see our API reference: https://docs.cloud.oracle.com/api/#/en/stack/20250830/datatypes/GgcsDetail. This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.
The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example
in a file, modifying it as needed and then passing it back in via the file:// syntax.
-
--max-wait-seconds[integer]¶
The maximum time to wait for the work request to reach the state defined by --wait-for-state. Defaults to 1200 seconds.
-
--notification-email[text]¶
email id to which the stack notifications would be sent.
-
--objectstorage[complex type]¶
Object Storage Details if object storage is included in services.
This option is a JSON list with items of type ObjectStorageDetail. For documentation on ObjectStorageDetail please see our API reference: https://docs.cloud.oracle.com/api/#/en/stack/20250830/datatypes/ObjectStorageDetail. This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.
The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example
in a file, modifying it as needed and then passing it back in via the file:// syntax.
-
--wait-for-state[text]¶
This operation asynchronously creates, modifies or deletes a resource and uses a work request to track the progress of the operation. Specify this option to perform the action and then wait until the work request reaches a certain state. Multiple states can be specified, returning on the first state. For example, --wait-for-state SUCCEEDED --wait-for-state FAILED would return on whichever lifecycle state is reached first. If timeout is reached, a return code of 2 is returned. For any other error, a return code of 1 is returned.
Accepted values are:
ACCEPTED, CANCELLED, CANCELLING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
-
--wait-interval-seconds[integer]¶
Check every --wait-interval-seconds to see whether the work request has reached the state defined by --wait-for-state. Defaults to 30 seconds.
Global Parameters¶
Use oci --help for help on global parameters.
--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --connection-timeout, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --proxy, --query, --raw-output, --read-timeout, --realm-specific-endpoint, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v
Example using required parameter¶
Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” and replacing the example parameters with your own.
Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration and appropriate security policies before trying the examples.
export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dif/stack/create.html#cmdoption-compartment-id
export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dif/stack/create.html#cmdoption-display-name
export services=<substitute-value-of-services> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dif/stack/create.html#cmdoption-services
export stack_templates=<substitute-value-of-stack_templates> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dif/stack/create.html#cmdoption-stack-templates
oci dif stack create --compartment-id $compartment_id --display-name $display_name --services $services --stack-templates $stack_templates