stack es ccr put-auto-follow-pattern cli command

elastic stack es ccr put-auto-follow-pattern \
  --name <name> \
  --remote-cluster <remote-cluster> \
  [options]
		

Create or update auto-follow patterns.

--name string required

The name of the collection of auto-follow patterns.

--remote-cluster string required

The remote cluster containing the leader indices to match against.

--master-timeout string

Period to wait for a connection to the master node.

--follow-index-pattern string

The name of follower index. The template {{leader_index}} can be used to derive the name of the follower index from the name of the leader index. When following a data stream, use {{leader_index}}; CCR does not support changes to the names of a follower data stream’s backing indices.

--leader-index-patterns string[]

An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field.

--leader-index-exclusion-patterns string[]

An array of simple index patterns that can be used to exclude indices from being auto-followed. Indices in the remote cluster whose names are matching one or more leader_index_patterns and one or more leader_index_exclusion_patterns won’t be followed.

--max-outstanding-read-requests number

The maximum number of outstanding reads requests from the remote cluster.

--settings string

Settings to override from the leader index. Note that certain settings can not be overrode (e.g., index.number_of_shards).

--max-outstanding-write-requests number

The maximum number of outstanding reads requests from the remote cluster.

--read-poll-timeout string

The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. Then the follower will immediately attempt to read from the leader again.

--max-read-request-operation-count number

The maximum number of operations to pull per read from the remote cluster.

--max-read-request-size number

The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.

--max-retry-delay string

The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying.

--max-write-buffer-count number

The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the number of queued operations goes below the limit.

--max-write-buffer-size number

The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the total bytes of queued operations goes below the limit.

--max-write-request-operation-count number

The maximum number of operations per bulk write request executed on the follower.

--max-write-request-size number

The maximum total bytes of operations per bulk write request executed on the follower.

--input-file string

path to a JSON file to use as command input

-V --[no-]version

Print the Elastic CLI version

--config-file string

path to a config file (default: ~/.elasticrc.yml)

--use-context string

override the active context from the config file

--command-profile string

restrict available commands to a deployment profile (serverless, stack, default)

--[no-]json

output as JSON

--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}}")

--[no-]dry-run

validate all inputs and exit without performing any action (preview changes without applying them)