class CfnIndexPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.S3Vectors.Mixins.CfnIndexPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awss3vectors/mixins#CfnIndexPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.s3vectors.mixins.CfnIndexPropsMixin
Python	aws_cdk.mixins_preview.aws_s3vectors.mixins.CfnIndexPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_s3vectors » mixins » CfnIndexPropsMixin

Implements IMixin

Extends Mixin

The AWS::S3Vectors::Index resource defines a vector index within an Amazon S3 vector bucket.

For more information, see Creating a vector index in a vector bucket in the Amazon Simple Storage Service User Guide .

You must specify either VectorBucketName or VectorBucketArn to identify the bucket that contains the index.

To control how AWS CloudFormation handles the vector index when the stack is deleted, you can set a deletion policy for your index. You can choose to retain the index or to delete the index. For more information, see DeletionPolicy attribute .

• Permissions - The required permissions for CloudFormation to use are based on the operations that are performed on the stack.

• Create

• s3vectors:CreateIndex

• s3vectors:GetIndex

• Read

• s3vectors:GetIndex

• Delete

• s3vectors:DeleteIndex

• s3vectors:GetIndex

• List

• s3vectors:ListIndexes

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as s3vectors_mixins } from '@aws-cdk/mixins-preview/aws-s3vectors';
const cfnIndexPropsMixin = new s3vectors_mixins.CfnIndexPropsMixin({
  dataType: 'dataType',
  dimension: 123,
  distanceMetric: 'distanceMetric',
  encryptionConfiguration: {
    kmsKeyArn: 'kmsKeyArn',
    sseType: 'sseType',
  },
  indexName: 'indexName',
  metadataConfiguration: {
    nonFilterableMetadataKeys: ['nonFilterableMetadataKeys'],
  },
  vectorBucketArn: 'vectorBucketArn',
  vectorBucketName: 'vectorBucketName',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnIndexPropsMixin(props: CfnIndexMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnIndexMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::S3Vectors::Index.

Properties

Name	Type	Description
props	CfnIndexMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnIndexMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.