Package software.amazon.awscdk.cfnpropertymixins.services.kendra

Class CfnIndexMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.kendra.CfnIndexMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnIndexMixinProps>

Enclosing interface:

CfnIndexMixinProps

@Stability(Stable)
public static final class CfnIndexMixinProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnIndexMixinProps>

A builder for CfnIndexMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnIndexMixinProps	build()	Builds the configured instance.
CfnIndexMixinProps.Builder	capacityUnits(CfnIndexPropsMixin.CapacityUnitsConfigurationProperty capacityUnits)	Sets the value of CfnIndexMixinProps.getCapacityUnits()
CfnIndexMixinProps.Builder	capacityUnits(IResolvable capacityUnits)	Sets the value of CfnIndexMixinProps.getCapacityUnits()
CfnIndexMixinProps.Builder	description(String description)	Sets the value of CfnIndexMixinProps.getDescription()
CfnIndexMixinProps.Builder	documentMetadataConfigurations(List<? extends Object> documentMetadataConfigurations)	Sets the value of CfnIndexMixinProps.getDocumentMetadataConfigurations()
CfnIndexMixinProps.Builder	documentMetadataConfigurations(IResolvable documentMetadataConfigurations)	Sets the value of CfnIndexMixinProps.getDocumentMetadataConfigurations()
CfnIndexMixinProps.Builder	edition(String edition)	Sets the value of CfnIndexMixinProps.getEdition()
CfnIndexMixinProps.Builder	name(String name)	Sets the value of CfnIndexMixinProps.getName()
CfnIndexMixinProps.Builder	roleArn(String roleArn)	Sets the value of CfnIndexMixinProps.getRoleArn()
CfnIndexMixinProps.Builder	roleArn(IRoleRef roleArn)	Sets the value of CfnIndexMixinProps.getRoleArn()
CfnIndexMixinProps.Builder	serverSideEncryptionConfiguration(CfnIndexPropsMixin.ServerSideEncryptionConfigurationProperty serverSideEncryptionConfiguration)	Sets the value of CfnIndexMixinProps.getServerSideEncryptionConfiguration()
CfnIndexMixinProps.Builder	serverSideEncryptionConfiguration(IResolvable serverSideEncryptionConfiguration)	Sets the value of CfnIndexMixinProps.getServerSideEncryptionConfiguration()
CfnIndexMixinProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnIndexMixinProps.getTags()
CfnIndexMixinProps.Builder	userContextPolicy(String userContextPolicy)	Sets the value of CfnIndexMixinProps.getUserContextPolicy()
CfnIndexMixinProps.Builder	userTokenConfigurations(List<? extends Object> userTokenConfigurations)	Sets the value of CfnIndexMixinProps.getUserTokenConfigurations()
CfnIndexMixinProps.Builder	userTokenConfigurations(IResolvable userTokenConfigurations)	Sets the value of CfnIndexMixinProps.getUserTokenConfigurations()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

capacityUnits

@Stability(Stable)
public CfnIndexMixinProps.Builder capacityUnits(IResolvable capacityUnits)

Sets the value of CfnIndexMixinProps.getCapacityUnits()

Parameters:

capacityUnits - Specifies additional capacity units configured for your Enterprise Edition index. You can add and remove capacity units to fit your usage requirements.

Returns:

this

capacityUnits

@Stability(Stable)
public CfnIndexMixinProps.Builder capacityUnits(CfnIndexPropsMixin.CapacityUnitsConfigurationProperty capacityUnits)

Sets the value of CfnIndexMixinProps.getCapacityUnits()

Parameters:

capacityUnits - Specifies additional capacity units configured for your Enterprise Edition index. You can add and remove capacity units to fit your usage requirements.

Returns:

this

description

@Stability(Stable)
public CfnIndexMixinProps.Builder description(String description)

Sets the value of CfnIndexMixinProps.getDescription()

Parameters:

description - A description for the index.

Returns:

this

documentMetadataConfigurations

@Stability(Stable)
public CfnIndexMixinProps.Builder documentMetadataConfigurations(IResolvable documentMetadataConfigurations)

Sets the value of CfnIndexMixinProps.getDocumentMetadataConfigurations()

Parameters:

documentMetadataConfigurations - Specifies the properties of an index field. You can add either a custom or a built-in field. You can add and remove built-in fields at any time. When a built-in field is removed it's configuration reverts to the default for the field. Custom fields can't be removed from an index after they are added.

Returns:

this

documentMetadataConfigurations

@Stability(Stable)
public CfnIndexMixinProps.Builder documentMetadataConfigurations(List<? extends Object> documentMetadataConfigurations)

Sets the value of CfnIndexMixinProps.getDocumentMetadataConfigurations()

Parameters:

documentMetadataConfigurations - Specifies the properties of an index field. You can add either a custom or a built-in field. You can add and remove built-in fields at any time. When a built-in field is removed it's configuration reverts to the default for the field. Custom fields can't be removed from an index after they are added.

Returns:

this

edition

@Stability(Stable)
public CfnIndexMixinProps.Builder edition(String edition)

Sets the value of CfnIndexMixinProps.getEdition()

Parameters:

edition - Indicates whether the index is a Enterprise Edition index, a Developer Edition index, or a GenAI Enterprise Edition index.

Returns:

this

name

@Stability(Stable)
public CfnIndexMixinProps.Builder name(String name)

Sets the value of CfnIndexMixinProps.getName()

Parameters:

name - The name of the index.

Returns:

this

roleArn

@Stability(Stable)
public CfnIndexMixinProps.Builder roleArn(String roleArn)

Sets the value of CfnIndexMixinProps.getRoleArn()

Parameters:

roleArn - An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.

Returns:

this

roleArn

@Stability(Stable)
public CfnIndexMixinProps.Builder roleArn(IRoleRef roleArn)

Sets the value of CfnIndexMixinProps.getRoleArn()

Parameters:

roleArn - An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.

Returns:

this

serverSideEncryptionConfiguration

@Stability(Stable)
public CfnIndexMixinProps.Builder serverSideEncryptionConfiguration(IResolvable serverSideEncryptionConfiguration)

Sets the value of CfnIndexMixinProps.getServerSideEncryptionConfiguration()

Parameters:

serverSideEncryptionConfiguration - The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

Returns:

this

serverSideEncryptionConfiguration

@Stability(Stable)
public CfnIndexMixinProps.Builder serverSideEncryptionConfiguration(CfnIndexPropsMixin.ServerSideEncryptionConfigurationProperty serverSideEncryptionConfiguration)

Sets the value of CfnIndexMixinProps.getServerSideEncryptionConfiguration()

Parameters:

serverSideEncryptionConfiguration - The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

Returns:

this

tags

@Stability(Stable)
public CfnIndexMixinProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnIndexMixinProps.getTags()

Parameters:

tags - An array of key-value pairs to apply to this resource. For more information, see Tag .

Returns:

this

userContextPolicy

@Stability(Stable)
public CfnIndexMixinProps.Builder userContextPolicy(String userContextPolicy)

Sets the value of CfnIndexMixinProps.getUserContextPolicy()

Parameters:

userContextPolicy - The user context policy. ATTRIBUTE_FILTER

• All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext .

USER_TOKEN

• Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.

Returns:

this

userTokenConfigurations

@Stability(Stable)
public CfnIndexMixinProps.Builder userTokenConfigurations(IResolvable userTokenConfigurations)

Sets the value of CfnIndexMixinProps.getUserTokenConfigurations()

Parameters:

userTokenConfigurations - Defines the type of user token used for the index.

Returns:

this

userTokenConfigurations

@Stability(Stable)
public CfnIndexMixinProps.Builder userTokenConfigurations(List<? extends Object> userTokenConfigurations)

Sets the value of CfnIndexMixinProps.getUserTokenConfigurations()

Parameters:

userTokenConfigurations - Defines the type of user token used for the index.

Returns:

this

build

@Stability(Stable)
public CfnIndexMixinProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnIndexMixinProps>

Returns:

a new instance of CfnIndexMixinProps

Throws:

NullPointerException - if any required attribute was not provided