class CfnIndexPropsMixin

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

Implements IMixin

Extends Mixin

Creates an Amazon Kendra index.

Once the index is active you can add documents to your index using the BatchPutDocument operation or using one of the supported data sources.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-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 kendra_mixins } from '@aws-cdk/mixins-preview/aws-kendra';
const cfnIndexPropsMixin = new kendra_mixins.CfnIndexPropsMixin({
  capacityUnits: {
    queryCapacityUnits: 123,
    storageCapacityUnits: 123,
  },
  description: 'description',
  documentMetadataConfigurations: [{
    name: 'name',
    relevance: {
      duration: 'duration',
      freshness: false,
      importance: 123,
      rankOrder: 'rankOrder',
      valueImportanceItems: [{
        key: 'key',
        value: 123,
      }],
    },
    search: {
      displayable: false,
      facetable: false,
      searchable: false,
      sortable: false,
    },
    type: 'type',
  }],
  edition: 'edition',
  name: 'name',
  roleArn: 'roleArn',
  serverSideEncryptionConfiguration: {
    kmsKeyId: 'kmsKeyId',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  userContextPolicy: 'userContextPolicy',
  userTokenConfigurations: [{
    jsonTokenTypeConfiguration: {
      groupAttributeField: 'groupAttributeField',
      userNameAttributeField: 'userNameAttributeField',
    },
    jwtTokenTypeConfiguration: {
      claimRegex: 'claimRegex',
      groupAttributeField: 'groupAttributeField',
      issuer: 'issuer',
      keyLocation: 'keyLocation',
      secretManagerArn: 'secretManagerArn',
      url: 'url',
      userNameAttributeField: 'userNameAttributeField',
    },
  }],
}, /* 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::Kendra::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.