Type to search.

stack kb fleet-cloud-onboarding-deployments put-fleet-cloud-onboarding-deployments-id cli command

Serverless Preview

Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud.

Availability

  • Preview

    This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply.

Serverless interfaces and procedures might differ from classic Elastic Stack deployments.

Stack Preview

The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.

Availability

  • Preview

    This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply.

Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.

This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Auth required Idempotent Scope: global
Shell
elastic stack kb fleet-cloud-onboarding-deployments put-fleet-cloud-onboarding-deployments-id \
  --id <id> \
  [options]

Update cloud onboarding deployment

Behaviour flags:

--dry-run — validate all inputs and exit without performing any action

--id string required
The saved object ID of the cloud onboarding deployment.
--agent-policy-ids string[]

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-ids multiple times to supply more than one value

--api-key-id string
--attempt-count number
Incremented by callers performing a retry.
--auth-method enum

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-id string
--deployment-id string
CFN stack ARN (or equivalent); provided by the client after manual deployment.
--deployment-name string
--ecf-stacks string[]

ECF CloudFormation stacks to record for this deployment.

Repeatable: pass --ecf-stacks multiple times to supply more than one value

--mechanisms string[]

Delivery mechanisms active in this deployment. Replaces the stored mechanisms array.

Repeatable: pass --mechanisms multiple times to supply more than one value

--package-policy-ids string[]

Package policy IDs created for this deployment (managed_integration and agent_based).

Repeatable: pass --package-policy-ids multiple times to supply more than one value

--policy-ids-by-instance string
--services string[]

Current service set for this deployment. Refreshed on each successful deploy so resume after an incremental service addition restores all deployed services.

Repeatable: pass --services multiple times to supply more than one value

--service-vars string
Per-service config keyed by instance ID.
--status enum

Deployment status.

Values: pending, deploying, succeeded, failed

--status-message string
Error context; set when transitioning to failed.
--input-file string
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-fields string
comma-separated list of fields to include in output (dot-notation supported)
--output-template string
Mustache-like template for custom text output (e.g. "{{id}}: {{name}}")
--json

output as JSON