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

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

Create or update auto-follow patterns.

Behaviour flags:

--dry-run — validate all inputs and exit without performing any action

--remote-cluster string required

The remote cluster containing the leader indices to match against.

--name string required

The name of the collection of auto-follow patterns.

--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.

Repeatable: pass --leader-index-patterns multiple times to supply more than one value

--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.

Repeatable: pass --leader-index-exclusion-patterns multiple times to supply more than one value

--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 string

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 string

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 string

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

--error-trace

When set to true Elasticsearch will include the full stack trace of errors when they occur.

--filter-path string

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.

Repeatable: pass --filter-path multiple times to supply more than one value

--human

When set to true will return statistics in a format suitable for humans. For example "exists_time": "1h" for humans and "exists_time_in_millis": 3600000 for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.

--pretty

If set to true the returned JSON will be "pretty-formatted". Only use this option for debugging only.

--input-file string

path to a JSON file to use as command input

--dry-run

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

--json

output as JSON