Package software.amazon.awscdk.services.qbusiness

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.qbusiness.CfnIndex
All Implemented Interfaces:
IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:34:06.495Z") @Stability(Stable) public class CfnIndex extends CfnResource implements IInspectable, ITaggableV2
Creates an Amazon Q Business index.

To determine if index creation has completed, check the Status field returned from a call to DescribeIndex . The Status field is set to ACTIVE when the index is ready to use.

Once the index is active, you can index your documents using the BatchPutDocument API or the CreateDataSource API.

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.qbusiness.*;
 CfnIndex cfnIndex = CfnIndex.Builder.create(this, "MyCfnIndex")
         .applicationId("applicationId")
         .displayName("displayName")
         // the properties below are optional
         .capacityConfiguration(IndexCapacityConfigurationProperty.builder()
                 .units(123)
                 .build())
         .description("description")
         .documentAttributeConfigurations(List.of(DocumentAttributeConfigurationProperty.builder()
                 .name("name")
                 .search("search")
                 .type("type")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .type("type")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnIndex

      protected CfnIndex(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnIndex

      protected CfnIndex(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnIndex

      @Stability(Stable) public CfnIndex(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnIndexProps 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

      @Stability(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(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The Unix timestamp when the index was created.

    • getAttrIndexArn

      @Stability(Stable) @NotNull public String getAttrIndexArn()
      The Amazon Resource Name (ARN) of an Amazon Q Business index.

    • getAttrIndexId

      @Stability(Stable) @NotNull public String getAttrIndexId()
      The identifier for the index.

    • getAttrIndexStatistics

      @Stability(Stable) @NotNull public IResolvable getAttrIndexStatistics()

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The current status of the index.

      When the status is ACTIVE , the index is ready.

    • getAttrUpdatedAt

      @Stability(Stable) @NotNull public String getAttrUpdatedAt()
      The Unix timestamp when the index was last updated.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getApplicationId

      @Stability(Stable) @NotNull public String getApplicationId()
      The identifier of the Amazon Q Business application using the index.

    • setApplicationId

      @Stability(Stable) public void setApplicationId(@NotNull String value)
      The identifier of the Amazon Q Business application using the index.

    • getDisplayName

      @Stability(Stable) @NotNull public String getDisplayName()
      The name of the index.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@NotNull String value)
      The name of the index.

    • getCapacityConfiguration

      @Stability(Stable) @Nullable public Object getCapacityConfiguration()
      The capacity units you want to provision for your index.

    • setCapacityConfiguration

      @Stability(Stable) public void setCapacityConfiguration(@Nullable IResolvable value)
      The capacity units you want to provision for your index.

    • setCapacityConfiguration

      @Stability(Stable) public void setCapacityConfiguration(@Nullable CfnIndex.IndexCapacityConfigurationProperty value)
      The capacity units you want to provision for your index.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description for the Amazon Q Business index.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description for the Amazon Q Business index.

    • getDocumentAttributeConfigurations

      @Stability(Stable) @Nullable public Object getDocumentAttributeConfigurations()
      Configuration information for document attributes.

    • setDocumentAttributeConfigurations

      @Stability(Stable) public void setDocumentAttributeConfigurations(@Nullable IResolvable value)
      Configuration information for document attributes.

    • setDocumentAttributeConfigurations

      @Stability(Stable) public void setDocumentAttributeConfigurations(@Nullable List<Object> value)
      Configuration information for document attributes.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A list of key-value pairs that identify or categorize the index.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A list of key-value pairs that identify or categorize the index.

    • getType

      @Stability(Stable) @Nullable public String getType()
      The index type that's suitable for your needs.

    • setType

      @Stability(Stable) public void setType(@Nullable String value)
      The index type that's suitable for your needs.