Class CfnDataSourceProps.Jsii$Proxy
- All Implemented Interfaces:
CfnDataSourceProps,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnDataSourceProps
CfnDataSourceProps-
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.services.qbusiness.CfnDataSourceProps
CfnDataSourceProps.Builder, CfnDataSourceProps.Jsii$Proxy -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedJsii$Proxy(CfnDataSourceProps.Builder builder) Constructor that initializes the object based on literal property values passed by theCfnDataSourceProps.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 theCfnDataSourceProps.Builder.
-
-
Method Details
-
getApplicationId
Description copied from interface:CfnDataSourcePropsThe identifier of the Amazon Q Business application the data source will be attached to.- Specified by:
getApplicationIdin interfaceCfnDataSourceProps- See Also:
-
getConfiguration
Description copied from interface:CfnDataSourcePropsUse 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 AWS CloudFormation to find the schemas for your data source connector, including configuration parameter descriptions and examples.
- Specified by:
getConfigurationin interfaceCfnDataSourceProps- See Also:
-
getDisplayName
Description copied from interface:CfnDataSourcePropsThe name of the Amazon Q Business data source.- Specified by:
getDisplayNamein interfaceCfnDataSourceProps- See Also:
-
getIndexId
Description copied from interface:CfnDataSourcePropsThe identifier of the index the data source is attached to.- Specified by:
getIndexIdin interfaceCfnDataSourceProps- See Also:
-
getDescription
Description copied from interface:CfnDataSourcePropsA description for the data source connector.- Specified by:
getDescriptionin interfaceCfnDataSourceProps- See Also:
-
getDocumentEnrichmentConfiguration
Description copied from interface:CfnDataSourcePropsProvides the configuration information for altering document metadata and content during the document ingestion process.For more information, see Custom document enrichment .
Returns union: either
IResolvableorCfnDataSource.DocumentEnrichmentConfigurationProperty- Specified by:
getDocumentEnrichmentConfigurationin interfaceCfnDataSourceProps- See Also:
-
getMediaExtractionConfiguration
Description copied from interface:CfnDataSourcePropsThe configuration for extracting information from media in documents.Returns union: either
IResolvableorCfnDataSource.MediaExtractionConfigurationProperty- Specified by:
getMediaExtractionConfigurationin interfaceCfnDataSourceProps- See Also:
-
getRoleArn
Description copied from interface:CfnDataSourcePropsThe 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 interfaceCfnDataSourceProps- See Also:
-
getSyncSchedule
Description copied from interface:CfnDataSourcePropsSets 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 interfaceCfnDataSourceProps- See Also:
-
getTags
Description copied from interface:CfnDataSourcePropsA 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 interfaceCfnDataSourceProps- See Also:
-
getVpcConfiguration
Description copied from interface:CfnDataSourcePropsConfiguration 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
IResolvableorCfnDataSource.DataSourceVpcConfigurationProperty- Specified by:
getVpcConfigurationin interfaceCfnDataSourceProps- 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()
-