Class: Aws::OpenSearchServerless::Types::CreateIndexRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#idString

The unique identifier of the collection in which to create the index.

Returns:

  • (String)


676
677
678
679
680
681
682
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 676

class CreateIndexRequest < Struct.new(
  :id,
  :index_name,
  :index_schema)
  SENSITIVE = []
  include Aws::Structure
end

#index_nameString

The name of the index to create. Index names must be lowercase and can't begin with underscores (_) or hyphens (-).

Returns:

  • (String)


676
677
678
679
680
681
682
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 676

class CreateIndexRequest < Struct.new(
  :id,
  :index_name,
  :index_schema)
  SENSITIVE = []
  include Aws::Structure
end

#index_schemaHash, ...

The JSON schema definition for the index, including field mappings and settings.

Returns:

  • (Hash, Array, String, Numeric, Boolean)


676
677
678
679
680
681
682
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 676

class CreateIndexRequest < Struct.new(
  :id,
  :index_name,
  :index_schema)
  SENSITIVE = []
  include Aws::Structure
end