Class CfnIndex
A CloudFormation AWS::Kendra::Index
.
Inherited Members
Namespace: Amazon.CDK.AWS.Kendra
Assembly: Amazon.CDK.AWS.Kendra.dll
Syntax (csharp)
public class CfnIndex : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnIndex
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Creates an Amazon Kendra index
Once the index is active you can add documents to your index using the BatchPutDocument operation or using one of the supported data sources.
CloudformationResource: AWS::Kendra::Index
Link: 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 cfnIndex = new CfnIndex(this, "MyCfnIndex", 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
CfnIndex(Construct, String, ICfnIndexProps) | Create a new |
CfnIndex(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnIndex(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The Amazon Resource Name (ARN) of the index. |
AttrId | The identifier for the index. |
CapacityUnits |
|
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnIndex(Construct, String, ICfnIndexProps)
Create a new AWS::Kendra::Index
.
public CfnIndex(Construct scope, string id, ICfnIndexProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnIndexProps
- resource properties.
CfnIndex(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnIndex(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnIndex(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnIndex(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The Amazon Resource Name (ARN) of the index.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
For example: arn:aws:kendra:us-west-2:111122223333:index/0123456789abcdef
.
CloudformationAttribute: Arn
AttrId
The identifier for the index.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
For example: f4aeaa10-8056-4b2c-a343-522ca0f41234
.
CloudformationAttribute: Id
CapacityUnits
AWS::Kendra::Index.CapacityUnits
.
public virtual object CapacityUnits { get; set; }
Property Value
System.Object
Remarks
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
A description for the index.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
DocumentMetadataConfigurations
Specifies the properties of an index field.
public virtual 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 virtual string Edition { get; set; }
Property Value
System.String
Remarks
Valid values are DEVELOPER_EDITION
and ENTERPRISE_EDITION
.
Name
The name of the index.
public virtual 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 virtual 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 virtual 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 virtual TagManager Tags { get; }
Property Value
Remarks
For more information, see Tag .
UserContextPolicy
The user context policy.
public virtual 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 virtual object UserTokenConfigurations { get; set; }
Property Value
System.Object
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>