Package com.pulumi.aws.kendra.inputs

Class DataSourceState

  • public final class DataSourceState
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  DataSourceState.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()  
      static DataSourceState.Builder builder()  
      static DataSourceState.Builder builder​(DataSourceState defaults)  
      java.util.Optional<com.pulumi.core.Output<DataSourceConfigurationArgs>> configuration()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> createdAt()  
      java.util.Optional<com.pulumi.core.Output<DataSourceCustomDocumentEnrichmentConfigurationArgs>> customDocumentEnrichmentConfiguration()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> dataSourceId()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> errorMessage()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> indexId()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> languageCode()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> roleArn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> schedule()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> status()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> type()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> updatedAt()  

      • Methods inherited from class com.pulumi.resources.ResourceArgs

        validateMember

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • arn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()
        Returns:
        ARN of the Data Source.

      • configuration

        public java.util.Optional<com.pulumi.core.Output<DataSourceConfigurationArgs>> configuration()
        Returns:
        Configuration information to connect to your Data Source repository. You can't specify the `configuration` block when the `type` parameter is set to `CUSTOM`. Detailed below.

      • createdAt

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> createdAt()
        Returns:
        Unix time stamp of when the Data Source was created.

      • customDocumentEnrichmentConfiguration

        public java.util.Optional<com.pulumi.core.Output<DataSourceCustomDocumentEnrichmentConfigurationArgs>> customDocumentEnrichmentConfiguration()
        Returns:
        Configuration information for altering document metadata and content during the document ingestion process. For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see [Customizing document metadata during the ingestion process](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html). Detailed below.

      • dataSourceId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> dataSourceId()
        Returns:
        Unique identifiers of the Data Source.

      • description

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()
        Returns:
        Description for the Data Source connector.

      • errorMessage

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> errorMessage()
        Returns:
        When the Status field value is `FAILED`, contains a description of the error that caused the Data Source to fail.

      • indexId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> indexId()
        Returns:
        Identifier of the index for your Amazon Kendra data source.

      • languageCode

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> languageCode()
        Returns:
        Code for a language. This allows you to support a language for all documents when creating the Data Source connector. 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).

      • name

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        Name for your data source connector.

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • roleArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> roleArn()
        Returns:
        ARN of a role with permission to access the data source connector. For more information, see [IAM roles for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). 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.

      • schedule

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> schedule()
        Returns:
        Sets the frequency for Amazon Kendra to check the documents in your Data Source repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the `StartDataSourceSyncJob` API to update the index.

      • status

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> status()
        Returns:
        Current status of the Data Source. When the status is `ACTIVE` the Data Source is ready to use. When the status is `FAILED`, the `errorMessage` field contains the reason that the Data Source failed.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • type

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> type()
        Returns:
        Type of data source repository. For an updated list of values, refer to [Valid Values for Type](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html#Kendra-CreateDataSource-request-Type). The following arguments are optional:

      • updatedAt

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> updatedAt()
        Returns:
        Unix time stamp of when the Data Source was last updated.