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

Class CfnIndexPropsMixin.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnIndexPropsMixin>

Enclosing class:

CfnIndexPropsMixin

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

A fluent builder for CfnIndexPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnIndexPropsMixin	build()
CfnIndexPropsMixin.Builder	capacityUnits(CfnIndexPropsMixin.CapacityUnitsConfigurationProperty capacityUnits)	Specifies additional capacity units configured for your Enterprise Edition index.
CfnIndexPropsMixin.Builder	capacityUnits(IResolvable capacityUnits)	Specifies additional capacity units configured for your Enterprise Edition index.
static CfnIndexPropsMixin.Builder	create()
static CfnIndexPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnIndexPropsMixin.Builder	description(String description)	A description for the index.
CfnIndexPropsMixin.Builder	documentMetadataConfigurations(List<? extends Object> documentMetadataConfigurations)	Specifies the properties of an index field.
CfnIndexPropsMixin.Builder	documentMetadataConfigurations(IResolvable documentMetadataConfigurations)	Specifies the properties of an index field.
CfnIndexPropsMixin.Builder	edition(String edition)	Indicates whether the index is a Enterprise Edition index, a Developer Edition index, or a GenAI Enterprise Edition index.
CfnIndexPropsMixin.Builder	name(String name)	The name of the index.
CfnIndexPropsMixin.Builder	roleArn(String roleArn)	An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics.
CfnIndexPropsMixin.Builder	roleArn(IRoleRef roleArn)	An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics.
CfnIndexPropsMixin.Builder	serverSideEncryptionConfiguration(CfnIndexPropsMixin.ServerSideEncryptionConfigurationProperty serverSideEncryptionConfiguration)	The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra.
CfnIndexPropsMixin.Builder	serverSideEncryptionConfiguration(IResolvable serverSideEncryptionConfiguration)	The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra.
CfnIndexPropsMixin.Builder	tags(List<? extends CfnTag> tags)	An array of key-value pairs to apply to this resource.
CfnIndexPropsMixin.Builder	userContextPolicy(String userContextPolicy)	The user context policy.
CfnIndexPropsMixin.Builder	userTokenConfigurations(List<? extends Object> userTokenConfigurations)	Defines the type of user token used for the index.
CfnIndexPropsMixin.Builder	userTokenConfigurations(IResolvable userTokenConfigurations)	Defines the type of user token used for the index.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnIndexPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnIndexPropsMixin.Builder.

create

@Stability(Stable)
public static CfnIndexPropsMixin.Builder create()

Returns:

a new instance of CfnIndexPropsMixin.Builder.

capacityUnits

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

Specifies additional capacity units configured for your Enterprise Edition index.

You can add and remove capacity units to fit your usage requirements.

Parameters:

capacityUnits - Specifies additional capacity units configured for your Enterprise Edition index. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-capacityunits

capacityUnits

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

Specifies additional capacity units configured for your Enterprise Edition index.

You can add and remove capacity units to fit your usage requirements.

Parameters:

capacityUnits - Specifies additional capacity units configured for your Enterprise Edition index. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-capacityunits

description

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

A description for the index.

Parameters:

description - A description for the index. This parameter is required.

Returns:

this

See Also:

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

documentMetadataConfigurations

@Stability(Stable)
public CfnIndexPropsMixin.Builder documentMetadataConfigurations(IResolvable 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.

Parameters:

documentMetadataConfigurations - Specifies the properties of an index field. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-documentmetadataconfigurations

documentMetadataConfigurations

@Stability(Stable)
public CfnIndexPropsMixin.Builder documentMetadataConfigurations(List<? extends Object> 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.

Parameters:

documentMetadataConfigurations - Specifies the properties of an index field. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-documentmetadataconfigurations

edition

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-edition

name

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

The name of the index.

Parameters:

name - The name of the index. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-name

roleArn

@Stability(Stable)
public CfnIndexPropsMixin.Builder roleArn(String 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.

Parameters:

roleArn - An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-rolearn

roleArn

@Stability(Stable)
public CfnIndexPropsMixin.Builder roleArn(IRoleRef 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.

Parameters:

roleArn - An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-rolearn

serverSideEncryptionConfiguration

@Stability(Stable)
public CfnIndexPropsMixin.Builder serverSideEncryptionConfiguration(IResolvable 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.

Parameters:

serverSideEncryptionConfiguration - The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-serversideencryptionconfiguration

serverSideEncryptionConfiguration

@Stability(Stable)
public CfnIndexPropsMixin.Builder serverSideEncryptionConfiguration(CfnIndexPropsMixin.ServerSideEncryptionConfigurationProperty 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.

Parameters:

serverSideEncryptionConfiguration - The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-serversideencryptionconfiguration

tags

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

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

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

userContextPolicy

@Stability(Stable)
public CfnIndexPropsMixin.Builder userContextPolicy(String 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.

Parameters:

userContextPolicy - The user context policy. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-usercontextpolicy

userTokenConfigurations

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

Defines the type of user token used for the index.

Parameters:

userTokenConfigurations - Defines the type of user token used for the index. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-usertokenconfigurations

userTokenConfigurations

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

Defines the type of user token used for the index.

Parameters:

userTokenConfigurations - Defines the type of user token used for the index. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-usertokenconfigurations

build

@Stability(Stable)
public CfnIndexPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnIndexPropsMixin.