DeploymentCreateResources

edit

Describes the resources that will belong to a Deployment

Properties

edit
apm (array[ApmPayload])
A list of payloads for APM creation. WARNING: For stack versions 8.0.0 and higher the integrations_server payload should be used instead, as this field becomes deprecated.
appsearch (array[AppSearchPayload])
A list of payloads for AppSearch updates. AppSearch has been replaced by Enterprise Search in the Elastic Stack 7.7 and higher.
elasticsearch (array[ElasticsearchPayload])
A list of payloads for Elasticsearch cluster creation.
enterprise_search (array[EnterpriseSearchPayload])
A list of payloads for Enterprise Search creation.
integrations_server (array[IntegrationsServerPayload])
A list of payloads for Integrations Server creation.
kibana (array[KibanaPayload])
A list of payloads for Kibana creation.

Example

edit
{
   "apm" : [
      {
         "display_name" : "string",
         "elasticsearch_cluster_ref_id" : "string",
         "plan" : {
            "apm" : {
               "docker_image" : "string",
               "system_settings" : {
                  "debug_enabled" : true,
                  "elasticsearch_password" : "string",
                  "elasticsearch_url" : "string",
                  "elasticsearch_username" : "string",
                  "kibana_url" : "string",
                  "secret_token" : "string"
               },
               "user_settings_json" : {},
               "user_settings_override_json" : {},
               "user_settings_override_yaml" : "string",
               "user_settings_yaml" : "string",
               "version" : "string"
            },
            "cluster_topology" : [
               {
                  "apm" : {
                     "docker_image" : "string",
                     "system_settings" : {
                        "debug_enabled" : true,
                        "elasticsearch_password" : "string",
                        "elasticsearch_url" : "string",
                        "elasticsearch_username" : "string",
                        "kibana_url" : "string",
                        "secret_token" : "string"
                     },
                     "user_settings_json" : {},
                     "user_settings_override_json" : {},
                     "user_settings_override_yaml" : "string",
                     "user_settings_yaml" : "string",
                     "version" : "string"
                  },
                  "instance_configuration_id" : "string",
                  "instance_configuration_version" : 0,
                  "size" : {
                     "resource" : "string",
                     "value" : 0
                  },
                  "zone_count" : 0
               }
            ],
            "transient" : {
               "plan_configuration" : {
                  "calm_wait_time" : 0,
                  "cluster_reboot" : "string",
                  "extended_maintenance" : true,
                  "move_allocators" : [
                     {
                        "allocator_down" : true,
                        "from" : "string",
                        "to" : [
                           "string"
                        ]
                     }
                  ],
                  "move_instances" : [
                     {
                        "from" : "string",
                        "instance_down" : true,
                        "to" : [
                           "string"
                        ]
                     }
                  ],
                  "override_failsafe" : true,
                  "preferred_allocator_tags" : {
                     "some_property" : "string"
                  },
                  "preferred_allocators" : [
                     "string"
                  ],
                  "reallocate_instances" : true,
                  "timeout" : 0
               },
               "strategy" : {
                  "autodetect" : {},
                  "grow_and_shrink" : {},
                  "rolling" : {
                     "allow_inline_resize" : true,
                     "group_by" : "string",
                     "shard_init_wait_time" : 0,
                     "skip_synced_flush" : true
                  },
                  "rolling_grow_and_shrink" : {}
               }
            }
         },
         "ref_id" : "string",
         "region" : "string",
         "settings" : {
            "metadata" : {
               "contact_email" : "string",
               "hidden" : true,
               "name" : "string",
               "organization_id" : "string",
               "owner_id" : "string",
               "resources" : {
                  "cpu" : {
                     "boost" : true,
                     "hard_limit" : true
                  }
               },
               "subscription_level" : "string",
               "system_owned" : true
            }
         }
      }
   ],
   "appsearch" : [
      {
         "display_name" : "string",
         "elasticsearch_cluster_ref_id" : "string",
         "plan" : {
            "appsearch" : {
               "docker_image" : "string",
               "system_settings" : {
                  "elasticsearch_password" : "string",
                  "elasticsearch_url" : "string",
                  "elasticsearch_username" : "string",
                  "secret_session_key" : "string"
               },
               "user_settings_json" : {},
               "user_settings_override_json" : {},
               "user_settings_override_yaml" : "string",
               "user_settings_yaml" : "string",
               "version" : "string"
            },
            "cluster_topology" : [
               {
                  "appsearch" : {
                     "docker_image" : "string",
                     "system_settings" : {
                        "elasticsearch_password" : "string",
                        "elasticsearch_url" : "string",
                        "elasticsearch_username" : "string",
                        "secret_session_key" : "string"
                     },
                     "user_settings_json" : {},
                     "user_settings_override_json" : {},
                     "user_settings_override_yaml" : "string",
                     "user_settings_yaml" : "string",
                     "version" : "string"
                  },
                  "instance_configuration_id" : "string",
                  "instance_configuration_version" : 0,
                  "node_type" : {
                     "appserver" : true,
                     "worker" : true
                  },
                  "size" : {
                     "resource" : "string",
                     "value" : 0
                  },
                  "zone_count" : 0
               }
            ],
            "transient" : {
               "plan_configuration" : {
                  "calm_wait_time" : 0,
                  "cluster_reboot" : "string",
                  "extended_maintenance" : true,
                  "move_allocators" : [
                     {
                        "allocator_down" : true,
                        "from" : "string",
                        "to" : [
                           "string"
                        ]
                     }
                  ],
                  "move_instances" : [
                     {
                        "from" : "string",
                        "instance_down" : true,
                        "to" : [
                           "string"
                        ]
                     }
                  ],
                  "override_failsafe" : true,
                  "preferred_allocator_tags" : {
                     "some_property" : "string"
                  },
                  "preferred_allocators" : [
                     "string"
                  ],
                  "reallocate_instances" : true,
                  "timeout" : 0
               },
               "strategy" : {
                  "autodetect" : {},
                  "grow_and_shrink" : {},
                  "rolling" : {
                     "allow_inline_resize" : true,
                     "group_by" : "string",
                     "shard_init_wait_time" : 0,
                     "skip_synced_flush" : true
                  },
                  "rolling_grow_and_shrink" : {}
               }
            }
         },
         "ref_id" : "string",
         "region" : "string",
         "settings" : {
            "metadata" : {
               "contact_email" : "string",
               "hidden" : true,
               "name" : "string",
               "organization_id" : "string",
               "owner_id" : "string",
               "resources" : {
                  "cpu" : {
                     "boost" : true,
                     "hard_limit" : true
                  }
               },
               "subscription_level" : "string",
               "system_owned" : true
            }
         }
      }
   ],
   "elasticsearch" : [
      {
         "display_name" : "string",
         "plan" : {
            "autoscaling_enabled" : true,
            "cluster_topology" : [
               {
                  "autoscaling_max" : {
                     "resource" : "string",
                     "value" : 0
                  },
                  "autoscaling_min" : {
                     "resource" : "string",
                     "value" : 0
                  },
                  "autoscaling_policy_override_json" : {},
                  "autoscaling_tier_override" : true,
                  "elasticsearch" : {
                     "curation" : {
                        "from_instance_configuration_id" : "string",
                        "to_instance_configuration_id" : "string"
                     },
                     "docker_image" : "string",
                     "enabled_built_in_plugins" : [
                        "string"
                     ],
                     "node_attributes" : {
                        "some_property" : "string"
                     },
                     "system_settings" : {
                        "auto_create_index" : true,
                        "default_shards_per_index" : 0,
                        "destructive_requires_name" : true,
                        "enable_close_index" : true,
                        "monitoring_collection_interval" : 0,
                        "monitoring_history_duration" : "string",
                        "reindex_whitelist" : [
                           "string"
                        ],
                        "scripting" : {
                           "expressions_enabled" : true,
                           "file" : {
                              "enabled" : true,
                              "sandbox_mode" : true
                           },
                           "inline" : {
                              "enabled" : true,
                              "sandbox_mode" : true
                           },
                           "mustache_enabled" : true,
                           "painless_enabled" : true,
                           "stored" : {
                              "enabled" : true,
                              "sandbox_mode" : true
                           }
                        },
                        "watcher_trigger_engine" : "string"
                     },
                     "user_bundles" : [
                        {
                           "elasticsearch_version" : "string",
                           "name" : "string",
                           "url" : "string"
                        }
                     ],
                     "user_plugins" : [
                        {
                           "elasticsearch_version" : "string",
                           "name" : "string",
                           "url" : "string"
                        }
                     ],
                     "user_settings_json" : {},
                     "user_settings_override_json" : {},
                     "user_settings_override_yaml" : "string",
                     "user_settings_yaml" : "string",
                     "version" : "string"
                  },
                  "id" : "string",
                  "instance_configuration_id" : "string",
                  "instance_configuration_version" : 0,
                  "memory_per_node" : 0,
                  "node_count_per_zone" : 0,
                  "node_roles" : [
                     "string"
                  ],
                  "node_type" : {
                     "data" : true,
                     "ingest" : true,
                     "master" : true,
                     "ml" : true
                  },
                  "size" : {
                     "resource" : "string",
                     "value" : 0
                  },
                  "topology_element_control" : {
                     "min" : {
                        "resource" : "string",
                        "value" : 0
                     }
                  },
                  "zone_count" : 0
               }
            ],
            "deployment_template" : {
               "id" : "string",
               "version" : "string"
            },
            "elasticsearch" : {
               "curation" : {
                  "from_instance_configuration_id" : "string",
                  "to_instance_configuration_id" : "string"
               },
               "docker_image" : "string",
               "enabled_built_in_plugins" : [
                  "string"
               ],
               "node_attributes" : {
                  "some_property" : "string"
               },
               "system_settings" : {
                  "auto_create_index" : true,
                  "default_shards_per_index" : 0,
                  "destructive_requires_name" : true,
                  "enable_close_index" : true,
                  "monitoring_collection_interval" : 0,
                  "monitoring_history_duration" : "string",
                  "reindex_whitelist" : [
                     "string"
                  ],
                  "scripting" : {
                     "expressions_enabled" : true,
                     "file" : {
                        "enabled" : true,
                        "sandbox_mode" : true
                     },
                     "inline" : {
                        "enabled" : true,
                        "sandbox_mode" : true
                     },
                     "mustache_enabled" : true,
                     "painless_enabled" : true,
                     "stored" : {
                        "enabled" : true,
                        "sandbox_mode" : true
                     }
                  },
                  "watcher_trigger_engine" : "string"
               },
               "user_bundles" : [
                  {
                     "elasticsearch_version" : "string",
                     "name" : "string",
                     "url" : "string"
                  }
               ],
               "user_plugins" : [
                  {
                     "elasticsearch_version" : "string",
                     "name" : "string",
                     "url" : "string"
                  }
               ],
               "user_settings_json" : {},
               "user_settings_override_json" : {},
               "user_settings_override_yaml" : "string",
               "user_settings_yaml" : "string",
               "version" : "string"
            },
            "transient" : {
               "cluster_settings_json" : {},
               "plan_configuration" : {
                  "calm_wait_time" : 0,
                  "cluster_reboot" : "string",
                  "extended_maintenance" : true,
                  "max_snapshot_age" : 0,
                  "max_snapshot_attempts" : 0,
                  "move_allocators" : [
                     {
                        "allocator_down" : true,
                        "from" : "string",
                        "to" : [
                           "string"
                        ]
                     }
                  ],
                  "move_instances" : [
                     {
                        "from" : "string",
                        "instance_down" : true,
                        "to" : [
                           "string"
                        ]
                     }
                  ],
                  "move_only" : true,
                  "override_failsafe" : true,
                  "preferred_allocator_tags" : {
                     "some_property" : "string"
                  },
                  "preferred_allocators" : [
                     "string"
                  ],
                  "reallocate_instances" : true,
                  "skip_data_migration" : true,
                  "skip_post_upgrade_steps" : true,
                  "skip_snapshot" : true,
                  "skip_snapshot_post_major_upgrade" : true,
                  "skip_upgrade_checker" : true,
                  "timeout" : 0
               },
               "remote_clusters" : {
                  "resources" : [
                     {
                        "alias" : "string",
                        "deployment_id" : "string",
                        "elasticsearch_ref_id" : "string",
                        "info" : {
                           "compatible" : true,
                           "connected" : true,
                           "healthy" : true,
                           "trusted" : true,
                           "trusted_back" : true
                        },
                        "skip_unavailable" : true
                     }
                  ]
               },
               "restore_snapshot" : {
                  "repository_config" : {
                     "raw_settings" : {}
                  },
                  "repository_name" : "string",
                  "restore_payload" : {
                     "indices" : [
                        "string"
                     ],
                     "raw_settings" : {}
                  },
                  "snapshot_name" : "string",
                  "source_cluster_id" : "string",
                  "strategy" : "string"
               },
               "strategy" : {
                  "autodetect" : {},
                  "grow_and_shrink" : {},
                  "rolling" : {
                     "allow_inline_resize" : true,
                     "group_by" : "string",
                     "shard_init_wait_time" : 0,
                     "skip_synced_flush" : true
                  },
                  "rolling_grow_and_shrink" : {}
               }
            }
         },
         "ref_id" : "string",
         "region" : "string",
         "settings" : {
            "curation" : {
               "specs" : [
                  {
                     "index_pattern" : "string",
                     "trigger_interval_seconds" : 0
                  }
               ]
            },
            "dedicated_masters_threshold" : 0,
            "keystore_contents" : {
               "secrets" : {
                  "some_property" : {
                     "as_file" : true,
                     "value" : {}
                  }
               }
            },
            "metadata" : {
               "contact_email" : "string",
               "hidden" : true,
               "name" : "string",
               "organization_id" : "string",
               "owner_id" : "string",
               "resources" : {
                  "cpu" : {
                     "boost" : true,
                     "hard_limit" : true
                  }
               },
               "subscription_level" : "string",
               "system_owned" : true
            },
            "monitoring" : {
               "target_cluster_id" : "string"
            },
            "snapshot" : {
               "cron_expression" : "string",
               "enabled" : true,
               "interval" : "string",
               "pending_interval" : "string",
               "repository" : {
                  "default" : {},
                  "reference" : {
                     "repository_name" : "string"
                  },
                  "static" : {
                     "repository_type" : "string",
                     "settings" : {}
                  }
               },
               "retention" : {
                  "max_age" : "string",
                  "snapshots" : 0
               },
               "slm" : true,
               "suspended" : [
                  "string"
               ],
               "wait_time_after_snapshotting" : "string"
            },
            "traffic_filter" : {
               "rulesets" : [
                  "string"
               ]
            },
            "trust" : {
               "accounts" : [
                  {
                     "account_id" : "string",
                     "name" : "string",
                     "trust_all" : true,
                     "trust_allowlist" : [
                        "string"
                     ]
                  }
               ],
               "direct" : [
                  {
                     "additional_node_names" : [
                        "string"
                     ],
                     "certificates" : [
                        {
                           "metadata" : {
                              "also_trusted_by" : [
                                 "string"
                              ],
                              "fingerprint" : "string",
                              "valid_from" : "2019-01-01T00:00:00Z",
                              "valid_to" : "2019-01-01T00:00:00Z"
                           },
                           "pem" : "string"
                        }
                     ],
                     "name" : "string",
                     "scope_id" : "string",
                     "trust_all" : true,
                     "trust_allowlist" : [
                        "string"
                     ],
                     "type" : "string",
                     "uid" : "string"
                  }
               ],
               "external" : [
                  {
                     "name" : "string",
                     "trust_all" : true,
                     "trust_allowlist" : [
                        "string"
                     ],
                     "trust_relationship_id" : "string"
                  }
               ]
            }
         }
      }
   ],
   "enterprise_search" : [
      {
         "display_name" : "string",
         "elasticsearch_cluster_ref_id" : "string",
         "plan" : {
            "cluster_topology" : [
               {
                  "allocator_filter" : {},
                  "enterprise_search" : {
                     "docker_image" : "string",
                     "system_settings" : {
                        "elasticsearch_password" : "string",
                        "elasticsearch_url" : "string",
                        "elasticsearch_username" : "string",
                        "secret_session_key" : "string"
                     },
                     "user_settings_json" : {},
                     "user_settings_override_json" : {},
                     "user_settings_override_yaml" : "string",
                     "user_settings_yaml" : "string",
                     "version" : "string"
                  },
                  "instance_configuration_id" : "string",
                  "instance_configuration_version" : 0,
                  "memory_per_node" : {},
                  "node_configuration" : "string",
                  "node_count_per_zone" : {},
                  "node_type" : {
                     "appserver" : true,
                     "connector" : true,
                     "worker" : true
                  },
                  "size" : {
                     "resource" : "string",
                     "value" : 0
                  },
                  "zone_count" : 0
               }
            ],
            "enterprise_search" : {
               "docker_image" : "string",
               "system_settings" : {
                  "elasticsearch_password" : "string",
                  "elasticsearch_url" : "string",
                  "elasticsearch_username" : "string",
                  "secret_session_key" : "string"
               },
               "user_settings_json" : {},
               "user_settings_override_json" : {},
               "user_settings_override_yaml" : "string",
               "user_settings_yaml" : "string",
               "version" : "string"
            },
            "transient" : {
               "plan_configuration" : {
                  "calm_wait_time" : 0,
                  "cluster_reboot" : "string",
                  "extended_maintenance" : true,
                  "move_allocators" : [
                     {
                        "allocator_down" : true,
                        "from" : "string",
                        "to" : [
                           "string"
                        ]
                     }
                  ],
                  "move_instances" : [
                     {
                        "from" : "string",
                        "instance_down" : true,
                        "to" : [
                           "string"
                        ]
                     }
                  ],
                  "override_failsafe" : true,
                  "preferred_allocator_tags" : {
                     "some_property" : "string"
                  },
                  "preferred_allocators" : [
                     "string"
                  ],
                  "reallocate_instances" : true,
                  "timeout" : 0
               },
               "strategy" : {
                  "autodetect" : {},
                  "grow_and_shrink" : {},
                  "rolling" : {
                     "allow_inline_resize" : true,
                     "group_by" : "string",
                     "shard_init_wait_time" : 0,
                     "skip_synced_flush" : true
                  },
                  "rolling_grow_and_shrink" : {}
               }
            }
         },
         "ref_id" : "string",
         "region" : "string",
         "settings" : {
            "metadata" : {
               "contact_email" : "string",
               "hidden" : true,
               "name" : "string",
               "organization_id" : "string",
               "owner_id" : "string",
               "resources" : {
                  "cpu" : {
                     "boost" : true,
                     "hard_limit" : true
                  }
               },
               "subscription_level" : "string",
               "system_owned" : true
            }
         }
      }
   ],
   "integrations_server" : [
      {
         "display_name" : "string",
         "elasticsearch_cluster_ref_id" : "string",
         "plan" : {
            "cluster_topology" : [
               {
                  "instance_configuration_id" : "string",
                  "instance_configuration_version" : 0,
                  "integrations_server" : {
                     "docker_image" : "string",
                     "mode" : "string",
                     "system_settings" : {
                        "debug_enabled" : true,
                        "elasticsearch_password" : "string",
                        "elasticsearch_url" : "string",
                        "elasticsearch_username" : "string",
                        "kibana_url" : "string",
                        "secret_token" : "string"
                     },
                     "user_settings_json" : {},
                     "user_settings_override_json" : {},
                     "user_settings_override_yaml" : "string",
                     "user_settings_yaml" : "string",
                     "version" : "string"
                  },
                  "size" : {
                     "resource" : "string",
                     "value" : 0
                  },
                  "zone_count" : 0
               }
            ],
            "integrations_server" : {
               "docker_image" : "string",
               "mode" : "string",
               "system_settings" : {
                  "debug_enabled" : true,
                  "elasticsearch_password" : "string",
                  "elasticsearch_url" : "string",
                  "elasticsearch_username" : "string",
                  "kibana_url" : "string",
                  "secret_token" : "string"
               },
               "user_settings_json" : {},
               "user_settings_override_json" : {},
               "user_settings_override_yaml" : "string",
               "user_settings_yaml" : "string",
               "version" : "string"
            },
            "transient" : {
               "plan_configuration" : {
                  "calm_wait_time" : 0,
                  "cluster_reboot" : "string",
                  "extended_maintenance" : true,
                  "move_allocators" : [
                     {
                        "allocator_down" : true,
                        "from" : "string",
                        "to" : [
                           "string"
                        ]
                     }
                  ],
                  "move_instances" : [
                     {
                        "from" : "string",
                        "instance_down" : true,
                        "to" : [
                           "string"
                        ]
                     }
                  ],
                  "override_failsafe" : true,
                  "preferred_allocator_tags" : {
                     "some_property" : "string"
                  },
                  "preferred_allocators" : [
                     "string"
                  ],
                  "reallocate_instances" : true,
                  "timeout" : 0
               },
               "strategy" : {
                  "autodetect" : {},
                  "grow_and_shrink" : {},
                  "rolling" : {
                     "allow_inline_resize" : true,
                     "group_by" : "string",
                     "shard_init_wait_time" : 0,
                     "skip_synced_flush" : true
                  },
                  "rolling_grow_and_shrink" : {}
               }
            }
         },
         "ref_id" : "string",
         "region" : "string",
         "settings" : {
            "metadata" : {
               "contact_email" : "string",
               "hidden" : true,
               "name" : "string",
               "organization_id" : "string",
               "owner_id" : "string",
               "resources" : {
                  "cpu" : {
                     "boost" : true,
                     "hard_limit" : true
                  }
               },
               "subscription_level" : "string",
               "system_owned" : true
            }
         }
      }
   ],
   "kibana" : [
      {
         "display_name" : "string",
         "elasticsearch_cluster_ref_id" : "string",
         "plan" : {
            "cluster_topology" : [
               {
                  "instance_configuration_id" : "string",
                  "instance_configuration_version" : 0,
                  "kibana" : {
                     "docker_image" : "string",
                     "system_settings" : {
                        "elasticsearch_password" : "string",
                        "elasticsearch_url" : "string",
                        "elasticsearch_username" : "string"
                     },
                     "user_settings_json" : {},
                     "user_settings_override_json" : {},
                     "user_settings_override_yaml" : "string",
                     "user_settings_yaml" : "string",
                     "version" : "string"
                  },
                  "memory_per_node" : 0,
                  "node_count_per_zone" : 0,
                  "size" : {
                     "resource" : "string",
                     "value" : 0
                  },
                  "zone_count" : 0
               }
            ],
            "kibana" : {
               "docker_image" : "string",
               "system_settings" : {
                  "elasticsearch_password" : "string",
                  "elasticsearch_url" : "string",
                  "elasticsearch_username" : "string"
               },
               "user_settings_json" : {},
               "user_settings_override_json" : {},
               "user_settings_override_yaml" : "string",
               "user_settings_yaml" : "string",
               "version" : "string"
            },
            "transient" : {
               "plan_configuration" : {
                  "calm_wait_time" : 0,
                  "cluster_reboot" : "string",
                  "extended_maintenance" : true,
                  "move_allocators" : [
                     {
                        "allocator_down" : true,
                        "from" : "string",
                        "to" : [
                           "string"
                        ]
                     }
                  ],
                  "move_instances" : [
                     {
                        "from" : "string",
                        "instance_down" : true,
                        "to" : [
                           "string"
                        ]
                     }
                  ],
                  "override_failsafe" : true,
                  "preferred_allocator_tags" : {
                     "some_property" : "string"
                  },
                  "preferred_allocators" : [
                     "string"
                  ],
                  "reallocate_instances" : true,
                  "timeout" : 0
               },
               "strategy" : {
                  "autodetect" : {},
                  "grow_and_shrink" : {},
                  "rolling" : {
                     "allow_inline_resize" : true,
                     "group_by" : "string",
                     "shard_init_wait_time" : 0,
                     "skip_synced_flush" : true
                  },
                  "rolling_grow_and_shrink" : {}
               }
            }
         },
         "ref_id" : "string",
         "region" : "string",
         "settings" : {
            "metadata" : {
               "contact_email" : "string",
               "hidden" : true,
               "name" : "string",
               "organization_id" : "string",
               "owner_id" : "string",
               "resources" : {
                  "cpu" : {
                     "boost" : true,
                     "hard_limit" : true
                  }
               },
               "subscription_level" : "string",
               "system_owned" : true
            }
         }
      }
   ]
}