@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
145 lines (144 loc) • 6.64 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Kendra DataSource
*/
export declare class DataSource extends pulumi.CustomResource {
/**
* Get an existing DataSource resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): DataSource;
/**
* Returns true if the given object is an instance of DataSource. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is DataSource;
/**
* 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`
*/
readonly arn: pulumi.Output<string>;
/**
* The identifier for the data source. For example:
*
* `b8cae438-6787-4091-8897-684a652bbb0a` .
*/
readonly awsId: pulumi.Output<string>;
/**
* Configuration information for altering document metadata and content during the document ingestion process.
*/
readonly customDocumentEnrichmentConfiguration: pulumi.Output<outputs.kendra.DataSourceCustomDocumentEnrichmentConfiguration | undefined>;
/**
* Configuration information for an Amazon Kendra data source. The contents of the configuration depend on the type of data source. You can only specify one type of data source in the configuration.
*
* You can't specify the `Configuration` parameter when the `Type` parameter is set to `CUSTOM` .
*
* The `Configuration` parameter is required for all other data sources.
*/
readonly dataSourceConfiguration: pulumi.Output<outputs.kendra.DataSourceConfiguration | undefined>;
/**
* A description for the data source connector.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The identifier of the index you want to use with the data source connector.
*/
readonly indexId: pulumi.Output<string>;
/**
* The code for a language. This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see [Adding documents in languages other than English](https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html) .
*/
readonly languageCode: pulumi.Output<string | undefined>;
/**
* The name of the data source.
*/
readonly name: pulumi.Output<string>;
/**
* The Amazon Resource Name (ARN) of a role with permission to access the data source.
*
* You can't specify the `RoleArn` parameter when the `Type` parameter is set to `CUSTOM` .
*
* The `RoleArn` parameter is required for all other data sources.
*/
readonly roleArn: pulumi.Output<string | undefined>;
/**
* Sets the frequency that Amazon Kendra checks the documents in your data source and updates the index. If you don't set a schedule, Amazon Kendra doesn't periodically update the index.
*/
readonly schedule: pulumi.Output<string | undefined>;
/**
* Tags for labeling the data source
*/
readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
/**
* The type of the data source.
*/
readonly type: pulumi.Output<enums.kendra.DataSourceType>;
/**
* Create a DataSource resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: DataSourceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a DataSource resource.
*/
export interface DataSourceArgs {
/**
* Configuration information for altering document metadata and content during the document ingestion process.
*/
customDocumentEnrichmentConfiguration?: pulumi.Input<inputs.kendra.DataSourceCustomDocumentEnrichmentConfigurationArgs>;
/**
* Configuration information for an Amazon Kendra data source. The contents of the configuration depend on the type of data source. You can only specify one type of data source in the configuration.
*
* You can't specify the `Configuration` parameter when the `Type` parameter is set to `CUSTOM` .
*
* The `Configuration` parameter is required for all other data sources.
*/
dataSourceConfiguration?: pulumi.Input<inputs.kendra.DataSourceConfigurationArgs>;
/**
* A description for the data source connector.
*/
description?: pulumi.Input<string>;
/**
* The identifier of the index you want to use with the data source connector.
*/
indexId: pulumi.Input<string>;
/**
* The code for a language. This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see [Adding documents in languages other than English](https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html) .
*/
languageCode?: pulumi.Input<string>;
/**
* The name of the data source.
*/
name?: pulumi.Input<string>;
/**
* The Amazon Resource Name (ARN) of a role with permission to access the data source.
*
* You can't specify the `RoleArn` parameter when the `Type` parameter is set to `CUSTOM` .
*
* The `RoleArn` parameter is required for all other data sources.
*/
roleArn?: pulumi.Input<string>;
/**
* Sets the frequency that Amazon Kendra checks the documents in your data source and updates the index. If you don't set a schedule, Amazon Kendra doesn't periodically update the index.
*/
schedule?: pulumi.Input<string>;
/**
* Tags for labeling the data source
*/
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
/**
* The type of the data source.
*/
type: pulumi.Input<enums.kendra.DataSourceType>;
}