software.amazon.awscdk.services.kendra

Class CfnIndex.Builder

java.lang.Object

software.amazon.awscdk.services.kendra.CfnIndex.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnIndex>

Enclosing class:

CfnIndex

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

A fluent builder for CfnIndex.

Method Summary

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

create

@Stability(value=Stable)
public static CfnIndex.Builder create(software.constructs.Construct scope,
                                                               String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnIndex.CapacityUnitsConfigurationProperty.Builder.

edition

@Stability(value=Stable)
public CfnIndex.Builder edition(String edition)

Indicates whether the index is a enterprise edition index or a developer edition index.

Valid values are DEVELOPER_EDITION and ENTERPRISE_EDITION .

Parameters:

edition - Indicates whether the index is a enterprise edition index or a developer edition index. This parameter is required.

Returns:

this

name

@Stability(value=Stable)
public CfnIndex.Builder name(String name)

The identifier of the index.

Parameters:

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

Returns:

this

roleArn

@Stability(value=Stable)
public CfnIndex.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

capacityUnits

@Stability(value=Stable)
public CfnIndex.Builder capacityUnits(CfnIndex.CapacityUnitsConfigurationProperty capacityUnits)

Specifies capacity units configured for your index.

You can add and remove capacity units to tune an index to your requirements. You can set capacity units only for Enterprise edition indexes.

Parameters:

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

Returns:

this

capacityUnits

@Stability(value=Stable)
public CfnIndex.Builder capacityUnits(IResolvable capacityUnits)

Specifies capacity units configured for your index.

You can add and remove capacity units to tune an index to your requirements. You can set capacity units only for Enterprise edition indexes.

Parameters:

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

Returns:

this

description

@Stability(value=Stable)
public CfnIndex.Builder description(String description)

A description of the index.

Parameters:

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

Returns:

this

documentMetadataConfigurations

@Stability(value=Stable)
public CfnIndex.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

documentMetadataConfigurations

@Stability(value=Stable)
public CfnIndex.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

serverSideEncryptionConfiguration

@Stability(value=Stable)
public CfnIndex.Builder serverSideEncryptionConfiguration(CfnIndex.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

serverSideEncryptionConfiguration

@Stability(value=Stable)
public CfnIndex.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

tags

@Stability(value=Stable)
public CfnIndex.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

userContextPolicy

@Stability(value=Stable)
public CfnIndex.Builder userContextPolicy(String userContextPolicy)

The user context policy.

ATTRIBUTE_FILTER

• All indexed content is searchable and displayable for all users. If there is an access control list, it is ignored. You can filter on user and group attributes.

USER_TOKEN

• Enables SSO and token-based user access control. 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

userTokenConfigurations

@Stability(value=Stable)
public CfnIndex.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

userTokenConfigurations

@Stability(value=Stable)
public CfnIndex.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

build

@Stability(value=Stable)
public CfnIndex build()

Specified by:

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