A newer version is available. For the latest information, see the
current release documentation.
IntegrationsServerPayload
edit
An Integrations Server creation request paired with the alias of the Elasticsearch cluster it should be paired with
Propertiesedit
-
display_name
(string
) - The human readable name for the Integrations Server cluster (default: takes the name of its Elasticsearch cluster)
-
elasticsearch_cluster_ref_id
(string
, required) - Alias to the Elasticsearch Cluster to attach the Integrations Server to
-
plan
(IntegrationsServerPlan
, required) - The plan for the Integrations Server.
-
ref_id
(string
, required) - A locally-unique user-specified id for the Integrations Server
-
region
(string
, required) - The region where this resource exists
-
settings
(IntegrationsServerSettings
) - The settings for building this Integrations Server cluster
Exampleedit
{ "display_name" : "string", "elasticsearch_cluster_ref_id" : "string", "plan" : { "cluster_topology" : [ { "instance_configuration_id" : "string", "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_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 } } }