Class CfnIndexMixinProps

Properties for CfnIndexPropsMixin.

Inheritance

object

CfnIndexMixinProps

Implements

ICfnIndexMixinProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.S3Vectors

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnIndexMixinProps : ICfnIndexMixinProps

Syntax (vb)

Public Class CfnIndexMixinProps Implements ICfnIndexMixinProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.S3Vectors;

             var cfnIndexMixinProps = new CfnIndexMixinProps {
                 DataType = "dataType",
                 Dimension = 123,
                 DistanceMetric = "distanceMetric",
                 EncryptionConfiguration = new EncryptionConfigurationProperty {
                     KmsKeyArn = "kmsKeyArn",
                     SseType = "sseType"
                 },
                 IndexName = "indexName",
                 MetadataConfiguration = new MetadataConfigurationProperty {
                     NonFilterableMetadataKeys = new [] { "nonFilterableMetadataKeys" }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 VectorBucketArn = "vectorBucketArn",
                 VectorBucketName = "vectorBucketName"
             };

Synopsis

Constructors

CfnIndexMixinProps()

Properties for CfnIndexPropsMixin.

Properties

DataType	The data type of the vectors to be inserted into the vector index.
Dimension	The dimensions of the vectors to be inserted into the vector index.
DistanceMetric	The distance metric to be used for similarity search. Valid values are:.
EncryptionConfiguration	The encryption configuration for a vector index.
IndexName	The name of the vector index to create.
MetadataConfiguration	The metadata configuration for the vector index.
Tags	User tags (key-value pairs) to associate with the index.
VectorBucketArn	The Amazon Resource Name (ARN) of the vector bucket that contains the vector index.
VectorBucketName	The name of the vector bucket that contains the vector index.

Constructors

CfnIndexMixinProps()

Properties for CfnIndexPropsMixin.

public CfnIndexMixinProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.S3Vectors;

             var cfnIndexMixinProps = new CfnIndexMixinProps {
                 DataType = "dataType",
                 Dimension = 123,
                 DistanceMetric = "distanceMetric",
                 EncryptionConfiguration = new EncryptionConfigurationProperty {
                     KmsKeyArn = "kmsKeyArn",
                     SseType = "sseType"
                 },
                 IndexName = "indexName",
                 MetadataConfiguration = new MetadataConfigurationProperty {
                     NonFilterableMetadataKeys = new [] { "nonFilterableMetadataKeys" }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 VectorBucketArn = "vectorBucketArn",
                 VectorBucketName = "vectorBucketName"
             };

Properties

DataType

The data type of the vectors to be inserted into the vector index.

public string? DataType { get; set; }

Property Value

string

Remarks

Currently, only float32 is supported, which represents 32-bit floating-point numbers.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#cfn-s3vectors-index-datatype

Dimension

The dimensions of the vectors to be inserted into the vector index.

public double? Dimension { get; set; }

Property Value

double?

Remarks

This value must be between 1 and 4096, inclusive. All vectors stored in the index must have the same number of dimensions.

The dimension value affects the storage requirements and search performance. Higher dimensions require more storage space and may impact search latency.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#cfn-s3vectors-index-dimension

DistanceMetric

The distance metric to be used for similarity search. Valid values are:.

public string? DistanceMetric { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#cfn-s3vectors-index-distancemetric

EncryptionConfiguration

The encryption configuration for a vector index.

public object? EncryptionConfiguration { get; set; }

Property Value

object

Remarks

By default, if you don't specify, all new vectors in the vector index will use the encryption configuration of the vector bucket.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#cfn-s3vectors-index-encryptionconfiguration

Type union: either IResolvable or CfnIndexPropsMixin.IEncryptionConfigurationProperty

IndexName

The name of the vector index to create.

public string? IndexName { get; set; }

Property Value

string

Remarks

The index name must be between 3 and 63 characters long and can contain only lowercase letters, numbers, hyphens (-), and dots (.). The index name must be unique within the vector bucket.

If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the index name.

If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#cfn-s3vectors-index-indexname

MetadataConfiguration

The metadata configuration for the vector index.

public object? MetadataConfiguration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#cfn-s3vectors-index-metadataconfiguration

Type union: either IResolvable or CfnIndexPropsMixin.IMetadataConfigurationProperty

VectorBucketArn

The Amazon Resource Name (ARN) of the vector bucket that contains the vector index.

public string? VectorBucketArn { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#cfn-s3vectors-index-vectorbucketarn

VectorBucketName

The name of the vector bucket that contains the vector index.

public string? VectorBucketName { get; set; }