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.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:18.136Z")
 @Stability(value=Stable)
public class CfnIndex
extends CfnResource
implements IInspectable

A CloudFormation `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.*;
 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 Example:
static interface	CfnIndex.DocumentMetadataConfigurationProperty Example:
static interface	CfnIndex.JsonTokenTypeConfigurationProperty Example:
static interface	CfnIndex.JwtTokenTypeConfigurationProperty Example:
static interface	CfnIndex.RelevanceProperty Example:
static interface	CfnIndex.SearchProperty Example:
static interface	CfnIndex.ServerSideEncryptionConfigurationProperty Example:
static interface	CfnIndex.UserTokenConfigurationProperty Example:
static interface	CfnIndex.ValueImportanceItemProperty Example:

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()
String	getAttrId()
Object	getCapacityUnits() `AWS::Kendra::Index.CapacityUnits`.
protected Map<String,Object>	getCfnProperties()
String	getDescription() `AWS::Kendra::Index.Description`.
Object	getDocumentMetadataConfigurations() `AWS::Kendra::Index.DocumentMetadataConfigurations`.
String	getEdition() `AWS::Kendra::Index.Edition`.
String	getName() `AWS::Kendra::Index.Name`.
String	getRoleArn() `AWS::Kendra::Index.RoleArn`.
Object	getServerSideEncryptionConfiguration() `AWS::Kendra::Index.ServerSideEncryptionConfiguration`.
TagManager	getTags() `AWS::Kendra::Index.Tags`.
String	getUserContextPolicy() `AWS::Kendra::Index.UserContextPolicy`.
Object	getUserTokenConfigurations() `AWS::Kendra::Index.UserTokenConfigurations`.
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) `AWS::Kendra::Index.CapacityUnits`.
void	setCapacityUnits(IResolvable value) `AWS::Kendra::Index.CapacityUnits`.
void	setDescription(String value) `AWS::Kendra::Index.Description`.
void	setDocumentMetadataConfigurations(IResolvable value) `AWS::Kendra::Index.DocumentMetadataConfigurations`.
void	setDocumentMetadataConfigurations(List<Object> value) `AWS::Kendra::Index.DocumentMetadataConfigurations`.
void	setEdition(String value) `AWS::Kendra::Index.Edition`.
void	setName(String value) `AWS::Kendra::Index.Name`.
void	setRoleArn(String value) `AWS::Kendra::Index.RoleArn`.
void	setServerSideEncryptionConfiguration(CfnIndex.ServerSideEncryptionConfigurationProperty value) `AWS::Kendra::Index.ServerSideEncryptionConfiguration`.
void	setServerSideEncryptionConfiguration(IResolvable value) `AWS::Kendra::Index.ServerSideEncryptionConfiguration`.
void	setUserContextPolicy(String value) `AWS::Kendra::Index.UserContextPolicy`.
void	setUserTokenConfigurations(IResolvable value) `AWS::Kendra::Index.UserTokenConfigurations`.
void	setUserTokenConfigurations(List<Object> value) `AWS::Kendra::Index.UserTokenConfigurations`.

Methods inherited from class software.amazon.awscdk.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.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()

getAttrId

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

getCapacityUnits

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

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

setCapacityUnits

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

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

setCapacityUnits

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

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getDescription

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

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

setDescription

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

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

getDocumentMetadataConfigurations

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

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

setDocumentMetadataConfigurations

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

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

setDocumentMetadataConfigurations

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

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

getEdition

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

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

setEdition

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

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

getName

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

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

setName

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

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

getRoleArn

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

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

setRoleArn

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

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

getServerSideEncryptionConfiguration

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

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

setServerSideEncryptionConfiguration

@Stability(value=Stable)
public void setServerSideEncryptionConfiguration(@Nullable
                                                                          CfnIndex.ServerSideEncryptionConfigurationProperty value)

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

setServerSideEncryptionConfiguration

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

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

getTags

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

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

getUserContextPolicy

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

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

setUserContextPolicy

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

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

getUserTokenConfigurations

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

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

setUserTokenConfigurations

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

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

setUserTokenConfigurations

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

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