CfnIndex

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.kendra.CfnIndex

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:37.245Z")
public class CfnIndex
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Kendra::Index`.

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kendra.*;
 CfnIndex cfnIndex = CfnIndex.Builder.create(this, "MyCfnIndex")
         .edition("edition")
         .name("name")
         .roleArn("roleArn")
         // the properties below are optional
         .capacityUnits(CapacityUnitsConfigurationProperty.builder()
                 .queryCapacityUnits(123)
                 .storageCapacityUnits(123)
                 .build())
         .description("description")
         .documentMetadataConfigurations(List.of(DocumentMetadataConfigurationProperty.builder()
                 .name("name")
                 .type("type")
                 // the properties below are optional
                 .relevance(RelevanceProperty.builder()
                         .duration("duration")
                         .freshness(false)
                         .importance(123)
                         .rankOrder("rankOrder")
                         .valueImportanceItems(List.of(ValueImportanceItemProperty.builder()
                                 .key("key")
                                 .value(123)
                                 .build()))
                         .build())
                 .search(SearchProperty.builder()
                         .displayable(false)
                         .facetable(false)
                         .searchable(false)
                         .sortable(false)
                         .build())
                 .build()))
         .serverSideEncryptionConfiguration(ServerSideEncryptionConfigurationProperty.builder()
                 .kmsKeyId("kmsKeyId")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .userContextPolicy("userContextPolicy")
         .userTokenConfigurations(List.of(UserTokenConfigurationProperty.builder()
                 .jsonTokenTypeConfiguration(JsonTokenTypeConfigurationProperty.builder()
                         .groupAttributeField("groupAttributeField")
                         .userNameAttributeField("userNameAttributeField")
                         .build())
                 .jwtTokenTypeConfiguration(JwtTokenTypeConfigurationProperty.builder()
                         .keyLocation("keyLocation")
                         // the properties below are optional
                         .claimRegex("claimRegex")
                         .groupAttributeField("groupAttributeField")
                         .issuer("issuer")
                         .secretManagerArn("secretManagerArn")
                         .url("url")
                         .userNameAttributeField("userNameAttributeField")
                         .build())
                 .build()))
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnIndex.Builder` A fluent builder for `CfnIndex`.
`static interface`	`CfnIndex.CapacityUnitsConfigurationProperty` Specifies additional capacity units configured for your Enterprise Edition index.
`static interface`	`CfnIndex.DocumentMetadataConfigurationProperty` Specifies the properties, such as relevance tuning and searchability, of an index field.
`static interface`	`CfnIndex.JsonTokenTypeConfigurationProperty` Provides the configuration information for the JSON token type.
`static interface`	`CfnIndex.JwtTokenTypeConfigurationProperty` Provides the configuration information for the JWT token type.
`static interface`	`CfnIndex.RelevanceProperty` Provides information for tuning the relevance of a field in a search.
`static interface`	`CfnIndex.SearchProperty` Provides information about how a custom index field is used during a search.
`static interface`	`CfnIndex.ServerSideEncryptionConfigurationProperty` Provides the identifier of the AWS KMS customer master key (CMK) used to encrypt data indexed by Amazon Kendra.
`static interface`	`CfnIndex.UserTokenConfigurationProperty` Provides the configuration information for a token.
`static interface`	`CfnIndex.ValueImportanceItemProperty` Specifies a key-value pair of the search boost value for a document when the key is part of the metadata of a document.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnIndex(Construct scope, java.lang.String id, CfnIndexProps props)` Create a new `AWS::Kendra::Index`.
`protected`	`CfnIndex(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnIndex(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttrArn()` The Amazon Resource Name (ARN) of the index.
`java.lang.String`	`getAttrId()` The identifier for the index.
`java.lang.Object`	`getCapacityUnits()` `AWS::Kendra::Index.CapacityUnits`.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getDescription()` A description for the index.
`java.lang.Object`	`getDocumentMetadataConfigurations()` Specifies the properties of an index field.
`java.lang.String`	`getEdition()` Indicates whether the index is a Enterprise Edition index or a Developer Edition index.
`java.lang.String`	`getName()` The name of the index.
`java.lang.String`	`getRoleArn()` An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics.
`java.lang.Object`	`getServerSideEncryptionConfiguration()` The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra.
`TagManager`	`getTags()` An array of key-value pairs to apply to this resource.
`java.lang.String`	`getUserContextPolicy()` The user context policy.
`java.lang.Object`	`getUserTokenConfigurations()` Defines the type of user token used for the index.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setCapacityUnits(CfnIndex.CapacityUnitsConfigurationProperty value)` `AWS::Kendra::Index.CapacityUnits`.
`void`	`setCapacityUnits(IResolvable value)` `AWS::Kendra::Index.CapacityUnits`.
`void`	`setDescription(java.lang.String value)` A description for the index.
`void`	`setDocumentMetadataConfigurations(IResolvable value)` Specifies the properties of an index field.
`void`	`setDocumentMetadataConfigurations(java.util.List<java.lang.Object> value)` Specifies the properties of an index field.
`void`	`setEdition(java.lang.String value)` Indicates whether the index is a Enterprise Edition index or a Developer Edition index.
`void`	`setName(java.lang.String value)` The name of the index.
`void`	`setRoleArn(java.lang.String value)` An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics.
`void`	`setServerSideEncryptionConfiguration(CfnIndex.ServerSideEncryptionConfigurationProperty value)` The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra.
`void`	`setServerSideEncryptionConfiguration(IResolvable value)` The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra.
`void`	`setUserContextPolicy(java.lang.String value)` The user context policy.
`void`	`setUserTokenConfigurations(IResolvable value)` Defines the type of user token used for the index.
`void`	`setUserTokenConfigurations(java.util.List<java.lang.Object> value)` Defines the type of user token used for the index.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnIndex
```
protected CfnIndex(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnIndex
```
protected CfnIndex(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnIndex
```
public CfnIndex(Construct scope,
                java.lang.String id,
                CfnIndexProps props)
```
    Create a new `AWS::Kendra::Index`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
public void inspect(TreeInspector inspector)
```
    Examines the CloudFormation resource and discloses attributes.
    
    Specified by:
    
    inspect in interface IInspectable
    
    Parameters:
    
    inspector - - tree inspector to collect and process attributes. This parameter is required.
  - renderProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
public java.lang.String getAttrArn()
```
    The Amazon Resource Name (ARN) of the index.
    For example: arn:aws:kendra:us-west-2:111122223333:index/0123456789abcdef .
  - getAttrId
```
public java.lang.String getAttrId()
```
    The identifier for the index.
    For example: f4aeaa10-8056-4b2c-a343-522ca0f41234 .
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    An array of key-value pairs to apply to this resource.
    For more information, see Tag .
  - getEdition
```
public java.lang.String getEdition()
```
    Indicates whether the index is a Enterprise Edition index or a Developer Edition index.
    Valid values are DEVELOPER_EDITION and ENTERPRISE_EDITION .
  - setEdition
```
public void setEdition(java.lang.String value)
```
    Indicates whether the index is a Enterprise Edition index or a Developer Edition index.
    Valid values are DEVELOPER_EDITION and ENTERPRISE_EDITION .
  - getName
```
public java.lang.String getName()
```
    The name of the index.
  - setName
```
public void setName(java.lang.String value)
```
    The name of the index.
  - getRoleArn
```
public java.lang.String getRoleArn()
```
    An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics.
    This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.
  - setRoleArn
```
public void setRoleArn(java.lang.String value)
```
    An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics.
    This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.
  - getCapacityUnits
```
public java.lang.Object getCapacityUnits()
```
    `AWS::Kendra::Index.CapacityUnits`.
  - setCapacityUnits
```
public void setCapacityUnits(IResolvable value)
```
    `AWS::Kendra::Index.CapacityUnits`.
  - setCapacityUnits
```
public void setCapacityUnits(CfnIndex.CapacityUnitsConfigurationProperty value)
```
    `AWS::Kendra::Index.CapacityUnits`.
  - getDescription
```
public java.lang.String getDescription()
```
    A description for the index.
  - setDescription
```
public void setDescription(java.lang.String value)
```
    A description for the index.
  - getDocumentMetadataConfigurations
```
public java.lang.Object getDocumentMetadataConfigurations()
```
    Specifies the properties of an index field.
    You can add either a custom or a built-in field. You can add and remove built-in fields at any time. When a built-in field is removed it's configuration reverts to the default for the field. Custom fields can't be removed from an index after they are added.
  - setDocumentMetadataConfigurations
```
public void setDocumentMetadataConfigurations(IResolvable value)
```
    Specifies the properties of an index field.
    You can add either a custom or a built-in field. You can add and remove built-in fields at any time. When a built-in field is removed it's configuration reverts to the default for the field. Custom fields can't be removed from an index after they are added.
  - setDocumentMetadataConfigurations
```
public void setDocumentMetadataConfigurations(java.util.List<java.lang.Object> value)
```
    Specifies the properties of an index field.
    You can add either a custom or a built-in field. You can add and remove built-in fields at any time. When a built-in field is removed it's configuration reverts to the default for the field. Custom fields can't be removed from an index after they are added.
  - getServerSideEncryptionConfiguration
```
public java.lang.Object getServerSideEncryptionConfiguration()
```
    The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra.
    Amazon Kendra doesn't support asymmetric CMKs.
  - setServerSideEncryptionConfiguration
```
public void setServerSideEncryptionConfiguration(IResolvable value)
```
    The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra.
    Amazon Kendra doesn't support asymmetric CMKs.
  - setServerSideEncryptionConfiguration
```
public void setServerSideEncryptionConfiguration(CfnIndex.ServerSideEncryptionConfigurationProperty value)
```
    The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra.
    Amazon Kendra doesn't support asymmetric CMKs.
  - getUserContextPolicy
```
public java.lang.String getUserContextPolicy()
```
    The user context policy.
    ATTRIBUTE_FILTER
    - All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext .
    USER_TOKEN
    - Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.
  - setUserContextPolicy
```
public void setUserContextPolicy(java.lang.String value)
```
    The user context policy.
    ATTRIBUTE_FILTER
    - All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext .
    USER_TOKEN
    - Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.
  - getUserTokenConfigurations
```
public java.lang.Object getUserTokenConfigurations()
```
    Defines the type of user token used for the index.
  - setUserTokenConfigurations
```
public void setUserTokenConfigurations(IResolvable value)
```
    Defines the type of user token used for the index.
  - setUserTokenConfigurations
```
public void setUserTokenConfigurations(java.util.List<java.lang.Object> value)
```
    Defines the type of user token used for the index.

Class CfnIndex

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnIndex

CfnIndex

CfnIndex

Method Detail

inspect

renderProperties

getAttrArn

getAttrId

getCfnProperties

getTags

getEdition

setEdition

getName

setName

getRoleArn

setRoleArn

getCapacityUnits

setCapacityUnits

setCapacityUnits

getDescription

setDescription

getDocumentMetadataConfigurations

setDocumentMetadataConfigurations

setDocumentMetadataConfigurations

getServerSideEncryptionConfiguration

setServerSideEncryptionConfiguration

setServerSideEncryptionConfiguration

getUserContextPolicy

setUserContextPolicy

getUserTokenConfigurations

setUserTokenConfigurations

setUserTokenConfigurations