Package com.pulumi.aws.kendra

Class Faq

  • public class Faq
extends com.pulumi.resources.CustomResource
    Resource for managing an AWS Kendra FAQ. ## Example Usage ### Basic 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.kendra.Faq;
 import com.pulumi.aws.kendra.FaqArgs;
 import com.pulumi.aws.kendra.inputs.FaqS3PathArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new Faq("example", FaqArgs.builder()
             .s3Path(FaqS3PathArgs.builder()
                 .bucket(exampleAwsS3Bucket.id())
                 .key(exampleAwsS3Object.key())
                 .build())
             .indexId(exampleAwsKendraIndex.id())
             .name("Example")
             .roleArn(exampleAwsIamRole.arn())
             .tags(Map.of("Name", "Example Kendra Faq"))
             .build());
 
     }
 }
    ### With File Format 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.kendra.Faq;
 import com.pulumi.aws.kendra.FaqArgs;
 import com.pulumi.aws.kendra.inputs.FaqS3PathArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new Faq("example", FaqArgs.builder()
             .s3Path(FaqS3PathArgs.builder()
                 .bucket(exampleAwsS3Bucket.id())
                 .key(exampleAwsS3Object.key())
                 .build())
             .indexId(exampleAwsKendraIndex.id())
             .name("Example")
             .fileFormat("CSV")
             .roleArn(exampleAwsIamRole.arn())
             .build());
 
     }
 }
    ### With Language Code 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.kendra.Faq;
 import com.pulumi.aws.kendra.FaqArgs;
 import com.pulumi.aws.kendra.inputs.FaqS3PathArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new Faq("example", FaqArgs.builder()
             .s3Path(FaqS3PathArgs.builder()
                 .bucket(exampleAwsS3Bucket.id())
                 .key(exampleAwsS3Object.key())
                 .build())
             .indexId(exampleAwsKendraIndex.id())
             .name("Example")
             .languageCode("en")
             .roleArn(exampleAwsIamRole.arn())
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import `aws.kendra.Faq` using the unique identifiers of the FAQ and index separated by a slash (`/`). For example: ```sh $ pulumi import aws:kendra/faq:Faq example faq-123456780/idx-8012925589 ```

    • Nested Class Summary

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

        com.pulumi.resources.CustomResource.CustomResourceInternal

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

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Faq​(java.lang.String name)  
      Faq​(java.lang.String name, FaqArgs args)  
      Faq​(java.lang.String name, FaqArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> createdAt()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.lang.String> errorMessage()  
      com.pulumi.core.Output<java.lang.String> faqId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> fileFormat()  
      static Faq get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, FaqState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> indexId()  
      com.pulumi.core.Output<java.lang.String> languageCode()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> roleArn()  
      com.pulumi.core.Output<FaqS3Path> s3Path()  
      com.pulumi.core.Output<java.lang.String> status()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.lang.String> updatedAt()  

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

        getId, id, idFuture

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

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Faq

        public Faq​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Faq

        public Faq​(java.lang.String name,
           FaqArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Faq

        public Faq​(java.lang.String name,
           FaqArgs args,
           @Nullable
           com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the FAQ.

      • createdAt

        public com.pulumi.core.Output<java.lang.String> createdAt()
        Returns:
        Unix datetime that the FAQ was created.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description for a FAQ.

      • errorMessage

        public com.pulumi.core.Output<java.lang.String> errorMessage()
        Returns:
        When the Status field value is `FAILED`, this contains a message that explains why.

      • faqId

        public com.pulumi.core.Output<java.lang.String> faqId()
        Returns:
        Identifier of the FAQ.

      • fileFormat

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> fileFormat()
        Returns:
        File format used by the input files for the FAQ. Valid Values are `CSV`, `CSV_WITH_HEADER`, `JSON`.

      • indexId

        public com.pulumi.core.Output<java.lang.String> indexId()
        Returns:
        Identifier of the index for a FAQ.

      • languageCode

        public com.pulumi.core.Output<java.lang.String> languageCode()
        Returns:
        Code for a language. This shows a supported language for the FAQ document. 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 com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name that should be associated with the FAQ.

      • region

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

      • s3Path

        public com.pulumi.core.Output<FaqS3Path> s3Path()
        Returns:
        S3 location of the FAQ input data. Detailed below. The following arguments are optional:

      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        Status of the FAQ. It is ready to use when the status is ACTIVE.

      • tags

        public com.pulumi.core.Output<java.util.Optional<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 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.

      • updatedAt

        public com.pulumi.core.Output<java.lang.String> updatedAt()
        Returns:
        Date and time that the FAQ was last updated.

      • get

        public static Faq get​(java.lang.String name,
                      com.pulumi.core.Output<java.lang.String> id,
                      @Nullable
                      FaqState state,
                      @Nullable
                      com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.