Package software.amazon.awscdk.services.qbusiness

Interface CfnIndex.DocumentAttributeConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIndex.DocumentAttributeConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnIndex

@Stability(Stable)
public static interface CfnIndex.DocumentAttributeConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 .

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.*;
 DocumentAttributeConfigurationProperty documentAttributeConfigurationProperty = DocumentAttributeConfigurationProperty.builder()
         .name("name")
         .search("search")
         .type("type")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-documentattributeconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnIndex.DocumentAttributeConfigurationProperty.Builder	A builder for CfnIndex.DocumentAttributeConfigurationProperty
static final class	CfnIndex.DocumentAttributeConfigurationProperty.Jsii$Proxy	An implementation for CfnIndex.DocumentAttributeConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnIndex.DocumentAttributeConfigurationProperty.Builder	builder()
default String	getName()	The name of the document attribute.
default String	getSearch()	Information about whether the document attribute can be used by an end user to search for information on their web experience.
default String	getType()	The type of document attribute.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the document attribute.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-documentattributeconfiguration.html#cfn-qbusiness-index-documentattributeconfiguration-name

getSearch

@Stability(Stable)
@Nullable
default String getSearch()

Information about whether the document attribute can be used by an end user to search for information on their web experience.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-documentattributeconfiguration.html#cfn-qbusiness-index-documentattributeconfiguration-search

getType

@Stability(Stable)
@Nullable
default String getType()

The type of document attribute.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-documentattributeconfiguration.html#cfn-qbusiness-index-documentattributeconfiguration-type

builder

@Stability(Stable)
static CfnIndex.DocumentAttributeConfigurationProperty.Builder builder()

Returns:

a CfnIndex.DocumentAttributeConfigurationProperty.Builder of CfnIndex.DocumentAttributeConfigurationProperty