CLI referenceastro deploymentastro deployment connection

astro deployment connection update

This command is only available on Astro.

Update the value for a Deployment’s Airflow variable.

Usage

1astro deployment connection update

This command is recommended for automated workflows. To run this command in an automated process such as a CI/CD pipeline, you can generate an API token, then specify the ASTRO_API_TOKEN environment variable in the system running the Astro CLI:

$export ASTRO_API_TOKEN=<your-token>

See Organization, Workspace, and Deployment API token documentation for more details about ways to use API tokens.

Options

OptionDescriptionPossible Values
-d,--deployment-idThe ID of the Deployment where you want to create a connection.Any valid Deployment ID
--deployment-nameThe name of the Deployment where you want to create a connection. Use as an alternative to <deployment-id>.Any valid Deployment name
-w,--workspace-idCreate a connection for a Deployment that is not in your current Workspace. If not specified, your current Workspace is assumed.Any valid Workspace ID
-i,--conn-idThe connection ID. Required.string
-t,--conn-typeThe connection type. Required.string
--descriptionThe connection description.string
--extraThe extra field configuration, defined as a stringified JSON object.string
--hostThe connection host.string
--loginThe connection login or username.string
--passwordThe connection password.string
--portThe connection port.string
--schemaThe connection schema.string

Examples

$# update connection called my-connection stored in the Deployment with an ID of cl03oiq7d80402nwn7fsl3dmv
>astro deployment connection update --deployment-id cl03oiq7d80402nwn7fsl3dmv --conn-id my-connection --conn-type http
>
># update connections stored in the Deployment "My Deployment"
>astro deployment connection update --deployment-name="My Deployment" --conn-id my-connection --conn-type http