Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. qbusiness
  5. Index

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.qbusiness.Index

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::QBusiness::Index Resource Type

    Create Index Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Index(name: string, args: IndexArgs, opts?: CustomResourceOptions);
    @overload
def Index(resource_name: str,
          args: IndexArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Index(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          application_id: Optional[str] = None,
          display_name: Optional[str] = None,
          capacity_configuration: Optional[IndexCapacityConfigurationArgs] = None,
          description: Optional[str] = None,
          document_attribute_configurations: Optional[Sequence[IndexDocumentAttributeConfigurationArgs]] = None,
          tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
          type: Optional[IndexType] = None)
    func NewIndex(ctx *Context, name string, args IndexArgs, opts ...ResourceOption) (*Index, error)
    public Index(string name, IndexArgs args, CustomResourceOptions? opts = null)
    public Index(String name, IndexArgs args)
public Index(String name, IndexArgs args, CustomResourceOptions options)

    type: aws-native:qbusiness:Index
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args IndexArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args IndexArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args IndexArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IndexArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IndexArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Index Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Index resource accepts the following input properties:

    ApplicationId string
    The identifier of the Amazon Q Business application using the index.
    DisplayName string
    The name of the index.
    CapacityConfiguration Pulumi.AwsNative.QBusiness.Inputs.IndexCapacityConfiguration
    The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.
    Description string
    A description for the Amazon Q Business index.
    DocumentAttributeConfigurations List<Pulumi.AwsNative.QBusiness.Inputs.IndexDocumentAttributeConfiguration>

    Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.

    For more information, see Understanding document attributes .

    Tags List<Pulumi.AwsNative.Inputs.Tag>
    A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
    Type Pulumi.AwsNative.QBusiness.IndexType
    The index type that's suitable for your needs. For more information on what's included in each type of index, see Amazon Q Business tiers .
    ApplicationId string
    The identifier of the Amazon Q Business application using the index.
    DisplayName string
    The name of the index.
    CapacityConfiguration IndexCapacityConfigurationArgs
    The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.
    Description string
    A description for the Amazon Q Business index.
    DocumentAttributeConfigurations []IndexDocumentAttributeConfigurationArgs

    Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.

    For more information, see Understanding document attributes .

    Tags TagArgs
    A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
    Type IndexType
    The index type that's suitable for your needs. For more information on what's included in each type of index, see Amazon Q Business tiers .
    applicationId String
    The identifier of the Amazon Q Business application using the index.
    displayName String
    The name of the index.
    capacityConfiguration IndexCapacityConfiguration
    The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.
    description String
    A description for the Amazon Q Business index.
    documentAttributeConfigurations List<IndexDocumentAttributeConfiguration>

    Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.

    For more information, see Understanding document attributes .

    tags List<Tag>
    A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
    type IndexType
    The index type that's suitable for your needs. For more information on what's included in each type of index, see Amazon Q Business tiers .
    applicationId string
    The identifier of the Amazon Q Business application using the index.
    displayName string
    The name of the index.
    capacityConfiguration IndexCapacityConfiguration
    The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.
    description string
    A description for the Amazon Q Business index.
    documentAttributeConfigurations IndexDocumentAttributeConfiguration[]

    Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.

    For more information, see Understanding document attributes .

    tags Tag[]
    A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
    type IndexType
    The index type that's suitable for your needs. For more information on what's included in each type of index, see Amazon Q Business tiers .
    application_id str
    The identifier of the Amazon Q Business application using the index.
    display_name str
    The name of the index.
    capacity_configuration IndexCapacityConfigurationArgs
    The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.
    description str
    A description for the Amazon Q Business index.
    document_attribute_configurations Sequence[IndexDocumentAttributeConfigurationArgs]

    Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.

    For more information, see Understanding document attributes .

    tags Sequence[TagArgs]
    A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
    type IndexType
    The index type that's suitable for your needs. For more information on what's included in each type of index, see Amazon Q Business tiers .
    applicationId String
    The identifier of the Amazon Q Business application using the index.
    displayName String
    The name of the index.
    capacityConfiguration Property Map
    The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.
    description String
    A description for the Amazon Q Business index.
    documentAttributeConfigurations List<Property Map>

    Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.

    For more information, see Understanding document attributes .

    tags List<Property Map>
    A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
    type "ENTERPRISE" | "STARTER"
    The index type that's suitable for your needs. For more information on what's included in each type of index, see Amazon Q Business tiers .

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Index resource produces the following output properties:

    CreatedAt string
    The Unix timestamp when the index was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    IndexArn string
    The Amazon Resource Name (ARN) of an Amazon Q Business index.
    IndexId string
    The identifier for the index.
    IndexStatistics Pulumi.AwsNative.QBusiness.Outputs.IndexStatistics
    Status Pulumi.AwsNative.QBusiness.IndexStatus
    The current status of the index. When the status is ACTIVE , the index is ready.
    UpdatedAt string
    The Unix timestamp when the index was last updated.
    CreatedAt string
    The Unix timestamp when the index was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    IndexArn string
    The Amazon Resource Name (ARN) of an Amazon Q Business index.
    IndexId string
    The identifier for the index.
    IndexStatistics IndexStatistics
    Status IndexStatus
    The current status of the index. When the status is ACTIVE , the index is ready.
    UpdatedAt string
    The Unix timestamp when the index was last updated.
    createdAt String
    The Unix timestamp when the index was created.
    id String
    The provider-assigned unique ID for this managed resource.
    indexArn String
    The Amazon Resource Name (ARN) of an Amazon Q Business index.
    indexId String
    The identifier for the index.
    indexStatistics IndexStatistics
    status IndexStatus
    The current status of the index. When the status is ACTIVE , the index is ready.
    updatedAt String
    The Unix timestamp when the index was last updated.
    createdAt string
    The Unix timestamp when the index was created.
    id string
    The provider-assigned unique ID for this managed resource.
    indexArn string
    The Amazon Resource Name (ARN) of an Amazon Q Business index.
    indexId string
    The identifier for the index.
    indexStatistics IndexStatistics
    status IndexStatus
    The current status of the index. When the status is ACTIVE , the index is ready.
    updatedAt string
    The Unix timestamp when the index was last updated.
    created_at str
    The Unix timestamp when the index was created.
    id str
    The provider-assigned unique ID for this managed resource.
    index_arn str
    The Amazon Resource Name (ARN) of an Amazon Q Business index.
    index_id str
    The identifier for the index.
    index_statistics IndexStatistics
    status IndexStatus
    The current status of the index. When the status is ACTIVE , the index is ready.
    updated_at str
    The Unix timestamp when the index was last updated.
    createdAt String
    The Unix timestamp when the index was created.
    id String
    The provider-assigned unique ID for this managed resource.
    indexArn String
    The Amazon Resource Name (ARN) of an Amazon Q Business index.
    indexId String
    The identifier for the index.
    indexStatistics Property Map
    status "CREATING" | "ACTIVE" | "DELETING" | "FAILED" | "UPDATING"
    The current status of the index. When the status is ACTIVE , the index is ready.
    updatedAt String
    The Unix timestamp when the index was last updated.

    Supporting Types

    IndexAttributeType, IndexAttributeTypeArgs

    String
    STRING
    StringList
    STRING_LIST
    Number
    NUMBER
    Date
    DATE
    IndexAttributeTypeString
    STRING
    IndexAttributeTypeStringList
    STRING_LIST
    IndexAttributeTypeNumber
    NUMBER
    IndexAttributeTypeDate
    DATE
    String
    STRING
    StringList
    STRING_LIST
    Number
    NUMBER
    Date
    DATE
    String
    STRING
    StringList
    STRING_LIST
    Number
    NUMBER
    Date
    DATE
    STRING
    STRING
    STRING_LIST
    STRING_LIST
    NUMBER
    NUMBER
    DATE
    DATE
    "STRING"
    STRING
    "STRING_LIST"
    STRING_LIST
    "NUMBER"
    NUMBER
    "DATE"
    DATE

    IndexCapacityConfiguration, IndexCapacityConfigurationArgs

    Units double
    The number of storage units configured for an Amazon Q Business index.
    Units float64
    The number of storage units configured for an Amazon Q Business index.
    units Double
    The number of storage units configured for an Amazon Q Business index.
    units number
    The number of storage units configured for an Amazon Q Business index.
    units float
    The number of storage units configured for an Amazon Q Business index.
    units Number
    The number of storage units configured for an Amazon Q Business index.

    IndexDocumentAttributeConfiguration, IndexDocumentAttributeConfigurationArgs

    Name string
    The name of the document attribute.
    Search Pulumi.AwsNative.QBusiness.QBusinessIndexStatus
    Information about whether the document attribute can be used by an end user to search for information on their web experience.
    Type Pulumi.AwsNative.QBusiness.IndexAttributeType
    The type of document attribute.
    Name string
    The name of the document attribute.
    Search QBusinessIndexStatus
    Information about whether the document attribute can be used by an end user to search for information on their web experience.
    Type IndexAttributeType
    The type of document attribute.
    name String
    The name of the document attribute.
    search QBusinessIndexStatus
    Information about whether the document attribute can be used by an end user to search for information on their web experience.
    type IndexAttributeType
    The type of document attribute.
    name string
    The name of the document attribute.
    search QBusinessIndexStatus
    Information about whether the document attribute can be used by an end user to search for information on their web experience.
    type IndexAttributeType
    The type of document attribute.
    name str
    The name of the document attribute.
    search QBusinessIndexStatus
    Information about whether the document attribute can be used by an end user to search for information on their web experience.
    type IndexAttributeType
    The type of document attribute.
    name String
    The name of the document attribute.
    search "ENABLED" | "DISABLED"
    Information about whether the document attribute can be used by an end user to search for information on their web experience.
    type "STRING" | "STRING_LIST" | "NUMBER" | "DATE"
    The type of document attribute.

    IndexStatistics, IndexStatisticsArgs

    TextDocumentStatistics IndexTextDocumentStatistics
    The number of documents indexed.
    textDocumentStatistics IndexTextDocumentStatistics
    The number of documents indexed.
    textDocumentStatistics IndexTextDocumentStatistics
    The number of documents indexed.
    textDocumentStatistics Property Map
    The number of documents indexed.

    IndexStatus, IndexStatusArgs

    Creating
    CREATING
    Active
    ACTIVE
    Deleting
    DELETING
    Failed
    FAILED
    Updating
    UPDATING
    IndexStatusCreating
    CREATING
    IndexStatusActive
    ACTIVE
    IndexStatusDeleting
    DELETING
    IndexStatusFailed
    FAILED
    IndexStatusUpdating
    UPDATING
    Creating
    CREATING
    Active
    ACTIVE
    Deleting
    DELETING
    Failed
    FAILED
    Updating
    UPDATING
    Creating
    CREATING
    Active
    ACTIVE
    Deleting
    DELETING
    Failed
    FAILED
    Updating
    UPDATING
    CREATING
    CREATING
    ACTIVE
    ACTIVE
    DELETING
    DELETING
    FAILED
    FAILED
    UPDATING
    UPDATING
    "CREATING"
    CREATING
    "ACTIVE"
    ACTIVE
    "DELETING"
    DELETING
    "FAILED"
    FAILED
    "UPDATING"
    UPDATING

    IndexTextDocumentStatistics, IndexTextDocumentStatisticsArgs

    IndexedTextBytes double
    The total size, in bytes, of the indexed documents.
    IndexedTextDocumentCount double
    The number of text documents indexed.
    IndexedTextBytes float64
    The total size, in bytes, of the indexed documents.
    IndexedTextDocumentCount float64
    The number of text documents indexed.
    indexedTextBytes Double
    The total size, in bytes, of the indexed documents.
    indexedTextDocumentCount Double
    The number of text documents indexed.
    indexedTextBytes number
    The total size, in bytes, of the indexed documents.
    indexedTextDocumentCount number
    The number of text documents indexed.
    indexed_text_bytes float
    The total size, in bytes, of the indexed documents.
    indexed_text_document_count float
    The number of text documents indexed.
    indexedTextBytes Number
    The total size, in bytes, of the indexed documents.
    indexedTextDocumentCount Number
    The number of text documents indexed.

    IndexType, IndexTypeArgs

    Enterprise
    ENTERPRISE
    Starter
    STARTER
    IndexTypeEnterprise
    ENTERPRISE
    IndexTypeStarter
    STARTER
    Enterprise
    ENTERPRISE
    Starter
    STARTER
    Enterprise
    ENTERPRISE
    Starter
    STARTER
    ENTERPRISE
    ENTERPRISE
    STARTER
    STARTER
    "ENTERPRISE"
    ENTERPRISE
    "STARTER"
    STARTER

    QBusinessIndexStatus, QBusinessIndexStatusArgs

    Enabled
    ENABLED
    Disabled
    DISABLED
    QBusinessIndexStatusEnabled
    ENABLED
    QBusinessIndexStatusDisabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    ENABLED
    ENABLED
    DISABLED
    DISABLED
    "ENABLED"
    ENABLED
    "DISABLED"
    DISABLED

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native