[[reference-ccr-follow]]

////////
===========================================================================================================================
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
||        ██████╗ ███████╗ █████╗ ██████╗ ███╗   ███╗███████╗                                                            ||
||        ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝                                                            ||
||        ██████╔╝█████╗  ███████║██║  ██║██╔████╔██║█████╗                                                              ||
||        ██╔══██╗██╔══╝  ██╔══██║██║  ██║██║╚██╔╝██║██╔══╝                                                              ||
||        ██║  ██║███████╗██║  ██║██████╔╝██║ ╚═╝ ██║███████╗                                                            ||
||        ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝ ╚═╝     ╚═╝╚══════╝                                                            ||
||                                                                                                                       ||
||                                                                                                                       ||
||    This file is autogenerated, DO NOT send pull requests that changes this file directly.                             ||
||    You should update the script that does the generation, which can be found in:                                      ||
||    https://github.com/elastic/elastic-client-generator-js                                                             ||
||                                                                                                                       ||
||    You can run the script with the following command:                                                                 ||
||       npm run elasticsearch -- --version <version>                                                                    ||
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
===========================================================================================================================
////////

[discrete]
=== client.ccr.follow

Creates a new follower index configured to follow the referenced leader index.

{ref}/ccr-put-follow.html[{es} documentation]

[discrete]
==== Function signature

[source,ts]
----
(CcrFollowRequest, options?): Promise<CcrFollowResponse>
----

[discrete]
===== `CcrFollowRequest`

[source,ts]
----
interface CcrFollowRequest extends <<shared-type-request-base, RequestBase>> {
  index: <<shared-type-index-name, IndexName>>
  wait_for_active_shards?: <<shared-type-wait-for-active-shards, WaitForActiveShards>>
  leader_index?: <<shared-type-index-name, IndexName>>
  max_outstanding_read_requests?: <<shared-type-long, long>>
  max_outstanding_write_requests?: <<shared-type-long, long>>
  max_read_request_operation_count?: <<shared-type-long, long>>
  max_read_request_size?: string
  max_retry_delay?: <<shared-type-duration, Duration>>
  max_write_buffer_count?: <<shared-type-long, long>>
  max_write_buffer_size?: string
  max_write_request_operation_count?: <<shared-type-long, long>>
  max_write_request_size?: string
  read_poll_timeout?: <<shared-type-duration, Duration>>
  remote_cluster?: string
}
----

[discrete]
===== `CcrFollowResponse`

[source,ts]
----
interface CcrFollowResponse {
  follow_index_created: boolean
  follow_index_shards_acked: boolean
  index_following_started: boolean
}
----