aws-cdk-lib.aws_kendra.CfnDataSource.InlineCustomDocumentEnrichmentConfigurationProperty

InlineCustomDocumentEnrichmentConfigurationProperty Struct

Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Kendra.

To apply advanced logic, to go beyond what you can do with basic logic, see HookConfiguration .

For more information, see Customizing document metadata during the ingestion process .

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kendra as kendra } from 'aws-cdk-lib';
const inlineCustomDocumentEnrichmentConfigurationProperty: kendra.CfnDataSource.InlineCustomDocumentEnrichmentConfigurationProperty = {
  condition: {
    conditionDocumentAttributeKey: 'conditionDocumentAttributeKey',
    operator: 'operator',

    // the properties below are optional
    conditionOnValue: {
      dateValue: 'dateValue',
      longValue: 123,
      stringListValue: ['stringListValue'],
      stringValue: 'stringValue',
    },
  },
  documentContentDeletion: false,
  target: {
    targetDocumentAttributeKey: 'targetDocumentAttributeKey',

    // the properties below are optional
    targetDocumentAttributeValue: {
      dateValue: 'dateValue',
      longValue: 123,
      stringListValue: ['stringListValue'],
      stringValue: 'stringValue',
    },
    targetDocumentAttributeValueDeletion: false,
  },
};

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_kendra as kendra

inline_custom_document_enrichment_configuration_property = kendra.CfnDataSource.InlineCustomDocumentEnrichmentConfigurationProperty(
    condition=kendra.CfnDataSource.DocumentAttributeConditionProperty(
        condition_document_attribute_key="conditionDocumentAttributeKey",
        operator="operator",

        # the properties below are optional
        condition_on_value=kendra.CfnDataSource.DocumentAttributeValueProperty(
            date_value="dateValue",
            long_value=123,
            string_list_value=["stringListValue"],
            string_value="stringValue"
        )
    ),
    document_content_deletion=False,
    target=kendra.CfnDataSource.DocumentAttributeTargetProperty(
        target_document_attribute_key="targetDocumentAttributeKey",

        # the properties below are optional
        target_document_attribute_value=kendra.CfnDataSource.DocumentAttributeValueProperty(
            date_value="dateValue",
            long_value=123,
            string_list_value=["stringListValue"],
            string_value="stringValue"
        ),
        target_document_attribute_value_deletion=False
    )
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.kendra.*;

InlineCustomDocumentEnrichmentConfigurationProperty inlineCustomDocumentEnrichmentConfigurationProperty = InlineCustomDocumentEnrichmentConfigurationProperty.builder()
        .condition(DocumentAttributeConditionProperty.builder()
                .conditionDocumentAttributeKey("conditionDocumentAttributeKey")
                .operator("operator")

                // the properties below are optional
                .conditionOnValue(DocumentAttributeValueProperty.builder()
                        .dateValue("dateValue")
                        .longValue(123)
                        .stringListValue(List.of("stringListValue"))
                        .stringValue("stringValue")
                        .build())
                .build())
        .documentContentDeletion(false)
        .target(DocumentAttributeTargetProperty.builder()
                .targetDocumentAttributeKey("targetDocumentAttributeKey")

                // the properties below are optional
                .targetDocumentAttributeValue(DocumentAttributeValueProperty.builder()
                        .dateValue("dateValue")
                        .longValue(123)
                        .stringListValue(List.of("stringListValue"))
                        .stringValue("stringValue")
                        .build())
                .targetDocumentAttributeValueDeletion(false)
                .build())
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// 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 inlineCustomDocumentEnrichmentConfigurationProperty = new InlineCustomDocumentEnrichmentConfigurationProperty {
    Condition = new DocumentAttributeConditionProperty {
        ConditionDocumentAttributeKey = "conditionDocumentAttributeKey",
        Operator = "operator",

        // the properties below are optional
        ConditionOnValue = new DocumentAttributeValueProperty {
            DateValue = "dateValue",
            LongValue = 123,
            StringListValue = new [] { "stringListValue" },
            StringValue = "stringValue"
        }
    },
    DocumentContentDeletion = false,
    Target = new DocumentAttributeTargetProperty {
        TargetDocumentAttributeKey = "targetDocumentAttributeKey",

        // the properties below are optional
        TargetDocumentAttributeValue = new DocumentAttributeValueProperty {
            DateValue = "dateValue",
            LongValue = 123,
            StringListValue = new [] { "stringListValue" },
            StringValue = "stringValue"
        },
        TargetDocumentAttributeValueDeletion = false
    }
};

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

inlineCustomDocumentEnrichmentConfigurationProperty := &InlineCustomDocumentEnrichmentConfigurationProperty{
	Condition: &DocumentAttributeConditionProperty{
		ConditionDocumentAttributeKey: jsii.String("conditionDocumentAttributeKey"),
		Operator: jsii.String("operator"),

		// the properties below are optional
		ConditionOnValue: &DocumentAttributeValueProperty{
			DateValue: jsii.String("dateValue"),
			LongValue: jsii.Number(123),
			StringListValue: []*string{
				jsii.String("stringListValue"),
			},
			StringValue: jsii.String("stringValue"),
		},
	},
	DocumentContentDeletion: jsii.Boolean(false),
	Target: &DocumentAttributeTargetProperty{
		TargetDocumentAttributeKey: jsii.String("targetDocumentAttributeKey"),

		// the properties below are optional
		TargetDocumentAttributeValue: &DocumentAttributeValueProperty{
			DateValue: jsii.String("dateValue"),
			LongValue: jsii.Number(123),
			StringListValue: []*string{
				jsii.String("stringListValue"),
			},
			StringValue: jsii.String("stringValue"),
		},
		TargetDocumentAttributeValueDeletion: jsii.Boolean(false),
	},
}

Properties

condition?optionalIResolvable | CfnDataSource.DocumentAttributeConditionPropertycondition?optionaltyping.Union[IResolvable, DocumentAttributeConditionProperty]condition?optionalIResolvableCondition?optionalIResolvableCondition?optionalinterface{}#

Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra.

documentContentDeletion?optionalboolean | IResolvabledocument_content_deletion?optionaltyping.Union[bool, IResolvable]documentContentDeletion?optionalBooleanDocumentContentDeletion?optionalboolDocumentContentDeletion?optionalinterface{}#

`TRUE` to delete content if the condition used for the target attribute is met.

target?optionalIResolvable | CfnDataSource.DocumentAttributeTargetPropertytarget?optionaltyping.Union[IResolvable, DocumentAttributeTargetProperty]target?optionalIResolvableTarget?optionalIResolvableTarget?optionalinterface{}#

Configuration of the target document attribute or metadata field when ingesting documents into Amazon Kendra.

You can also include a value.