software.amazon.awscdk.services.kendra

Interface CfnIndexProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIndexProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.183Z")
 @Stability(value=Stable)
public interface CfnIndexProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnIndex`.

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.*;
 CfnIndexProps cfnIndexProps = CfnIndexProps.builder()
         .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	Interface and Description
static class	CfnIndexProps.Builder A builder for CfnIndexProps
static class	CfnIndexProps.Jsii$Proxy An implementation for CfnIndexProps

Method Summary

Modifier and Type	Method and Description
static CfnIndexProps.Builder	builder()
default Object	getCapacityUnits() Specifies capacity units configured for your index.
default String	getDescription() A description of the index.
default 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.
default Object	getServerSideEncryptionConfiguration() The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra.
default List<CfnTag>	getTags() An array of key-value pairs to apply to this resource.
default String	getUserContextPolicy() The user context policy.
default Object	getUserTokenConfigurations() Defines the type of user token used for the index.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getEdition

@Stability(value=Stable)
 @NotNull
String getEdition()

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
String getName()

The identifier of the index.

getRoleArn

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

getCapacityUnits

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

getDescription

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

A description of the index.

getDocumentMetadataConfigurations

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

getServerSideEncryptionConfiguration

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

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

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

For more information, see Tag .

getUserContextPolicy

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

getUserTokenConfigurations

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

Defines the type of user token used for the index.

builder

@Stability(value=Stable)
static CfnIndexProps.Builder builder()

Returns:

a CfnIndexProps.Builder of CfnIndexProps