NAME

Paws::CloudDirectory::CreateIndex - Arguments for method CreateIndex on Paws::CloudDirectory

DESCRIPTION

This class represents the parameters used for calling the method CreateIndex on the Amazon CloudDirectory service. Use the attributes of this class as arguments to method CreateIndex.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateIndex.

SYNOPSIS

    my $clouddirectory = Paws->service('CloudDirectory');
    my $CreateIndexResponse = $clouddirectory->CreateIndex(
      DirectoryArn                => 'MyArn',
      IsUnique                    => 1,
      OrderedIndexedAttributeList => [
        {
          FacetName => 'MyFacetName',        # min: 1, max: 64
          Name      => 'MyAttributeName',    # min: 1, max: 64
          SchemaArn => 'MyArn',

        },
        ...
      ],
      LinkName        => 'MyLinkName',       # OPTIONAL
      ParentReference => {
        Selector => 'MySelectorObjectReference',    # OPTIONAL
      },    # OPTIONAL
    );

    # Results:
    my $ObjectIdentifier = $CreateIndexResponse->ObjectIdentifier;

    # Returns a L<Paws::CloudDirectory::CreateIndexResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory/CreateIndex

ATTRIBUTES

REQUIRED DirectoryArn => Str

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

REQUIRED IsUnique => Bool

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

LinkName => Str

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

REQUIRED OrderedIndexedAttributeList => ArrayRef[Paws::CloudDirectory::AttributeKey]

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

ParentReference => Paws::CloudDirectory::ObjectReference

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

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateIndex in Paws::CloudDirectory

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues