Class CfnDataSourceMixinProps.Jsii$Proxy
- All Implemented Interfaces:
CfnDataSourceMixinProps,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnDataSourceMixinProps
CfnDataSourceMixinProps-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.cfnpropertymixins.services.qbusiness.CfnDataSourceMixinProps
CfnDataSourceMixinProps.Builder, CfnDataSourceMixinProps.Jsii$Proxy -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstructor that initializes the object based on literal property values passed by theCfnDataSourceMixinProps.Builder.protectedJsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNodefinal booleanfinal StringThe identifier of the Amazon Q Business application the data source will be attached to.final ObjectUse this property to specify a JSON or YAML schema with configuration properties specific to your data source connector to connect your data source repository to Amazon Q Business .final StringA description for the data source connector.final StringThe name of the Amazon Q Business data source.final ObjectProvides the configuration information for altering document metadata and content during the document ingestion process.final StringThe identifier of the index the data source is attached to.final ObjectThe configuration for extracting information from media in documents.final StringThe Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.final StringSets the frequency for Amazon Q Business to check the documents in your data source repository and update your index.getTags()A list of key-value pairs that identify or categorize the data source connector.final ObjectConfiguration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.final inthashCode()Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theCfnDataSourceMixinProps.Builder.
-
-
Method Details
-
getApplicationId
Description copied from interface:CfnDataSourceMixinPropsThe identifier of the Amazon Q Business application the data source will be attached to.- Specified by:
getApplicationIdin interfaceCfnDataSourceMixinProps- See Also:
-
getConfiguration
Description copied from interface:CfnDataSourceMixinPropsUse this property to specify a JSON or YAML schema with configuration properties specific to your data source connector to connect your data source repository to Amazon Q Business .You must use the JSON or YAML schema provided by Amazon Q .
The following links have the configuration properties and schemas for AWS CloudFormation for the following connectors:
Similarly, you can find configuration templates and properties for your specific data source using the following steps:
- Navigate to the Supported connectors page in the Amazon Q Business User Guide, and select the data source connector of your choice.
- Then, from that specific data source connector's page, choose the topic containing Using CloudFormation to find the schemas for your data source connector, including configuration parameter descriptions and examples.
- Specified by:
getConfigurationin interfaceCfnDataSourceMixinProps- See Also:
-
getDescription
Description copied from interface:CfnDataSourceMixinPropsA description for the data source connector.- Specified by:
getDescriptionin interfaceCfnDataSourceMixinProps- See Also:
-
getDisplayName
Description copied from interface:CfnDataSourceMixinPropsThe name of the Amazon Q Business data source.- Specified by:
getDisplayNamein interfaceCfnDataSourceMixinProps- See Also:
-
getDocumentEnrichmentConfiguration
Description copied from interface:CfnDataSourceMixinPropsProvides the configuration information for altering document metadata and content during the document ingestion process.For more information, see Custom document enrichment .
Returns union: either
IResolvableorCfnDataSourcePropsMixin.DocumentEnrichmentConfigurationProperty- Specified by:
getDocumentEnrichmentConfigurationin interfaceCfnDataSourceMixinProps- See Also:
-
getIndexId
Description copied from interface:CfnDataSourceMixinPropsThe identifier of the index the data source is attached to.- Specified by:
getIndexIdin interfaceCfnDataSourceMixinProps- See Also:
-
getMediaExtractionConfiguration
Description copied from interface:CfnDataSourceMixinPropsThe configuration for extracting information from media in documents.Returns union: either
IResolvableorCfnDataSourcePropsMixin.MediaExtractionConfigurationProperty- Specified by:
getMediaExtractionConfigurationin interfaceCfnDataSourceMixinProps- See Also:
-
getRoleArn
Description copied from interface:CfnDataSourceMixinPropsThe Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.This field is required for all connector types except custom connectors, where it is optional.
- Specified by:
getRoleArnin interfaceCfnDataSourceMixinProps- See Also:
-
getSyncSchedule
Description copied from interface:CfnDataSourceMixinPropsSets the frequency for Amazon Q Business to check the documents in your data source repository and update your index.If you don't set a schedule, Amazon Q Business won't periodically update the index.
Specify a
cron-format schedule string or an empty string to indicate that the index is updated on demand. You can't specify theScheduleparameter when theTypeparameter is set toCUSTOM. If you do, you receive aValidationExceptionexception.- Specified by:
getSyncSchedulein interfaceCfnDataSourceMixinProps- See Also:
-
getTags
Description copied from interface:CfnDataSourceMixinPropsA list of key-value pairs that identify or categorize the data source connector.You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -
- Specified by:
getTagsin interfaceCfnDataSourceMixinProps- See Also:
-
getVpcConfiguration
Description copied from interface:CfnDataSourceMixinPropsConfiguration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.For more information, see Using Amazon VPC with Amazon Q Business connectors .
Returns union: either
IResolvableorCfnDataSourcePropsMixin.DataSourceVpcConfigurationProperty- Specified by:
getVpcConfigurationin interfaceCfnDataSourceMixinProps- See Also:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-