@propulsionworks/cloudformation 0.1.0 → 0.1.2

package/out/exports/resources.generated/aws-qbusiness-dataaccessor.d.ts

@@ -1,11 +1,17 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Creates a new data accessor for an ISV to access data from a Amazon Q Business application. The data accessor is an entity that represents the ISV's access to the Amazon Q Business application's data. It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, an IAM Identity Center application is also created to manage the ISV's identity and authentication for accessing the Amazon Q Business application.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html}
+ */
 export type QBusinessDataAccessor = ResourceDefinitionWithAttributes<"AWS::QBusiness::DataAccessor", QBusinessDataAccessorProps, QBusinessDataAccessorAttribs>;
 /**
  * Creates a new data accessor for an ISV to access data from a Amazon Q Business application. The data accessor is an entity that represents the ISV's access to the Amazon Q Business application's data. It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, an IAM Identity Center application is also created to manage the ISV's identity and authentication for accessing the Amazon Q Business application.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html}
  */
 export type QBusinessDataAccessorProps = {
     /**
      * A list of action configurations specifying the allowed actions and any associated filters.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html#cfn-qbusiness-dataaccessor-actionconfigurations}
      */
     ActionConfigurations: ActionConfiguration[];
     /**
@@ -13,6 +19,7 @@ export type QBusinessDataAccessorProps = {
      * @minLength 36
      * @maxLength 36
      * @pattern ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html#cfn-qbusiness-dataaccessor-applicationid}
      */
     ApplicationId: string;
     /**
@@ -20,6 +27,7 @@ export type QBusinessDataAccessorProps = {
      * @minLength 1
      * @maxLength 100
      * @pattern ^[a-zA-Z0-9][a-zA-Z0-9_-]*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html#cfn-qbusiness-dataaccessor-displayname}
      */
     DisplayName: string;
     /**
@@ -27,17 +35,23 @@ export type QBusinessDataAccessorProps = {
      * @minLength 1
      * @maxLength 1284
      * @pattern ^arn:aws:iam::[0-9]{12}:role/[a-zA-Z0-9_/+=,.@-]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html#cfn-qbusiness-dataaccessor-principal}
      */
     Principal: string;
     /**
      * The tags to associate with the data accessor.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html#cfn-qbusiness-dataaccessor-tags}
      */
     Tags?: Tag[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html#aws-resource-qbusiness-dataaccessor-return-values}
+ */
 export type QBusinessDataAccessorAttribs = {
     /**
      * The timestamp when the data accessor was created.
      * @format date-time
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html#cfn-qbusiness-dataaccessor-createdat}
      */
     CreatedAt: string;
     /**
@@ -45,6 +59,7 @@ export type QBusinessDataAccessorAttribs = {
      * @minLength 0
      * @maxLength 1284
      * @pattern ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html#cfn-qbusiness-dataaccessor-dataaccessorarn}
      */
     DataAccessorArn: string;
     /**
@@ -52,6 +67,7 @@ export type QBusinessDataAccessorAttribs = {
      * @minLength 36
      * @maxLength 36
      * @pattern ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html#cfn-qbusiness-dataaccessor-dataaccessorid}
      */
     DataAccessorId: string;
     /**
@@ -59,84 +75,103 @@ export type QBusinessDataAccessorAttribs = {
      * @minLength 10
      * @maxLength 1224
      * @pattern ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html#cfn-qbusiness-dataaccessor-idcapplicationarn}
      */
     IdcApplicationArn: string;
     /**
      * The timestamp when the data accessor was last updated.
      * @format date-time
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html#cfn-qbusiness-dataaccessor-updatedat}
      */
     UpdatedAt: string;
 };
 /**
  * Specifies an allowed action and its associated filter configuration.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-actionconfiguration.html}
  */
 export type ActionConfiguration = {
     /**
      * The Amazon Q Business action that is allowed.
      * @pattern ^qbusiness:[a-zA-Z]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-actionconfiguration.html#cfn-qbusiness-dataaccessor-actionconfiguration-action}
      */
     Action: string;
     /**
      * The filter configuration for the action, if any.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-actionconfiguration.html#cfn-qbusiness-dataaccessor-actionconfiguration-filterconfiguration}
      */
     FilterConfiguration?: ActionFilterConfiguration | undefined;
 };
 /**
  * Specifies filters to apply to an allowed action.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-actionfilterconfiguration.html}
  */
 export type ActionFilterConfiguration = {
     /**
      * Enables filtering of responses based on document attributes or metadata fields.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-actionfilterconfiguration.html#cfn-qbusiness-dataaccessor-actionfilterconfiguration-documentattributefilter}
      */
     DocumentAttributeFilter: AttributeFilter;
 };
 /**
  * Enables filtering of responses based on document attributes or metadata fields.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html}
  */
 export type AttributeFilter = {
     /**
      * Performs a logical `AND` operation on all supplied filters.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-andallfilters}
      */
     AndAllFilters?: AttributeFilter[] | undefined;
     /**
      * Returns `true` when a document contains all the specified document attributes or metadata fields. Supported for the following [document attribute value types](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html) : `stringListValue` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-containsall}
      */
     ContainsAll?: DocumentAttribute | undefined;
     /**
      * Returns `true` when a document contains any of the specified document attributes or metadata fields. Supported for the following [document attribute value types](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html) : `stringListValue` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-containsany}
      */
     ContainsAny?: DocumentAttribute | undefined;
     /**
      * Performs an equals operation on two document attributes or metadata fields. Supported for the following [document attribute value types](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html) : `dateValue` , `longValue` , `stringListValue` and `stringValue` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-equalsto}
      */
     EqualsTo?: DocumentAttribute | undefined;
     /**
      * Performs a greater than operation on two document attributes or metadata fields. Supported for the following [document attribute value types](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html) : `dateValue` and `longValue` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-greaterthan}
      */
     GreaterThan?: DocumentAttribute | undefined;
     /**
      * Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following [document attribute value types](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html) : `dateValue` and `longValue` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-greaterthanorequals}
      */
     GreaterThanOrEquals?: DocumentAttribute | undefined;
     /**
      * Performs a less than operation on two document attributes or metadata fields. Supported for the following [document attribute value types](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html) : `dateValue` and `longValue` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-lessthan}
      */
     LessThan?: DocumentAttribute | undefined;
     /**
      * Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following [document attribute value type](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html) : `dateValue` and `longValue` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-lessthanorequals}
      */
     LessThanOrEquals?: DocumentAttribute | undefined;
     /**
      * Performs a logical `NOT` operation on all supplied filters.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-notfilter}
      */
     NotFilter?: AttributeFilter | undefined;
     /**
      * Performs a logical `OR` operation on all supplied filters.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-orallfilters}
      */
     OrAllFilters?: AttributeFilter[] | undefined;
 };
 /**
  * A document attribute or metadata field.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattribute.html}
  */
 export type DocumentAttribute = {
     /**
@@ -144,15 +179,18 @@ export type DocumentAttribute = {
      * @minLength 1
      * @maxLength 200
      * @pattern ^[a-zA-Z0-9_][a-zA-Z0-9_-]*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattribute.html#cfn-qbusiness-dataaccessor-documentattribute-name}
      */
     Name: string;
     /**
      * The value of the attribute.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattribute.html#cfn-qbusiness-dataaccessor-documentattribute-value}
      */
     Value: DocumentAttributeValue;
 };
 /**
  * The value of a document attribute. You can only provide one value for a document attribute.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattributevalue.html}
  */
 export type DocumentAttributeValue = {
     /**

package/out/exports/resources.generated/aws-qbusiness-datasource.d.ts

@@ -1,9 +1,16 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html}
+ */
 export type QBusinessDataSource = ResourceDefinitionWithAttributes<"AWS::QBusiness::DataSource", QBusinessDataSourceProps, QBusinessDataSourceAttribs>;
 /**
  * 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html}
  */
 export type QBusinessDataSourceProps = {
     /**
@@ -11,6 +18,7 @@ export type QBusinessDataSourceProps = {
      * @minLength 36
      * @maxLength 36
      * @pattern ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-applicationid}
      */
     ApplicationId: string;
     /**
@@ -25,6 +33,7 @@ export type QBusinessDataSourceProps = {
      *
      * - Navigate to the [Supported connectors](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html) 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-configuration}
      */
     Configuration: unknown;
     /**
@@ -32,6 +41,7 @@ export type QBusinessDataSourceProps = {
      * @minLength 0
      * @maxLength 1000
      * @pattern ^[\s\S]*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-description}
      */
     Description?: string | undefined;
     /**
@@ -39,12 +49,14 @@ export type QBusinessDataSourceProps = {
      * @minLength 1
      * @maxLength 1000
      * @pattern ^[a-zA-Z0-9][a-zA-Z0-9_-]*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-displayname}
      */
     DisplayName: string;
     /**
      * Provides the configuration information for altering document metadata and content during the document ingestion process.
      *
      * For more information, see [Custom document enrichment](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-documentenrichmentconfiguration}
      */
     DocumentEnrichmentConfiguration?: DocumentEnrichmentConfiguration | undefined;
     /**
@@ -52,10 +64,12 @@ export type QBusinessDataSourceProps = {
      * @minLength 36
      * @maxLength 36
      * @pattern ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-indexid}
      */
     IndexId: string;
     /**
      * The configuration for extracting information from media in documents.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-mediaextractionconfiguration}
      */
     MediaExtractionConfiguration?: MediaExtractionConfiguration | undefined;
     /**
@@ -63,6 +77,7 @@ export type QBusinessDataSourceProps = {
      * @minLength 0
      * @maxLength 1284
      * @pattern ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-rolearn}
      */
     RoleArn?: string | undefined;
     /**
@@ -71,21 +86,28 @@ export type QBusinessDataSourceProps = {
      * Specify a `cron-` format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the `Schedule` parameter when the `Type` parameter is set to `CUSTOM` . If you do, you receive a `ValidationException` exception.
      * @maxLength 998
      * @pattern ^[\s\S]*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-syncschedule}
      */
     SyncSchedule?: string | undefined;
     /**
      * A 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: _ . : / = + - @.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-tags}
      */
     Tags?: Tag[] | undefined;
     /**
      * Configuration 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](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connector-vpc.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-vpcconfiguration}
      */
     VpcConfiguration?: DataSourceVpcConfiguration | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#aws-resource-qbusiness-datasource-return-values}
+ */
 export type QBusinessDataSourceAttribs = {
     /**
      * The Unix timestamp when the Amazon Q Business data source was created.
      * @format date-time
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-createdat}
      */
     CreatedAt: string;
     /**
@@ -93,6 +115,7 @@ export type QBusinessDataSourceAttribs = {
      * @minLength 0
      * @maxLength 1284
      * @pattern ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-datasourcearn}
      */
     DataSourceArn: string;
     /**
@@ -100,46 +123,64 @@ export type QBusinessDataSourceAttribs = {
      * @minLength 36
      * @maxLength 36
      * @pattern ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-datasourceid}
      */
     DataSourceId: string;
     /**
      * The status of the Amazon Q Business data source.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-status}
      */
     Status: DataSourceStatus;
     /**
      * The type of the Amazon Q Business data source.
      * @minLength 1
      * @maxLength 2048
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-type}
      */
     Type: string;
     /**
      * The Unix timestamp when the Amazon Q Business data source was last updated.
      * @format date-time
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-updatedat}
      */
     UpdatedAt: string;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-attributevalueoperator.html}
+ */
 export type AttributeValueOperator = "DELETE";
 /**
  * Configuration settings for audio content extraction and processing.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-audioextractionconfiguration.html}
  */
 export type AudioExtractionConfiguration = {
     /**
      * The status of audio extraction (ENABLED or DISABLED) for processing audio content from files.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-audioextractionconfiguration.html#cfn-qbusiness-datasource-audioextractionconfiguration-audioextractionstatus}
      */
     AudioExtractionStatus: AudioExtractionStatus;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-audioextractionstatus.html}
+ */
 export type AudioExtractionStatus = "ENABLED" | "DISABLED";
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-datasourcestatus.html}
+ */
 export type DataSourceStatus = "PENDING_CREATION" | "CREATING" | "ACTIVE" | "DELETING" | "FAILED" | "UPDATING";
 /**
  * Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-datasourcevpcconfiguration.html}
  */
 export type DataSourceVpcConfiguration = {
     /**
      * A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-datasourcevpcconfiguration.html#cfn-qbusiness-datasource-datasourcevpcconfiguration-securitygroupids}
      */
     SecurityGroupIds: string[];
     /**
      * A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-datasourcevpcconfiguration.html#cfn-qbusiness-datasource-datasourcevpcconfiguration-subnetids}
      */
     SubnetIds: string[];
 };
@@ -149,6 +190,7 @@ export type DataSourceVpcConfiguration = {
  * For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.
  *
  * Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using `DocumentAttributeTarget` . Amazon Q Business then will map your newly created metadata field to your index field.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributecondition.html}
  */
 export type DocumentAttributeCondition = {
     /**
@@ -160,6 +202,7 @@ export type DocumentAttributeCondition = {
      * @minLength 1
      * @maxLength 200
      * @pattern ^[a-zA-Z0-9_][a-zA-Z0-9_-]*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributecondition.html#cfn-qbusiness-datasource-documentattributecondition-key}
      */
     Key: string;
     /**
@@ -168,10 +211,12 @@ export type DocumentAttributeCondition = {
      * For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
      *
      * Amazon Q Business currently does not support `_document_body` as an attribute key used for the condition.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributecondition.html#cfn-qbusiness-datasource-documentattributecondition-operator}
      */
     Operator: DocumentEnrichmentConditionOperator;
     /**
      * The value of a document attribute. You can only provide one value for a document attribute.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributecondition.html#cfn-qbusiness-datasource-documentattributecondition-value}
      */
     Value?: DocumentAttributeValue | undefined;
 };
@@ -183,10 +228,12 @@ export type DocumentAttributeCondition = {
  * Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using [`DocumentAttributeTarget`](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html) . Amazon Q Business will then map your newly created document attribute to your index field.
  *
  * You can also use this with [`DocumentAttributeCondition`](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributetarget.html}
  */
 export type DocumentAttributeTarget = {
     /**
      * `TRUE` to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to `TRUE` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributetarget.html#cfn-qbusiness-datasource-documentattributetarget-attributevalueoperator}
      */
     AttributeValueOperator?: AttributeValueOperator | undefined;
     /**
@@ -194,15 +241,18 @@ export type DocumentAttributeTarget = {
      * @minLength 1
      * @maxLength 200
      * @pattern ^[a-zA-Z0-9_][a-zA-Z0-9_-]*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributetarget.html#cfn-qbusiness-datasource-documentattributetarget-key}
      */
     Key: string;
     /**
      * The value of a document attribute. You can only provide one value for a document attribute.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributetarget.html#cfn-qbusiness-datasource-documentattributetarget-value}
      */
     Value?: DocumentAttributeValue | undefined;
 };
 /**
  * The value of a document attribute. You can only provide one value for a document attribute.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributevalue.html}
  */
 export type DocumentAttributeValue = {
     /**
@@ -219,24 +269,34 @@ export type DocumentAttributeValue = {
      */
     DateValue: string;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentcontentoperator.html}
+ */
 export type DocumentContentOperator = "DELETE";
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentenrichmentconditionoperator.html}
+ */
 export type DocumentEnrichmentConditionOperator = "GREATER_THAN" | "GREATER_THAN_OR_EQUALS" | "LESS_THAN" | "LESS_THAN_OR_EQUALS" | "EQUALS" | "NOT_EQUALS" | "CONTAINS" | "NOT_CONTAINS" | "EXISTS" | "NOT_EXISTS" | "BEGINS_WITH";
 /**
  * Provides the configuration information for altering document metadata and content during the document ingestion process.
  *
  * For more information, see [Custom document enrichment](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentenrichmentconfiguration.html}
  */
 export type DocumentEnrichmentConfiguration = {
     /**
      * Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentenrichmentconfiguration.html#cfn-qbusiness-datasource-documentenrichmentconfiguration-inlineconfigurations}
      */
     InlineConfigurations?: InlineDocumentEnrichmentConfiguration[] | undefined;
     /**
      * Configuration information for invoking a Lambda function in AWS Lambda on the structured documents with their metadata and text extracted. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see [Using Lambda functions](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/cde-lambda-operations.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentenrichmentconfiguration.html#cfn-qbusiness-datasource-documentenrichmentconfiguration-postextractionhookconfiguration}
      */
     PostExtractionHookConfiguration?: HookConfiguration | undefined;
     /**
      * Configuration information for invoking a Lambda function in AWS Lambda on the original or raw documents before extracting their metadata and text. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see [Using Lambda functions](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/cde-lambda-operations.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentenrichmentconfiguration.html#cfn-qbusiness-datasource-documentenrichmentconfiguration-preextractionhookconfiguration}
      */
     PreExtractionHookConfiguration?: HookConfiguration | undefined;
 };
@@ -250,12 +310,14 @@ export type DocumentEnrichmentConfiguration = {
  * You can only invoke one Lambda function. However, this function can invoke other functions it requires.
  *
  * For more information, see [Custom document enrichment](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-hookconfiguration.html}
  */
 export type HookConfiguration = {
     /**
      * The condition used for when a Lambda function should be invoked.
      *
      * For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-hookconfiguration.html#cfn-qbusiness-datasource-hookconfiguration-invocationcondition}
      */
     InvocationCondition?: DocumentAttributeCondition | undefined;
     /**
@@ -263,6 +325,7 @@ export type HookConfiguration = {
      * @minLength 1
      * @maxLength 2048
      * @pattern ^arn:aws[a-zA-Z-]*:lambda:[a-z-]*-[0-9]:[0-9]{12}:function:[a-zA-Z0-9-_]+(/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?(:[a-zA-Z0-9-_]+)?$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-hookconfiguration.html#cfn-qbusiness-datasource-hookconfiguration-lambdaarn}
      */
     LambdaArn?: string | undefined;
     /**
@@ -270,6 +333,7 @@ export type HookConfiguration = {
      * @minLength 0
      * @maxLength 1284
      * @pattern ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-hookconfiguration.html#cfn-qbusiness-datasource-hookconfiguration-rolearn}
      */
     RoleArn?: string | undefined;
     /**
@@ -277,18 +341,24 @@ export type HookConfiguration = {
      * @minLength 1
      * @maxLength 63
      * @pattern ^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-hookconfiguration.html#cfn-qbusiness-datasource-hookconfiguration-s3bucketname}
      */
     S3BucketName?: string | undefined;
 };
 /**
  * The configuration for extracting semantic meaning from images in documents. For more information, see [Extracting semantic meaning from images and visuals](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/extracting-meaning-from-images.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-imageextractionconfiguration.html}
  */
 export type ImageExtractionConfiguration = {
     /**
      * Specify whether to extract semantic meaning from images and visuals from documents.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-imageextractionconfiguration.html#cfn-qbusiness-datasource-imageextractionconfiguration-imageextractionstatus}
      */
     ImageExtractionStatus: ImageExtractionStatus;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-imageextractionstatus.html}
+ */
 export type ImageExtractionStatus = "ENABLED" | "DISABLED";
 /**
  * Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q Business.
@@ -296,46 +366,59 @@ export type ImageExtractionStatus = "ENABLED" | "DISABLED";
  * To apply advanced logic, to go beyond what you can do with basic logic, see [`HookConfiguration`](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_HookConfiguration.html) .
  *
  * For more information, see [Custom document enrichment](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-inlinedocumentenrichmentconfiguration.html}
  */
 export type InlineDocumentEnrichmentConfiguration = {
     /**
      * Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-inlinedocumentenrichmentconfiguration.html#cfn-qbusiness-datasource-inlinedocumentenrichmentconfiguration-condition}
      */
     Condition?: DocumentAttributeCondition | undefined;
     /**
      * `TRUE` to delete content if the condition used for the target attribute is met.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-inlinedocumentenrichmentconfiguration.html#cfn-qbusiness-datasource-inlinedocumentenrichmentconfiguration-documentcontentoperator}
      */
     DocumentContentOperator?: DocumentContentOperator | undefined;
     /**
      * Configuration of the target document attribute or metadata field when ingesting documents into Amazon Q Business . You can also include a value.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-inlinedocumentenrichmentconfiguration.html#cfn-qbusiness-datasource-inlinedocumentenrichmentconfiguration-target}
      */
     Target?: DocumentAttributeTarget | undefined;
 };
 /**
  * The configuration for extracting information from media in documents.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-mediaextractionconfiguration.html}
  */
 export type MediaExtractionConfiguration = {
     /**
      * Configuration settings for extracting and processing audio content from media files.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-mediaextractionconfiguration.html#cfn-qbusiness-datasource-mediaextractionconfiguration-audioextractionconfiguration}
      */
     AudioExtractionConfiguration?: AudioExtractionConfiguration | undefined;
     /**
      * The configuration for extracting semantic meaning from images in documents. For more information, see [Extracting semantic meaning from images and visuals](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/extracting-meaning-from-images.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-mediaextractionconfiguration.html#cfn-qbusiness-datasource-mediaextractionconfiguration-imageextractionconfiguration}
      */
     ImageExtractionConfiguration?: ImageExtractionConfiguration | undefined;
     /**
      * Configuration settings for extracting and processing video content from media files.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-mediaextractionconfiguration.html#cfn-qbusiness-datasource-mediaextractionconfiguration-videoextractionconfiguration}
      */
     VideoExtractionConfiguration?: VideoExtractionConfiguration | undefined;
 };
 /**
  * Configuration settings for video content extraction and processing.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-videoextractionconfiguration.html}
  */
 export type VideoExtractionConfiguration = {
     /**
      * The status of video extraction (ENABLED or DISABLED) for processing video content from files.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-videoextractionconfiguration.html#cfn-qbusiness-datasource-videoextractionconfiguration-videoextractionstatus}
      */
     VideoExtractionStatus: VideoExtractionStatus;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-videoextractionstatus.html}
+ */
 export type VideoExtractionStatus = "ENABLED" | "DISABLED";
 //# sourceMappingURL=aws-qbusiness-datasource.d.ts.map