Class CfnDataSource
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.qbusiness.CfnDataSource
- All Implemented Interfaces:
IInspectable
,ITaggableV2
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-11T15:56:02.642Z")
@Stability(Stable)
public class CfnDataSource
extends CfnResource
implements IInspectable, ITaggableV2
Creates a data source connector for an Amazon Q Business application.
CreateDataSource
is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.qbusiness.*; Object configuration; CfnDataSource cfnDataSource = CfnDataSource.Builder.create(this, "MyCfnDataSource") .applicationId("applicationId") .configuration(configuration) .displayName("displayName") .indexId("indexId") // the properties below are optional .description("description") .documentEnrichmentConfiguration(DocumentEnrichmentConfigurationProperty.builder() .inlineConfigurations(List.of(InlineDocumentEnrichmentConfigurationProperty.builder() .condition(DocumentAttributeConditionProperty.builder() .key("key") .operator("operator") // the properties below are optional .value(DocumentAttributeValueProperty.builder() .dateValue("dateValue") .longValue(123) .stringListValue(List.of("stringListValue")) .stringValue("stringValue") .build()) .build()) .documentContentOperator("documentContentOperator") .target(DocumentAttributeTargetProperty.builder() .key("key") // the properties below are optional .attributeValueOperator("attributeValueOperator") .value(DocumentAttributeValueProperty.builder() .dateValue("dateValue") .longValue(123) .stringListValue(List.of("stringListValue")) .stringValue("stringValue") .build()) .build()) .build())) .postExtractionHookConfiguration(HookConfigurationProperty.builder() .invocationCondition(DocumentAttributeConditionProperty.builder() .key("key") .operator("operator") // the properties below are optional .value(DocumentAttributeValueProperty.builder() .dateValue("dateValue") .longValue(123) .stringListValue(List.of("stringListValue")) .stringValue("stringValue") .build()) .build()) .lambdaArn("lambdaArn") .roleArn("roleArn") .s3BucketName("s3BucketName") .build()) .preExtractionHookConfiguration(HookConfigurationProperty.builder() .invocationCondition(DocumentAttributeConditionProperty.builder() .key("key") .operator("operator") // the properties below are optional .value(DocumentAttributeValueProperty.builder() .dateValue("dateValue") .longValue(123) .stringListValue(List.of("stringListValue")) .stringValue("stringValue") .build()) .build()) .lambdaArn("lambdaArn") .roleArn("roleArn") .s3BucketName("s3BucketName") .build()) .build()) .roleArn("roleArn") .syncSchedule("syncSchedule") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .vpcConfiguration(DataSourceVpcConfigurationProperty.builder() .securityGroupIds(List.of("securityGroupIds")) .subnetIds(List.of("subnetIds")) .build()) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnDataSource
.static interface
Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).static interface
The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business.static interface
The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.static interface
The value of a document attribute.static interface
Provides the configuration information for altering document metadata and content during the document ingestion process.static interface
Provides the configuration information for invoking a Lambda function in AWS Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.static interface
Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q Business.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2
ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnDataSource
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnDataSource
(software.amazon.jsii.JsiiObjectRef objRef) CfnDataSource
(software.constructs.Construct scope, String id, CfnDataSourceProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe identifier of the Amazon Q Business application the data source will be attached to.The Unix timestamp when the Amazon Q Business data source was created.The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.The identifier of the Amazon Q Business data source.The status of the Amazon Q Business data source.The type of the Amazon Q Business data source.The Unix timestamp when the Amazon Q Business data source was last updated.Tag Manager which manages the tags for this resource.Use this property to specify a JSON or YAML schema with configuration information specific to your data source connector to connect your data source repository to Amazon Q Business .A description for the data source connector.The name of the Amazon Q Business data source.Provides the configuration information for altering document metadata and content during the document ingestion process.The identifier of the index the data source is attached to.The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.Sets 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.Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setApplicationId
(String value) The identifier of the Amazon Q Business application the data source will be attached to.void
setConfiguration
(Object value) Use this property to specify a JSON or YAML schema with configuration information specific to your data source connector to connect your data source repository to Amazon Q Business .void
setDescription
(String value) A description for the data source connector.void
setDisplayName
(String value) The name of the Amazon Q Business data source.void
Provides the configuration information for altering document metadata and content during the document ingestion process.void
Provides the configuration information for altering document metadata and content during the document ingestion process.void
setIndexId
(String value) The identifier of the index the data source is attached to.void
setRoleArn
(String value) The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.void
setSyncSchedule
(String value) Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index.void
A list of key-value pairs that identify or categorize the data source connector.void
setVpcConfiguration
(IResolvable value) Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.void
Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnDataSource
protected CfnDataSource(software.amazon.jsii.JsiiObjectRef objRef) -
CfnDataSource
protected CfnDataSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnDataSource
@Stability(Stable) public CfnDataSource(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDataSourceProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrCreatedAt
The Unix timestamp when the Amazon Q Business data source was created. -
getAttrDataSourceArn
The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application. -
getAttrDataSourceId
The identifier of the Amazon Q Business data source. -
getAttrStatus
The status of the Amazon Q Business data source. -
getAttrType
The type of the Amazon Q Business data source. -
getAttrUpdatedAt
The Unix timestamp when the Amazon Q Business data source was last updated. -
getCdkTagManager
Tag Manager which manages the tags for this resource.- Specified by:
getCdkTagManager
in interfaceITaggableV2
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getApplicationId
The identifier of the Amazon Q Business application the data source will be attached to. -
setApplicationId
The identifier of the Amazon Q Business application the data source will be attached to. -
getConfiguration
Use this property to specify a JSON or YAML schema with configuration information specific to your data source connector to connect your data source repository to Amazon Q Business . -
setConfiguration
Use this property to specify a JSON or YAML schema with configuration information specific to your data source connector to connect your data source repository to Amazon Q Business . -
getDisplayName
The name of the Amazon Q Business data source. -
setDisplayName
The name of the Amazon Q Business data source. -
getIndexId
The identifier of the index the data source is attached to. -
setIndexId
The identifier of the index the data source is attached to. -
getDescription
A description for the data source connector. -
setDescription
A description for the data source connector. -
getDocumentEnrichmentConfiguration
Provides the configuration information for altering document metadata and content during the document ingestion process. -
setDocumentEnrichmentConfiguration
Provides the configuration information for altering document metadata and content during the document ingestion process. -
setDocumentEnrichmentConfiguration
@Stability(Stable) public void setDocumentEnrichmentConfiguration(@Nullable CfnDataSource.DocumentEnrichmentConfigurationProperty value) Provides the configuration information for altering document metadata and content during the document ingestion process. -
getRoleArn
The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. -
setRoleArn
The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. -
getSyncSchedule
Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. -
setSyncSchedule
Sets 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. -
setTags
A list of key-value pairs that identify or categorize the data source connector. -
getVpcConfiguration
Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. -
setVpcConfiguration
Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. -
setVpcConfiguration
@Stability(Stable) public void setVpcConfiguration(@Nullable CfnDataSource.DataSourceVpcConfigurationProperty value) Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.
-