You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass CreateIndexRequest data as a hash:

{
  directory_arn: "Arn", # required
  ordered_indexed_attribute_list: [ # required
    {
      schema_arn: "Arn", # required
      facet_name: "FacetName", # required
      name: "AttributeName", # required
    },
  ],
  is_unique: false, # required
  parent_reference: {
    selector: "SelectorObjectReference",
  },
  link_name: "LinkName",
}

Instance Attribute Summary collapse

Instance Attribute Details

#directory_arnString

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

Returns:

  • (String)


3322
3323
3324
3325
3326
3327
3328
3329
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 3322

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

#is_uniqueBoolean

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

Returns:

  • (Boolean)


3322
3323
3324
3325
3326
3327
3328
3329
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 3322

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

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

Returns:

  • (String)


3322
3323
3324
3325
3326
3327
3328
3329
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 3322

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

#ordered_indexed_attribute_listArray<Types::AttributeKey>

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

Returns:



3322
3323
3324
3325
3326
3327
3328
3329
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 3322

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

#parent_referenceTypes::ObjectReference

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



3322
3323
3324
3325
3326
3327
3328
3329
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 3322

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