stack kb fleet-cloud-onboarding-instances put-fleet-cloud-onboarding-deployments-id cli command
elastic stack kb fleet-cloud-onboarding-instances put-fleet-cloud-onboarding-deployments-id \
--id <id> \
[options]
Update cloud onboarding instance
Behaviour flags:
--dry-run — validate all inputs and exit without performing any action
--idstringrequired- The saved object ID of the cloud onboarding instance.
--agent-policy-idsstring[]-
Agent policy IDs for agent_based deployments. Single-element for new-policy deploys; multiple for existing-policy deploys targeting several policies.
Repeatable: pass
--agent-policy-idsmultiple times to supply more than one value --api-key-idstring--attempt-countnumber- Incremented by callers performing a retry.
--auth-methodenum-
Authentication method. Refreshed on each successful deploy so a credential-method change between deploys is reflected on resume.
Values: identity_federation, static_keys, temporary_keys, shared_credentials, assume_role
--connector-idstring--dedicated-namespace-templates- Whether the global namespace uses dedicated index templates. Omit it to keep the stored value. Applied to the installed packages after a deployment.
--deployment-idstring- CFN stack ARN (or equivalent); provided by the client after manual deployment.
--deployment-namestring--descriptionstring- Integration description from the Service settings step. Send null to clear it.
--ecf-stacksstring[]-
ECF CloudFormation stacks to record for this deployment.
Repeatable: pass
--ecf-stacksmultiple times to supply more than one value --instancesstring[]-
Service instances, including duplicates, from the last deployment. Replaces the stored list, so instances removed since the last deployment are dropped.
Repeatable: pass
--instancesmultiple times to supply more than one value --integration-namestring- Integration name used by the last deploy, before any per-package suffix. Refreshed on each deploy because an unedited default name follows the service selection.
--mechanismsstring[]-
Delivery mechanisms active in this deployment. Replaces the stored mechanisms array.
Repeatable: pass
--mechanismsmultiple times to supply more than one value --namespacestring- Global data stream namespace from the Service settings step. Omit it to keep the stored value, or send null to clear it. When none is set, an agent-based deployment inherits the agent policy namespace, other deployment methods use the default namespace.
--package-namesstring[]-
Names of the integration packages this deployment covers. Refreshed with the service set.
Repeatable: pass
--package-namesmultiple times to supply more than one value --package-policy-idsstring[]-
Integration policy IDs created for this deployment (managed_integration and agent_based).
Repeatable: pass
--package-policy-idsmultiple times to supply more than one value --policy-ids-by-instancestring--policy-settingsstring- Integration policy settings that apply to every integration policy of the deployment, keyed by integration policy field (for example
output_id). Replaces the stored settings; omit it to keep them. --service-namesstring- Display name of each service as shown in the onboarding flow, by service ID.
--servicesstring[]-
Current service set for this deployment. Refreshed on each successful deploy so resume after an incremental service addition restores all deployed services.
Repeatable: pass
--servicesmultiple times to supply more than one value --service-varsstring- Per-service config keyed by instance ID.
--statusenum-
Deployment status.
Values: pending, deploying, succeeded, failed
--status-messagestring- Error context; set when transitioning to failed.
--input-filestring- path to a JSON file to use as command input
--dry-run- validate all inputs and exit without performing any action (preview changes without applying them)
--no-validate- skip input validation and send the request as-is
--output-fieldsstring- comma-separated list of fields to include in output (dot-notation supported)
--output-templatestring- Mustache-like template for custom text output (e.g. "{{id}}: {{name}}")
--json-
output as JSON