software.amazon.awscdk.services.kendra

Class CfnIndex

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.kendra.CfnIndex

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.168Z")
 @Stability(value=Stable)
public class CfnIndex
extends CfnResource
implements IInspectable

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

Specifies a new Amazon Kendra index. And index is a collection of documents and associated metadata that you want to search for relevant documents.

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 of a custom 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 manually 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 that determines the search boost value that a document receives when the key is part of the metadata of a document.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnIndex(software.constructs.Construct scope, 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

Modifier and Type	Method and Description
String	getAttrArn() The Amazon Resource Name (ARN) of the index.
String	getAttrId() The identifier for the index.
Object	getCapacityUnits() Specifies capacity units configured for your index.
protected Map<String,Object>	getCfnProperties()
String	getDescription() A description of the index.
Object	getDocumentMetadataConfigurations() Specifies the properties of an index field.
String	getEdition() Indicates whether the index is a enterprise edition index or a developer edition index.
String	getName() The identifier of the index.
String	getRoleArn() An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics.
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.
String	getUserContextPolicy() The user context policy.
Object	getUserTokenConfigurations() Defines the type of user token used for the index.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCapacityUnits(CfnIndex.CapacityUnitsConfigurationProperty value) Specifies capacity units configured for your index.
void	setCapacityUnits(IResolvable value) Specifies capacity units configured for your index.
void	setDescription(String value) A description of the index.
void	setDocumentMetadataConfigurations(IResolvable value) Specifies the properties of an index field.
void	setDocumentMetadataConfigurations(List<Object> value) Specifies the properties of an index field.
void	setEdition(String value) Indicates whether the index is a enterprise edition index or a developer edition index.
void	setName(String value) The identifier of the index.
void	setRoleArn(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(String value) The user context policy.
void	setUserTokenConfigurations(IResolvable value) Defines the type of user token used for the index.
void	setUserTokenConfigurations(List<Object> value) Defines the type of user token used for the index.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnIndex(@NotNull
                                         software.constructs.Construct scope,
                                         @NotNull
                                         String id,
                                         @NotNull
                                         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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the index.

For example: arn:aws:kendra:us-west-2:111122223333:index/0123456789abcdef .

getAttrId

@Stability(value=Stable)
 @NotNull
public String getAttrId()

The identifier for the index.

For example: f4aeaa10-8056-4b2c-a343-522ca0f41234 .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

getEdition

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
public void setEdition(@NotNull
                                                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

@Stability(value=Stable)
 @NotNull
public String getName()

The identifier of the index.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The identifier of the index.

getRoleArn

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
public void setRoleArn(@NotNull
                                                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

@Stability(value=Stable)
 @Nullable
public Object getCapacityUnits()

Specifies capacity units configured for your index.

You can add and remove capacity units to tune an index to your requirements. You can set capacity units only for Enterprise edition indexes.

setCapacityUnits

@Stability(value=Stable)
public void setCapacityUnits(@Nullable
                                                      CfnIndex.CapacityUnitsConfigurationProperty value)

Specifies capacity units configured for your index.

You can add and remove capacity units to tune an index to your requirements. You can set capacity units only for Enterprise edition indexes.

setCapacityUnits

@Stability(value=Stable)
public void setCapacityUnits(@Nullable
                                                      IResolvable value)

Specifies capacity units configured for your index.

You can add and remove capacity units to tune an index to your requirements. You can set capacity units only for Enterprise edition indexes.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

A description of the index.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description of the index.

getDocumentMetadataConfigurations

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setDocumentMetadataConfigurations(@Nullable
                                                                       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

@Stability(value=Stable)
public void setDocumentMetadataConfigurations(@Nullable
                                                                       List<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

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setServerSideEncryptionConfiguration(@Nullable
                                                                          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.

setServerSideEncryptionConfiguration

@Stability(value=Stable)
public void setServerSideEncryptionConfiguration(@Nullable
                                                                          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.

getUserContextPolicy

@Stability(value=Stable)
 @Nullable
public String getUserContextPolicy()

The user context policy.

ATTRIBUTE_FILTER

• All indexed content is searchable and displayable for all users. If there is an access control list, it is ignored. You can filter on user and group attributes.

USER_TOKEN

• Enables SSO and token-based user access control. All documents with no access control and all documents accessible to the user will be searchable and displayable.

setUserContextPolicy

@Stability(value=Stable)
public void setUserContextPolicy(@Nullable
                                                          String value)

The user context policy.

ATTRIBUTE_FILTER

• All indexed content is searchable and displayable for all users. If there is an access control list, it is ignored. You can filter on user and group attributes.

USER_TOKEN

• Enables SSO and token-based user access control. All documents with no access control and all documents accessible to the user will be searchable and displayable.

getUserTokenConfigurations

@Stability(value=Stable)
 @Nullable
public Object getUserTokenConfigurations()

Defines the type of user token used for the index.

setUserTokenConfigurations

@Stability(value=Stable)
public void setUserTokenConfigurations(@Nullable
                                                                IResolvable value)

Defines the type of user token used for the index.

setUserTokenConfigurations

@Stability(value=Stable)
public void setUserTokenConfigurations(@Nullable
                                                                List<Object> value)

Defines the type of user token used for the index.