Skip to contents

Updates index configuration. For pod-based indexes, can change replicas and pod type. For all indexes, can update deletion protection.

Usage

configure_index(
  index_name,
  replicas = NULL,
  pod_type = NULL,
  deletion_protection = NULL
)

Arguments

index_name

Name of the index to configure

replicas

Integer. The desired number of replicas for the index (pod-based only)

pod_type

The new pod type. One of s1, p1, or p2 appended with . and one of x1, x2, x4, or x8 (pod-based only)

deletion_protection

Whether to enable deletion protection ("enabled" or "disabled")

Value

List with http response, content, and status_code

Examples

if (FALSE) { # \dontrun{
# Update pod configuration
configure_index("my-index", replicas = 2, pod_type = "p1.x2")

# Enable deletion protection
configure_index("my-index", deletion_protection = "enabled")
} # }