DeploymentUpdateResponse

edit

`DeploymentUpdateResponse`

edit

A response returned from the Deployment update endpoint

Properties

edit

alias (string): A user-defined alias to use in place of ResourceIds for user-friendly resource URLs
diagnostics (DeploymentDiagnostics): Backend diagnostics. Sent if validation is requested.
id (string, required): The id of the deployment
name (string, required): The name of the deployment
resources (array[DeploymentResource], required): List of resources that are part of the deployment after the update operation.
shutdown_resources (Orphaned): List of resources that have been shut down

Example

edit

{
   "alias" : "string",
   "diagnostics" : {
      "creates" : {
         "apm" : [
            {
               "backend_plan" : {},
               "display_name" : "string",
               "elasticsearch_cluster_ref_id" : "string",
               "ref_id" : "string"
            }
         ],
         "appsearch" : [
            {
               "backend_plan" : {},
               "display_name" : "string",
               "elasticsearch_cluster_ref_id" : "string",
               "ref_id" : "string"
            }
         ],
         "elasticsearch" : [
            {
               "backend_plan" : {},
               "display_name" : "string",
               "ref_id" : "string"
            }
         ],
         "enterprise_search" : [
            {
               "backend_plan" : {},
               "display_name" : "string",
               "elasticsearch_cluster_ref_id" : "string",
               "ref_id" : "string"
            }
         ],
         "kibana" : [
            {
               "backend_plan" : {},
               "display_name" : "string",
               "elasticsearch_cluster_ref_id" : "string",
               "ref_id" : "string"
            }
         ]
      },
      "updates" : {
         "apm" : [
            {
               "backend_plan" : {},
               "display_name" : "string",
               "elasticsearch_cluster_ref_id" : "string",
               "ref_id" : "string"
            }
         ],
         "appsearch" : [
            {
               "backend_plan" : {},
               "display_name" : "string",
               "elasticsearch_cluster_ref_id" : "string",
               "ref_id" : "string"
            }
         ],
         "elasticsearch" : [
            {
               "backend_plan" : {},
               "display_name" : "string",
               "ref_id" : "string"
            }
         ],
         "enterprise_search" : [
            {
               "backend_plan" : {},
               "display_name" : "string",
               "elasticsearch_cluster_ref_id" : "string",
               "ref_id" : "string"
            }
         ],
         "kibana" : [
            {
               "backend_plan" : {},
               "display_name" : "string",
               "elasticsearch_cluster_ref_id" : "string",
               "ref_id" : "string"
            }
         ]
      }
   },
   "id" : "string",
   "name" : "string",
   "resources" : [
      {
         "cloud_id" : "string",
         "credentials" : {
            "password" : "string",
            "username" : "string"
         },
         "elasticsearch_cluster_ref_id" : "string",
         "id" : "string",
         "kind" : "string",
         "ref_id" : "string",
         "region" : "string",
         "secret_token" : "string",
         "warnings" : [
            {
               "code" : "string",
               "message" : "string"
            }
         ]
      }
   ],
   "shutdown_resources" : {
      "apm" : [
         "string"
      ],
      "appsearch" : [
         "string"
      ],
      "elasticsearch" : [
         {
            "dependents" : [
               {
                  "id" : "string",
                  "kind" : "string"
               }
            ],
            "id" : "string"
         }
      ],
      "enterprise_search" : [
         "string"
      ],
      "integrations_server" : [
         "string"
      ],
      "kibana" : [
         "string"
      ]
   }
}

« DeploymentUpdateResources DeploymentUpdateSettings »