[[reference-ccr-put_auto_follow_pattern]]

////////
===========================================================================================================================
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
||        ██████╗ ███████╗ █████╗ ██████╗ ███╗   ███╗███████╗                                                            ||
||        ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝                                                            ||
||        ██████╔╝█████╗  ███████║██║  ██║██╔████╔██║█████╗                                                              ||
||        ██╔══██╗██╔══╝  ██╔══██║██║  ██║██║╚██╔╝██║██╔══╝                                                              ||
||        ██║  ██║███████╗██║  ██║██████╔╝██║ ╚═╝ ██║███████╗                                                            ||
||        ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝ ╚═╝     ╚═╝╚══════╝                                                            ||
||                                                                                                                       ||
||                                                                                                                       ||
||    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.putAutoFollowPattern

Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices.

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

[discrete]
==== Function signature

[source,ts]
----
(CcrPutAutoFollowPatternRequest, options?): Promise<CcrPutAutoFollowPatternResponse>
----

[discrete]
===== `CcrPutAutoFollowPatternRequest`

[source,ts]
----
interface CcrPutAutoFollowPatternRequest extends <<shared-type-request-base, RequestBase>> {
  name: <<shared-type-name, Name>>
  remote_cluster: string
  follow_index_pattern?: <<shared-type-index-pattern, IndexPattern>>
  leader_index_patterns?: <<shared-type-index-patterns, IndexPatterns>>
  leader_index_exclusion_patterns?: <<shared-type-index-patterns, IndexPatterns>>
  max_outstanding_read_requests?: <<shared-type-integer, integer>>
  settings?: Record<string, any>
  max_outstanding_write_requests?: <<shared-type-integer, integer>>
  read_poll_timeout?: <<shared-type-duration, Duration>>
  max_read_request_operation_count?: <<shared-type-integer, integer>>
  max_read_request_size?: <<shared-type-byte-size, ByteSize>>
  max_retry_delay?: <<shared-type-duration, Duration>>
  max_write_buffer_count?: <<shared-type-integer, integer>>
  max_write_buffer_size?: <<shared-type-byte-size, ByteSize>>
  max_write_request_operation_count?: <<shared-type-integer, integer>>
  max_write_request_size?: <<shared-type-byte-size, ByteSize>>
}
----

[discrete]
===== `CcrPutAutoFollowPatternResponse`

[source,ts]
----
type CcrPutAutoFollowPatternResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
----