Class CfnIndexProps

Properties for defining a CfnIndex.

Inheritance

System.Object

CfnIndexProps

Implements

ICfnIndexProps

Namespace: Amazon.CDK.AwsQbusiness

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnIndexProps : Object, ICfnIndexProps

Syntax (vb)

Public Class CfnIndexProps
    Inherits Object
    Implements ICfnIndexProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.Aws_qbusiness;

var cfnIndexProps = new CfnIndexProps {
    ApplicationId = "applicationId",
    DisplayName = "displayName",

    // the properties below are optional
    CapacityConfiguration = new IndexCapacityConfigurationProperty {
        Units = 123
    },
    Description = "description",
    DocumentAttributeConfigurations = new [] { new DocumentAttributeConfigurationProperty {
        Name = "name",
        Search = "search",
        Type = "type"
    } },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    Type = "type"
};

Synopsis

Constructors

CfnIndexProps()

Properties

ApplicationId	The identifier of the Amazon Q Business application using the index.
CapacityConfiguration	The capacity units you want to provision for your index.
Description	A description for the Amazon Q Business index.
DisplayName	The name of the index.
DocumentAttributeConfigurations	Configuration information for document attributes.
Tags	A list of key-value pairs that identify or categorize the index.
Type	The index type that's suitable for your needs.

Constructors

CfnIndexProps()

public CfnIndexProps()

Properties

ApplicationId

The identifier of the Amazon Q Business application using the index.

public string ApplicationId { get; set; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-applicationid

CapacityConfiguration

The capacity units you want to provision for your index.

public object CapacityConfiguration { get; set; }

Property Value

System.Object

Remarks

You can add and remove capacity to fit your usage needs.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-capacityconfiguration

Description

A description for the Amazon Q Business index.

public string Description { get; set; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-description

DisplayName

The name of the index.

public string DisplayName { get; set; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-displayname

DocumentAttributeConfigurations

Configuration information for document attributes.

public object DocumentAttributeConfigurations { get; set; }

Property Value

System.Object

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-documentattributeconfigurations

Tags

A list of key-value pairs that identify or categorize the index.

public ICfnTag[] Tags { get; set; }

Property Value

ICfnTag[]

Remarks

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: _ . : / = + -

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-tags

: .

Type

The index type that's suitable for your needs.

public string Type { get; set; }

Property Value

System.String

Remarks

For more information on what's included in each type of index, see Amazon Q Business tiers .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-type

Implements

ICfnIndexProps