Class CfnDataSource
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.CfnDataSource
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-10-31T19:12:59.999Z")
@Stability(Stable)
public class CfnDataSource
extends CfnResource
implements IInspectable, ITaggable
Creates a data source connector that you want to use with an Amazon Kendra index.
You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector.
CreateDataSource
does not support connectors which require aTemplateConfiguration
object for connecting to Amazon Kendra .
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.*; CfnDataSource cfnDataSource = CfnDataSource.Builder.create(this, "MyCfnDataSource") .indexId("indexId") .name("name") .type("type") // the properties below are optional .customDocumentEnrichmentConfiguration(CustomDocumentEnrichmentConfigurationProperty.builder() .inlineConfigurations(List.of(InlineCustomDocumentEnrichmentConfigurationProperty.builder() .condition(DocumentAttributeConditionProperty.builder() .conditionDocumentAttributeKey("conditionDocumentAttributeKey") .operator("operator") // the properties below are optional .conditionOnValue(DocumentAttributeValueProperty.builder() .dateValue("dateValue") .longValue(123) .stringListValue(List.of("stringListValue")) .stringValue("stringValue") .build()) .build()) .documentContentDeletion(false) .target(DocumentAttributeTargetProperty.builder() .targetDocumentAttributeKey("targetDocumentAttributeKey") // the properties below are optional .targetDocumentAttributeValue(DocumentAttributeValueProperty.builder() .dateValue("dateValue") .longValue(123) .stringListValue(List.of("stringListValue")) .stringValue("stringValue") .build()) .targetDocumentAttributeValueDeletion(false) .build()) .build())) .postExtractionHookConfiguration(HookConfigurationProperty.builder() .lambdaArn("lambdaArn") .s3Bucket("s3Bucket") // the properties below are optional .invocationCondition(DocumentAttributeConditionProperty.builder() .conditionDocumentAttributeKey("conditionDocumentAttributeKey") .operator("operator") // the properties below are optional .conditionOnValue(DocumentAttributeValueProperty.builder() .dateValue("dateValue") .longValue(123) .stringListValue(List.of("stringListValue")) .stringValue("stringValue") .build()) .build()) .build()) .preExtractionHookConfiguration(HookConfigurationProperty.builder() .lambdaArn("lambdaArn") .s3Bucket("s3Bucket") // the properties below are optional .invocationCondition(DocumentAttributeConditionProperty.builder() .conditionDocumentAttributeKey("conditionDocumentAttributeKey") .operator("operator") // the properties below are optional .conditionOnValue(DocumentAttributeValueProperty.builder() .dateValue("dateValue") .longValue(123) .stringListValue(List.of("stringListValue")) .stringValue("stringValue") .build()) .build()) .build()) .roleArn("roleArn") .build()) .dataSourceConfiguration(DataSourceConfigurationProperty.builder() .confluenceConfiguration(ConfluenceConfigurationProperty.builder() .secretArn("secretArn") .serverUrl("serverUrl") .version("version") // the properties below are optional .attachmentConfiguration(ConfluenceAttachmentConfigurationProperty.builder() .attachmentFieldMappings(List.of(ConfluenceAttachmentToIndexFieldMappingProperty.builder() .dataSourceFieldName("dataSourceFieldName") .indexFieldName("indexFieldName") // the properties below are optional .dateFieldFormat("dateFieldFormat") .build())) .crawlAttachments(false) .build()) .blogConfiguration(ConfluenceBlogConfigurationProperty.builder() .blogFieldMappings(List.of(ConfluenceBlogToIndexFieldMappingProperty.builder() .dataSourceFieldName("dataSourceFieldName") .indexFieldName("indexFieldName") // the properties below are optional .dateFieldFormat("dateFieldFormat") .build())) .build()) .exclusionPatterns(List.of("exclusionPatterns")) .inclusionPatterns(List.of("inclusionPatterns")) .pageConfiguration(ConfluencePageConfigurationProperty.builder() .pageFieldMappings(List.of(ConfluencePageToIndexFieldMappingProperty.builder() .dataSourceFieldName("dataSourceFieldName") .indexFieldName("indexFieldName") // the properties below are optional .dateFieldFormat("dateFieldFormat") .build())) .build()) .spaceConfiguration(ConfluenceSpaceConfigurationProperty.builder() .crawlArchivedSpaces(false) .crawlPersonalSpaces(false) .excludeSpaces(List.of("excludeSpaces")) .includeSpaces(List.of("includeSpaces")) .spaceFieldMappings(List.of(ConfluenceSpaceToIndexFieldMappingProperty.builder() .dataSourceFieldName("dataSourceFieldName") .indexFieldName("indexFieldName") // the properties below are optional .dateFieldFormat("dateFieldFormat") .build())) .build()) .vpcConfiguration(DataSourceVpcConfigurationProperty.builder() .securityGroupIds(List.of("securityGroupIds")) .subnetIds(List.of("subnetIds")) .build()) .build()) .databaseConfiguration(DatabaseConfigurationProperty.builder() .columnConfiguration(ColumnConfigurationProperty.builder() .changeDetectingColumns(List.of("changeDetectingColumns")) .documentDataColumnName("documentDataColumnName") .documentIdColumnName("documentIdColumnName") // the properties below are optional .documentTitleColumnName("documentTitleColumnName") .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder() .dataSourceFieldName("dataSourceFieldName") .indexFieldName("indexFieldName") // the properties below are optional .dateFieldFormat("dateFieldFormat") .build())) .build()) .connectionConfiguration(ConnectionConfigurationProperty.builder() .databaseHost("databaseHost") .databaseName("databaseName") .databasePort(123) .secretArn("secretArn") .tableName("tableName") .build()) .databaseEngineType("databaseEngineType") // the properties below are optional .aclConfiguration(AclConfigurationProperty.builder() .allowedGroupsColumnName("allowedGroupsColumnName") .build()) .sqlConfiguration(SqlConfigurationProperty.builder() .queryIdentifiersEnclosingOption("queryIdentifiersEnclosingOption") .build()) .vpcConfiguration(DataSourceVpcConfigurationProperty.builder() .securityGroupIds(List.of("securityGroupIds")) .subnetIds(List.of("subnetIds")) .build()) .build()) .googleDriveConfiguration(GoogleDriveConfigurationProperty.builder() .secretArn("secretArn") // the properties below are optional .excludeMimeTypes(List.of("excludeMimeTypes")) .excludeSharedDrives(List.of("excludeSharedDrives")) .excludeUserAccounts(List.of("excludeUserAccounts")) .exclusionPatterns(List.of("exclusionPatterns")) .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder() .dataSourceFieldName("dataSourceFieldName") .indexFieldName("indexFieldName") // the properties below are optional .dateFieldFormat("dateFieldFormat") .build())) .inclusionPatterns(List.of("inclusionPatterns")) .build()) .oneDriveConfiguration(OneDriveConfigurationProperty.builder() .oneDriveUsers(OneDriveUsersProperty.builder() .oneDriveUserList(List.of("oneDriveUserList")) .oneDriveUserS3Path(S3PathProperty.builder() .bucket("bucket") .key("key") .build()) .build()) .secretArn("secretArn") .tenantDomain("tenantDomain") // the properties below are optional .disableLocalGroups(false) .exclusionPatterns(List.of("exclusionPatterns")) .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder() .dataSourceFieldName("dataSourceFieldName") .indexFieldName("indexFieldName") // the properties below are optional .dateFieldFormat("dateFieldFormat") .build())) .inclusionPatterns(List.of("inclusionPatterns")) .build()) .s3Configuration(S3DataSourceConfigurationProperty.builder() .bucketName("bucketName") // the properties below are optional .accessControlListConfiguration(AccessControlListConfigurationProperty.builder() .keyPath("keyPath") .build()) .documentsMetadataConfiguration(DocumentsMetadataConfigurationProperty.builder() .s3Prefix("s3Prefix") .build()) .exclusionPatterns(List.of("exclusionPatterns")) .inclusionPatterns(List.of("inclusionPatterns")) .inclusionPrefixes(List.of("inclusionPrefixes")) .build()) .salesforceConfiguration(SalesforceConfigurationProperty.builder() .secretArn("secretArn") .serverUrl("serverUrl") // the properties below are optional .chatterFeedConfiguration(SalesforceChatterFeedConfigurationProperty.builder() .documentDataFieldName("documentDataFieldName") // the properties below are optional .documentTitleFieldName("documentTitleFieldName") .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder() .dataSourceFieldName("dataSourceFieldName") .indexFieldName("indexFieldName") // the properties below are optional .dateFieldFormat("dateFieldFormat") .build())) .includeFilterTypes(List.of("includeFilterTypes")) .build()) .crawlAttachments(false) .excludeAttachmentFilePatterns(List.of("excludeAttachmentFilePatterns")) .includeAttachmentFilePatterns(List.of("includeAttachmentFilePatterns")) .knowledgeArticleConfiguration(SalesforceKnowledgeArticleConfigurationProperty.builder() .includedStates(List.of("includedStates")) // the properties below are optional .customKnowledgeArticleTypeConfigurations(List.of(SalesforceCustomKnowledgeArticleTypeConfigurationProperty.builder() .documentDataFieldName("documentDataFieldName") .name("name") // the properties below are optional .documentTitleFieldName("documentTitleFieldName") .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder() .dataSourceFieldName("dataSourceFieldName") .indexFieldName("indexFieldName") // the properties below are optional .dateFieldFormat("dateFieldFormat") .build())) .build())) .standardKnowledgeArticleTypeConfiguration(SalesforceStandardKnowledgeArticleTypeConfigurationProperty.builder() .documentDataFieldName("documentDataFieldName") // the properties below are optional .documentTitleFieldName("documentTitleFieldName") .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder() .dataSourceFieldName("dataSourceFieldName") .indexFieldName("indexFieldName") // the properties below are optional .dateFieldFormat("dateFieldFormat") .build())) .build()) .build()) .standardObjectAttachmentConfiguration(SalesforceStandardObjectAttachmentConfigurationProperty.builder() .documentTitleFieldName("documentTitleFieldName") .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder() .dataSourceFieldName("dataSourceFieldName") .indexFieldName("indexFieldName") // the properties below are optional .dateFieldFormat("dateFieldFormat") .build())) .build()) .standardObjectConfigurations(List.of(SalesforceStandardObjectConfigurationProperty.builder() .documentDataFieldName("documentDataFieldName") .name("name") // the properties below are optional .documentTitleFieldName("documentTitleFieldName") .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder() .dataSourceFieldName("dataSourceFieldName") .indexFieldName("indexFieldName") // the properties below are optional .dateFieldFormat("dateFieldFormat") .build())) .build())) .build()) .serviceNowConfiguration(ServiceNowConfigurationProperty.builder() .hostUrl("hostUrl") .secretArn("secretArn") .serviceNowBuildVersion("serviceNowBuildVersion") // the properties below are optional .authenticationType("authenticationType") .knowledgeArticleConfiguration(ServiceNowKnowledgeArticleConfigurationProperty.builder() .documentDataFieldName("documentDataFieldName") // the properties below are optional .crawlAttachments(false) .documentTitleFieldName("documentTitleFieldName") .excludeAttachmentFilePatterns(List.of("excludeAttachmentFilePatterns")) .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder() .dataSourceFieldName("dataSourceFieldName") .indexFieldName("indexFieldName") // the properties below are optional .dateFieldFormat("dateFieldFormat") .build())) .filterQuery("filterQuery") .includeAttachmentFilePatterns(List.of("includeAttachmentFilePatterns")) .build()) .serviceCatalogConfiguration(ServiceNowServiceCatalogConfigurationProperty.builder() .documentDataFieldName("documentDataFieldName") // the properties below are optional .crawlAttachments(false) .documentTitleFieldName("documentTitleFieldName") .excludeAttachmentFilePatterns(List.of("excludeAttachmentFilePatterns")) .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder() .dataSourceFieldName("dataSourceFieldName") .indexFieldName("indexFieldName") // the properties below are optional .dateFieldFormat("dateFieldFormat") .build())) .includeAttachmentFilePatterns(List.of("includeAttachmentFilePatterns")) .build()) .build()) .sharePointConfiguration(SharePointConfigurationProperty.builder() .secretArn("secretArn") .sharePointVersion("sharePointVersion") .urls(List.of("urls")) // the properties below are optional .crawlAttachments(false) .disableLocalGroups(false) .documentTitleFieldName("documentTitleFieldName") .exclusionPatterns(List.of("exclusionPatterns")) .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder() .dataSourceFieldName("dataSourceFieldName") .indexFieldName("indexFieldName") // the properties below are optional .dateFieldFormat("dateFieldFormat") .build())) .inclusionPatterns(List.of("inclusionPatterns")) .sslCertificateS3Path(S3PathProperty.builder() .bucket("bucket") .key("key") .build()) .useChangeLog(false) .vpcConfiguration(DataSourceVpcConfigurationProperty.builder() .securityGroupIds(List.of("securityGroupIds")) .subnetIds(List.of("subnetIds")) .build()) .build()) .templateConfiguration(TemplateConfigurationProperty.builder() .template("template") .build()) .webCrawlerConfiguration(WebCrawlerConfigurationProperty.builder() .urls(WebCrawlerUrlsProperty.builder() .seedUrlConfiguration(WebCrawlerSeedUrlConfigurationProperty.builder() .seedUrls(List.of("seedUrls")) // the properties below are optional .webCrawlerMode("webCrawlerMode") .build()) .siteMapsConfiguration(WebCrawlerSiteMapsConfigurationProperty.builder() .siteMaps(List.of("siteMaps")) .build()) .build()) // the properties below are optional .authenticationConfiguration(WebCrawlerAuthenticationConfigurationProperty.builder() .basicAuthentication(List.of(WebCrawlerBasicAuthenticationProperty.builder() .credentials("credentials") .host("host") .port(123) .build())) .build()) .crawlDepth(123) .maxContentSizePerPageInMegaBytes(123) .maxLinksPerPage(123) .maxUrlsPerMinuteCrawlRate(123) .proxyConfiguration(ProxyConfigurationProperty.builder() .host("host") .port(123) // the properties below are optional .credentials("credentials") .build()) .urlExclusionPatterns(List.of("urlExclusionPatterns")) .urlInclusionPatterns(List.of("urlInclusionPatterns")) .build()) .workDocsConfiguration(WorkDocsConfigurationProperty.builder() .organizationId("organizationId") // the properties below are optional .crawlComments(false) .exclusionPatterns(List.of("exclusionPatterns")) .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder() .dataSourceFieldName("dataSourceFieldName") .indexFieldName("indexFieldName") // the properties below are optional .dateFieldFormat("dateFieldFormat") .build())) .inclusionPatterns(List.of("inclusionPatterns")) .useChangeLog(false) .build()) .build()) .description("description") .languageCode("languageCode") .roleArn("roleArn") .schedule("schedule") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Specifies access control list files for the documents in a data source.static interface
Provides information about the column that should be used for filtering the query response by groups.static final class
A fluent builder forCfnDataSource
.static interface
Provides information about how Amazon Kendra should use the columns of a database in an index.static interface
Configuration of attachment settings for the Confluence data source.static interface
Maps attributes or field names of Confluence attachments to Amazon Kendra index field names.static interface
Configuration of blog settings for the Confluence data source.static interface
Maps attributes or field names of Confluence blog to Amazon Kendra index field names.static interface
Provides the configuration information to connect to Confluence as your data source.static interface
Configuration of the page settings for the Confluence data source.static interface
Maps attributes or field names of Confluence pages to Amazon Kendra index field names.static interface
Configuration information for indexing Confluence spaces.static interface
Maps attributes or field names of Confluence spaces to Amazon Kendra index field names.static interface
Provides the configuration information that's required to connect to a database.static interface
Provides the configuration information for altering document metadata and content during the document ingestion process.static interface
Provides the configuration information to an Amazon Kendra supported database .static interface
Provides the configuration information for an Amazon Kendra data source.static interface
Maps a column or attribute in the data source to an index field.static interface
Provides the configuration information to connect to an Amazon VPC.static interface
The condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra.static interface
The target document attribute or metadata field you want to alter when ingesting documents into Amazon Kendra.static interface
The value of a document attribute.static interface
Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes.static interface
Provides the configuration information to connect to Google Drive as your data source.static interface
Provides the configuration information for invoking a Lambda function in AWS Lambda to alter document metadata and content when ingesting documents into Amazon Kendra.static interface
Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Kendra.static interface
Provides the configuration information to connect to OneDrive as your data source.static interface
User accounts whose documents should be indexed.static interface
Provides the configuration information for a web proxy to connect to website hosts.static interface
Provides the configuration information to connect to an Amazon S3 bucket.static interface
Information required to find a specific file in an Amazon S3 bucket.static interface
The configuration information for syncing a Salesforce chatter feed.static interface
Provides the configuration information to connect to Salesforce as your data source.static interface
Provides the configuration information for indexing Salesforce custom articles.static interface
Provides the configuration information for the knowledge article types that Amazon Kendra indexes.static interface
Provides the configuration information for standard Salesforce knowledge articles.static interface
Provides the configuration information for processing attachments to Salesforce standard objects.static interface
Specifies configuration information for indexing a single standard object.static interface
Provides the configuration information to connect to ServiceNow as your data source.static interface
Provides the configuration information for crawling knowledge articles in the ServiceNow site.static interface
Provides the configuration information for crawling service catalog items in the ServiceNow site.static interface
Provides the configuration information to connect to Microsoft SharePoint as your data source.static interface
Provides information that configures Amazon Kendra to use a SQL database.static interface
Example:static interface
Provides the configuration information to connect to websites that require user authentication.static interface
Provides the configuration information to connect to websites that require basic user authentication.static interface
Provides the configuration information required for Amazon Kendra Web Crawler.static interface
Provides the configuration information of the seed or starting point URLs to crawl.static interface
Provides the configuration information of the sitemap URLs to crawl.static interface
Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.static interface
Provides the configuration information to connect to Amazon WorkDocs as your data source.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnDataSource
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnDataSource
(software.amazon.jsii.JsiiObjectRef objRef) CfnDataSource
(software.constructs.Construct scope, String id, CfnDataSourceProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the data source.The identifier for the data source.Configuration information for altering document metadata and content during the document ingestion process.Configuration information for an Amazon Kendra data source.A description for the data source connector.The identifier of the index you want to use with the data source connector.The code for a language.getName()
The name of the data source.The Amazon Resource Name (ARN) of a role with permission to access the data source.Sets the frequency that Amazon Kendra checks the documents in your data source and updates the index.getTags()
Tag Manager which manages the tags for this resource.An array of key-value pairs to apply to this resource.getType()
The type of the data source.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
Configuration information for altering document metadata and content during the document ingestion process.void
setCustomDocumentEnrichmentConfiguration
(CfnDataSource.CustomDocumentEnrichmentConfigurationProperty value) Configuration information for altering document metadata and content during the document ingestion process.void
Configuration information for an Amazon Kendra data source.void
Configuration information for an Amazon Kendra data source.void
setDescription
(String value) A description for the data source connector.void
setIndexId
(String value) The identifier of the index you want to use with the data source connector.void
setLanguageCode
(String value) The code for a language.void
The name of the data source.void
setRoleArn
(String value) The Amazon Resource Name (ARN) of a role with permission to access the data source.void
setSchedule
(String value) Sets the frequency that Amazon Kendra checks the documents in your data source and updates the index.void
setTagsRaw
(List<CfnTag> value) An array of key-value pairs to apply to this resource.void
The type of the data source.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnDataSource
protected CfnDataSource(software.amazon.jsii.JsiiObjectRef objRef) -
CfnDataSource
protected CfnDataSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnDataSource
@Stability(Stable) public CfnDataSource(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDataSourceProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) of the data source. For example:.arn:aws:kendra:us-west-2:111122223333:index/335c3741-41df-46a6-b5d3-61f85b787884/data-source/b8cae438-6787-4091-8897-684a652bbb0a
-
getAttrId
The identifier for the data source. For example:.b8cae438-6787-4091-8897-684a652bbb0a
. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getIndexId
The identifier of the index you want to use with the data source connector. -
setIndexId
The identifier of the index you want to use with the data source connector. -
getName
The name of the data source. -
setName
The name of the data source. -
getType
The type of the data source. -
setType
The type of the data source. -
getCustomDocumentEnrichmentConfiguration
Configuration information for altering document metadata and content during the document ingestion process. -
setCustomDocumentEnrichmentConfiguration
@Stability(Stable) public void setCustomDocumentEnrichmentConfiguration(@Nullable IResolvable value) Configuration information for altering document metadata and content during the document ingestion process. -
setCustomDocumentEnrichmentConfiguration
@Stability(Stable) public void setCustomDocumentEnrichmentConfiguration(@Nullable CfnDataSource.CustomDocumentEnrichmentConfigurationProperty value) Configuration information for altering document metadata and content during the document ingestion process. -
getDataSourceConfiguration
Configuration information for an Amazon Kendra data source. -
setDataSourceConfiguration
Configuration information for an Amazon Kendra data source. -
setDataSourceConfiguration
@Stability(Stable) public void setDataSourceConfiguration(@Nullable CfnDataSource.DataSourceConfigurationProperty value) Configuration information for an Amazon Kendra data source. -
getDescription
A description for the data source connector. -
setDescription
A description for the data source connector. -
getLanguageCode
The code for a language. -
setLanguageCode
The code for a language. -
getRoleArn
The Amazon Resource Name (ARN) of a role with permission to access the data source. -
setRoleArn
The Amazon Resource Name (ARN) of a role with permission to access the data source. -
getSchedule
Sets the frequency that Amazon Kendra checks the documents in your data source and updates the index. -
setSchedule
Sets the frequency that Amazon Kendra checks the documents in your data source and updates the index. -
getTagsRaw
An array of key-value pairs to apply to this resource. -
setTagsRaw
An array of key-value pairs to apply to this resource.
-