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.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:18.138Z")
 @Stability(value=Stable)
public interface CfnIndexProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::Kendra::Index`.

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() `AWS::Kendra::Index.CapacityUnits`.
default String	getDescription() `AWS::Kendra::Index.Description`.
default Object	getDocumentMetadataConfigurations() `AWS::Kendra::Index.DocumentMetadataConfigurations`.
String	getEdition() `AWS::Kendra::Index.Edition`.
String	getName() `AWS::Kendra::Index.Name`.
String	getRoleArn() `AWS::Kendra::Index.RoleArn`.
default Object	getServerSideEncryptionConfiguration() `AWS::Kendra::Index.ServerSideEncryptionConfiguration`.
default List<CfnTag>	getTags() `AWS::Kendra::Index.Tags`.
default String	getUserContextPolicy() `AWS::Kendra::Index.UserContextPolicy`.
default Object	getUserTokenConfigurations() `AWS::Kendra::Index.UserTokenConfigurations`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCapacityUnits

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

`AWS::Kendra::Index.CapacityUnits`.

getDescription

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

`AWS::Kendra::Index.Description`.

getDocumentMetadataConfigurations

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

`AWS::Kendra::Index.DocumentMetadataConfigurations`.

getEdition

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

`AWS::Kendra::Index.Edition`.

getName

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

`AWS::Kendra::Index.Name`.

getRoleArn

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

`AWS::Kendra::Index.RoleArn`.

getServerSideEncryptionConfiguration

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

`AWS::Kendra::Index.ServerSideEncryptionConfiguration`.

getTags

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

`AWS::Kendra::Index.Tags`.

getUserContextPolicy

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

`AWS::Kendra::Index.UserContextPolicy`.

getUserTokenConfigurations

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

`AWS::Kendra::Index.UserTokenConfigurations`.

builder

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

Returns:

a CfnIndexProps.Builder of CfnIndexProps