Class CfnIndexProps
Properties for defining a CfnIndex
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Kendra
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnIndexProps : Object, ICfnIndexProps
Syntax (vb)
Public Class CfnIndexProps
Inherits Object
Implements ICfnIndexProps
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html
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.AWS.Kendra;
var cfnIndexProps = new CfnIndexProps {
Edition = "edition",
Name = "name",
RoleArn = "roleArn",
// the properties below are optional
CapacityUnits = new CapacityUnitsConfigurationProperty {
QueryCapacityUnits = 123,
StorageCapacityUnits = 123
},
Description = "description",
DocumentMetadataConfigurations = new [] { new DocumentMetadataConfigurationProperty {
Name = "name",
Type = "type",
// the properties below are optional
Relevance = new RelevanceProperty {
Duration = "duration",
Freshness = false,
Importance = 123,
RankOrder = "rankOrder",
ValueImportanceItems = new [] { new ValueImportanceItemProperty {
Key = "key",
Value = 123
} }
},
Search = new SearchProperty {
Displayable = false,
Facetable = false,
Searchable = false,
Sortable = false
}
} },
ServerSideEncryptionConfiguration = new ServerSideEncryptionConfigurationProperty {
KmsKeyId = "kmsKeyId"
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
UserContextPolicy = "userContextPolicy",
UserTokenConfigurations = new [] { new UserTokenConfigurationProperty {
JsonTokenTypeConfiguration = new JsonTokenTypeConfigurationProperty {
GroupAttributeField = "groupAttributeField",
UserNameAttributeField = "userNameAttributeField"
},
JwtTokenTypeConfiguration = new JwtTokenTypeConfigurationProperty {
KeyLocation = "keyLocation",
// the properties below are optional
ClaimRegex = "claimRegex",
GroupAttributeField = "groupAttributeField",
Issuer = "issuer",
SecretManagerArn = "secretManagerArn",
Url = "url",
UserNameAttributeField = "userNameAttributeField"
}
} }
};
Synopsis
Constructors
CfnIndexProps() |
Properties
CapacityUnits | Specifies additional capacity units configured for your Enterprise Edition index. |
Description | A description for the index. |
DocumentMetadataConfigurations | Specifies the properties of an index field. |
Edition | Indicates whether the index is a Enterprise Edition index or a Developer Edition index. |
Name | The name of the index. |
RoleArn | An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. |
ServerSideEncryptionConfiguration | The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra. |
Tags | An array of key-value pairs to apply to this resource. |
UserContextPolicy | The user context policy. |
UserTokenConfigurations | Defines the type of user token used for the index. |
Constructors
CfnIndexProps()
public CfnIndexProps()
Properties
CapacityUnits
Specifies additional capacity units configured for your Enterprise Edition index.
public object CapacityUnits { get; set; }
Property Value
System.Object
Remarks
You can add and remove capacity units to fit your usage requirements.
Description
A description for the index.
public string Description { get; set; }
Property Value
System.String
Remarks
DocumentMetadataConfigurations
Specifies the properties of an index field.
public object DocumentMetadataConfigurations { get; set; }
Property Value
System.Object
Remarks
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.
Edition
Indicates whether the index is a Enterprise Edition index or a Developer Edition index.
public string Edition { get; set; }
Property Value
System.String
Remarks
Valid values are DEVELOPER_EDITION
and ENTERPRISE_EDITION
.
Name
The name of the index.
public string Name { get; set; }
Property Value
System.String
Remarks
RoleArn
An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics.
public string RoleArn { get; set; }
Property Value
System.String
Remarks
This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.
ServerSideEncryptionConfiguration
The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra.
public object ServerSideEncryptionConfiguration { get; set; }
Property Value
System.Object
Remarks
Amazon Kendra doesn't support asymmetric CMKs.
Tags
An array of key-value pairs to apply to this resource.
public ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Remarks
For more information, see Tag .
UserContextPolicy
The user context policy.
public string UserContextPolicy { get; set; }
Property Value
System.String
Remarks
ATTRIBUTE_FILTER
USER_TOKEN
UserTokenConfigurations
Defines the type of user token used for the index.
public object UserTokenConfigurations { get; set; }
Property Value
System.Object