Class: Aws::QBusiness::Types::CreateIndexRequest

Inherits:

Struct

• Object
• Struct
• Aws::QBusiness::Types::CreateIndexRequest

Includes:

Structure

Defined in:

lib/aws-sdk-qbusiness/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #application_id ⇒ String

  The identifier of the Amazon Q Business application using the index.

• #capacity_configuration ⇒ Types::IndexCapacityConfiguration

  The capacity units you want to provision for your index.

• #client_token ⇒ String

  A token that you provide to identify the request to create an index.

• #description ⇒ String

  A description for the Amazon Q Business index.

• #display_name ⇒ String

  A name for the Amazon Q Business index.

• #tags ⇒ Array<Types::Tag>

  A list of key-value pairs that identify or categorize the index.

• #type ⇒ String

  The index type that’s suitable for your needs.

Instance Attribute Details

#application_id ⇒ String

The identifier of the Amazon Q Business application using the index.

Returns:

• (String)

# File 'lib/aws-sdk-qbusiness/types.rb', line 1938

class CreateIndexRequest < Struct.new(
  :application_id,
  :display_name,
  :description,
  :type,
  :tags,
  :capacity_configuration,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#capacity_configuration ⇒ Types::IndexCapacityConfiguration

The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.

Returns:

• (Types::IndexCapacityConfiguration)

# File 'lib/aws-sdk-qbusiness/types.rb', line 1938

class CreateIndexRequest < Struct.new(
  :application_id,
  :display_name,
  :description,
  :type,
  :tags,
  :capacity_configuration,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

A token that you provide to identify the request to create an index. Multiple calls to the ‘CreateIndex` API with the same client token will create only one index.

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

Returns:

• (String)

# File 'lib/aws-sdk-qbusiness/types.rb', line 1938

class CreateIndexRequest < Struct.new(
  :application_id,
  :display_name,
  :description,
  :type,
  :tags,
  :capacity_configuration,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description for the Amazon Q Business index.

Returns:

• (String)

# File 'lib/aws-sdk-qbusiness/types.rb', line 1938

class CreateIndexRequest < Struct.new(
  :application_id,
  :display_name,
  :description,
  :type,
  :tags,
  :capacity_configuration,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#display_name ⇒ String

A name for the Amazon Q Business index.

Returns:

• (String)

# File 'lib/aws-sdk-qbusiness/types.rb', line 1938

class CreateIndexRequest < Struct.new(
  :application_id,
  :display_name,
  :description,
  :type,
  :tags,
  :capacity_configuration,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-qbusiness/types.rb', line 1938

class CreateIndexRequest < Struct.new(
  :application_id,
  :display_name,
  :description,
  :type,
  :tags,
  :capacity_configuration,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The index type that’s suitable for your needs. For more information on what’s included in each type of index, see [Amazon Q Business tiers].

[1]: docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#index-tiers

Returns:

• (String)

# File 'lib/aws-sdk-qbusiness/types.rb', line 1938

class CreateIndexRequest < Struct.new(
  :application_id,
  :display_name,
  :description,
  :type,
  :tags,
  :capacity_configuration,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end