Class: Aws::Neptunedata::Types::StartIndexRebuildInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, the SDK automatically generates one.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


3416
3417
3418
3419
3420
3421
3422
3423
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/types.rb', line 3416

class StartIndexRebuildInput < Struct.new(
  :scope,
  :concurrency,
  :write_buffer_size,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#concurrency ⇒ Integer

The number of concurrent indexes to rebuild in parallel. If not specified, defaults to 1.

Valid values are between 1 and the number of vCPUs available on the writer instance. If the value exceeds the available vCPUs, it is capped at the maximum instead of returning an InvalidParameterException. The effective (capped) value is returned in the response.

Higher concurrency can shorten the overall rebuild, but also increases CPU and I/O load during the operation.

Returns:

  • (Integer)


3416
3417
3418
3419
3420
3421
3422
3423
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/types.rb', line 3416

class StartIndexRebuildInput < Struct.new(
  :scope,
  :concurrency,
  :write_buffer_size,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#scope ⇒ String

Specifies the scope of the rebuild operation. Possible values are:

  • ALL - Rebuild all (quads and dictionaries). This is the default if not specified.

  • QUADS - Rebuild only the quad indexes.

  • DICTIONARIES - Rebuild only the dictionaries.

Returns:

  • (String)


3416
3417
3418
3419
3420
3421
3422
3423
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/types.rb', line 3416

class StartIndexRebuildInput < Struct.new(
  :scope,
  :concurrency,
  :write_buffer_size,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#write_buffer_size ⇒ String

Controls the buffer size used for tracking concurrent write operations during the index rebuild. If your database has high write traffic during the rebuild, a larger buffer prevents the operation from failing due to buffer overflow. Possible values are:

  • LOW - Suitable for databases with light to moderate write activity. This is the default.

  • MEDIUM - Recommended for databases with sustained write traffic or bulk loading.

  • HIGH - Use when rebuilding indexes during heavy write workloads or continuous bulk data ingestion.

If your rebuild fails and you are actively writing data to the database, retry with a higher writeBufferSize value. For bulk load operations, consider using HIGH.

Returns:

  • (String)


3416
3417
3418
3419
3420
3421
3422
3423
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/types.rb', line 3416

class StartIndexRebuildInput < Struct.new(
  :scope,
  :concurrency,
  :write_buffer_size,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end