Class CfnIndexPropsMixin

Creates an Amazon Q Business index.

Inheritance

object

Mixin

CfnIndexPropsMixin

Implements

IMixin

Inherited Members

Mixin.IsMixin(object)

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.QBusiness

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnIndexPropsMixin : Mixin, IMixin

Syntax (vb)

Public Class CfnIndexPropsMixin Inherits Mixin Implements IMixin

Remarks

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.

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

CloudformationResource: AWS::QBusiness::Index

Mixin: true

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.CfnPropertyMixins.AWS.QBusiness;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnIndexPropsMixin = new CfnIndexPropsMixin(new CfnIndexMixinProps {
                 ApplicationId = "applicationId",
                 CapacityConfiguration = new IndexCapacityConfigurationProperty {
                     Units = 123
                 },
                 Description = "description",
                 DisplayName = "displayName",
                 DocumentAttributeConfigurations = new [] { new DocumentAttributeConfigurationProperty {
                     Name = "name",
                     Search = "search",
                     Type = "type"
                 } },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 Type = "type"
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Synopsis

Constructors

CfnIndexPropsMixin(ICfnIndexMixinProps, ICfnPropertyMixinOptions?)

Create a mixin to apply properties to AWS::QBusiness::Index.

Properties

CFN_PROPERTY_KEYS	Creates an Amazon Q Business index.
Props	Creates an Amazon Q Business index.
Strategy	Creates an Amazon Q Business index.

Methods

ApplyTo(IConstruct)	Apply the mixin properties to the construct.
Supports(IConstruct)	Check if this mixin supports the given construct.

Constructors

CfnIndexPropsMixin(ICfnIndexMixinProps, ICfnPropertyMixinOptions?)

Create a mixin to apply properties to AWS::QBusiness::Index.

public CfnIndexPropsMixin(ICfnIndexMixinProps props, ICfnPropertyMixinOptions? options = null)

Parameters

props ICfnIndexMixinProps

L1 properties to apply.

options ICfnPropertyMixinOptions

Mixin options.

Remarks

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.

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

CloudformationResource: AWS::QBusiness::Index

Mixin: true

ExampleMetadata: fixture=_generated

Properties

CFN_PROPERTY_KEYS

Creates an Amazon Q Business index.

protected static string[] CFN_PROPERTY_KEYS { get; }

Property Value

string[]

Remarks

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.

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

CloudformationResource: AWS::QBusiness::Index

Mixin: true

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.CfnPropertyMixins.AWS.QBusiness;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnIndexPropsMixin = new CfnIndexPropsMixin(new CfnIndexMixinProps {
                 ApplicationId = "applicationId",
                 CapacityConfiguration = new IndexCapacityConfigurationProperty {
                     Units = 123
                 },
                 Description = "description",
                 DisplayName = "displayName",
                 DocumentAttributeConfigurations = new [] { new DocumentAttributeConfigurationProperty {
                     Name = "name",
                     Search = "search",
                     Type = "type"
                 } },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 Type = "type"
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Props

Creates an Amazon Q Business index.

protected virtual ICfnIndexMixinProps Props { get; }

Property Value

ICfnIndexMixinProps

Remarks

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.

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

CloudformationResource: AWS::QBusiness::Index

Mixin: true

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.CfnPropertyMixins.AWS.QBusiness;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnIndexPropsMixin = new CfnIndexPropsMixin(new CfnIndexMixinProps {
                 ApplicationId = "applicationId",
                 CapacityConfiguration = new IndexCapacityConfigurationProperty {
                     Units = 123
                 },
                 Description = "description",
                 DisplayName = "displayName",
                 DocumentAttributeConfigurations = new [] { new DocumentAttributeConfigurationProperty {
                     Name = "name",
                     Search = "search",
                     Type = "type"
                 } },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 Type = "type"
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Strategy

Creates an Amazon Q Business index.

protected virtual IMergeStrategy Strategy { get; }

Property Value

IMergeStrategy

Remarks

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.

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

CloudformationResource: AWS::QBusiness::Index

Mixin: true

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.CfnPropertyMixins.AWS.QBusiness;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnIndexPropsMixin = new CfnIndexPropsMixin(new CfnIndexMixinProps {
                 ApplicationId = "applicationId",
                 CapacityConfiguration = new IndexCapacityConfigurationProperty {
                     Units = 123
                 },
                 Description = "description",
                 DisplayName = "displayName",
                 DocumentAttributeConfigurations = new [] { new DocumentAttributeConfigurationProperty {
                     Name = "name",
                     Search = "search",
                     Type = "type"
                 } },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 Type = "type"
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Methods

ApplyTo(IConstruct)

Apply the mixin properties to the construct.

public override void ApplyTo(IConstruct construct)

Parameters

construct IConstruct

Overrides

Mixin.ApplyTo(IConstruct)

Remarks

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.

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

CloudformationResource: AWS::QBusiness::Index

Mixin: true

ExampleMetadata: fixture=_generated

Supports(IConstruct)

Check if this mixin supports the given construct.

public override bool Supports(IConstruct construct)

Parameters

construct IConstruct

Returns

bool

Overrides

Mixin.Supports(IConstruct)

Remarks

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.

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

CloudformationResource: AWS::QBusiness::Index

Mixin: true

ExampleMetadata: fixture=_generated

Implements

Constructs.IMixin