Class: Aws::CloudDirectory::Types::CreateIndexRequest

Inherits:

Struct

• Object
• Struct
• Aws::CloudDirectory::Types::CreateIndexRequest

Includes:

Structure

Defined in:

lib/aws-sdk-clouddirectory/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #directory_arn ⇒ String

  The ARN of the directory where the index should be created.

• #is_unique ⇒ Boolean

  Indicates whether the attribute that is being indexed has unique values or not.

• #link_name ⇒ String

  The name of the link between the parent object and the index object.

• #ordered_indexed_attribute_list ⇒ Array<Types::AttributeKey>

  Specifies the attributes that should be indexed on.

• #parent_reference ⇒ Types::ObjectReference

  A reference to the parent object that contains the index object.

Instance Attribute Details

#directory_arn ⇒ String

The ARN of the directory where the index should be created.

Returns:

• (String)

# File 'lib/aws-sdk-clouddirectory/types.rb', line 2207

class CreateIndexRequest < Struct.new(
  :directory_arn,
  :ordered_indexed_attribute_list,
  :is_unique,
  :parent_reference,
  :link_name)
  SENSITIVE = []
  include Aws::Structure
end

#is_unique ⇒ Boolean

Indicates whether the attribute that is being indexed has unique values or not.

Returns:

• (Boolean)

# File 'lib/aws-sdk-clouddirectory/types.rb', line 2207

class CreateIndexRequest < Struct.new(
  :directory_arn,
  :ordered_indexed_attribute_list,
  :is_unique,
  :parent_reference,
  :link_name)
  SENSITIVE = []
  include Aws::Structure
end

#link_name ⇒ String

The name of the link between the parent object and the index object.

Returns:

• (String)

# File 'lib/aws-sdk-clouddirectory/types.rb', line 2207

class CreateIndexRequest < Struct.new(
  :directory_arn,
  :ordered_indexed_attribute_list,
  :is_unique,
  :parent_reference,
  :link_name)
  SENSITIVE = []
  include Aws::Structure
end

#ordered_indexed_attribute_list ⇒ Array<Types::AttributeKey>

Specifies the attributes that should be indexed on. Currently only a single attribute is supported.

Returns:

• (Array<Types::AttributeKey>)

# File 'lib/aws-sdk-clouddirectory/types.rb', line 2207

class CreateIndexRequest < Struct.new(
  :directory_arn,
  :ordered_indexed_attribute_list,
  :is_unique,
  :parent_reference,
  :link_name)
  SENSITIVE = []
  include Aws::Structure
end

#parent_reference ⇒ Types::ObjectReference

A reference to the parent object that contains the index object.

Returns:

• (Types::ObjectReference)

# File 'lib/aws-sdk-clouddirectory/types.rb', line 2207

class CreateIndexRequest < Struct.new(
  :directory_arn,
  :ordered_indexed_attribute_list,
  :is_unique,
  :parent_reference,
  :link_name)
  SENSITIVE = []
  include Aws::Structure
end