Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Note
This information applies to Databricks CLI versions 0.205 and above. The Databricks CLI is in Public Preview.
Databricks CLI use is subject to the Databricks License and Databricks Privacy Notice, including any Usage Data provisions.
The instance-profiles command group within the Databricks CLI allows admins to add, list, and remove instance profiles that users can launch clusters with. Regular users can list the instance profiles available to them.
databricks instance-profiles add
Register an instance profile.
databricks instance-profiles add INSTANCE_PROFILE_ARN [flags]
Arguments
INSTANCE_PROFILE_ARN
The AWS ARN of the instance profile to register with Databricks. This field is required.
Options
--iam-role-arn string
The AWS IAM role ARN of the role associated with the instance profile.
--is-meta-instance-profile
Boolean flag indicating whether the instance profile should only be used in credential passthrough scenarios.
--json JSON
The inline JSON string or the @path to the JSON file with the request body.
--skip-validation
By default, Databricks validates that it has sufficient permissions to launch instances with the instance profile.
databricks instance-profiles edit
Edit an instance profile.
databricks instance-profiles edit INSTANCE_PROFILE_ARN [flags]
Arguments
INSTANCE_PROFILE_ARN
The AWS ARN of the instance profile to register with Databricks. This field is required.
Options
--iam-role-arn string
The AWS IAM role ARN of the role associated with the instance profile.
--is-meta-instance-profile
Boolean flag indicating whether the instance profile should only be used in credential passthrough scenarios.
--json JSON
The inline JSON string or the @path to the JSON file with the request body.
databricks instance-profiles list
List the instance profiles that the calling user can use to launch a cluster.
databricks instance-profiles list [flags]
Arguments
None
Options
databricks instance-profiles remove
Remove the instance profile with the provided ARN. Existing clusters with this instance profile will continue to function.
databricks instance-profiles remove INSTANCE_PROFILE_ARN [flags]
Arguments
INSTANCE_PROFILE_ARN
The ARN of the instance profile to remove. This field is required.
Options
--json JSON
The inline JSON string or the @path to the JSON file with the request body.
Global flags
--debug
Whether to enable debug logging.
-h or --help
Display help for the Databricks CLI or the related command group or the related command.
--log-file string
A string representing the file to write output logs to. If this flag is not specified then the default is to write output logs to stderr.
--log-format format
The log format type, text or json. The default value is text.
--log-level string
A string representing the log format level. If not specified then the log format level is disabled.
-o, --output type
The command output type, text or json. The default value is text.
-p, --profile string
The name of the profile in the ~/.databrickscfg file to use to run the command. If this flag is not specified then if it exists, the profile named DEFAULT is used.
--progress-format format
The format to display progress logs: default, append, inplace, or json
-t, --target string
If applicable, the bundle target to use