@propulsionworks/cloudformation 0.0.1 → 0.1.0

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

@@ -0,0 +1,341 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+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.
+ */
+export type QBusinessDataSourceProps = {
+    /**
+     * The identifier of the Amazon Q Business application the data source will be attached to.
+     * @minLength 36
+     * @maxLength 36
+     * @pattern ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$
+     */
+    ApplicationId: string;
+    /**
+     * Use 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:
+     *
+     * - [Amazon Simple Storage Service](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/s3-cfn.html)
+     * - [Amazon Q Web Crawler](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/web-crawler-cfn.html)
+     *
+     * Similarly, you can find configuration templates and properties for your specific data source using the following steps:
+     *
+     * - 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.
+     */
+    Configuration: unknown;
+    /**
+     * A description for the data source connector.
+     * @minLength 0
+     * @maxLength 1000
+     * @pattern ^[\s\S]*$
+     */
+    Description?: string | undefined;
+    /**
+     * The name of the Amazon Q Business data source.
+     * @minLength 1
+     * @maxLength 1000
+     * @pattern ^[a-zA-Z0-9][a-zA-Z0-9_-]*$
+     */
+    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) .
+     */
+    DocumentEnrichmentConfiguration?: DocumentEnrichmentConfiguration | undefined;
+    /**
+     * The identifier of the index the data source is attached to.
+     * @minLength 36
+     * @maxLength 36
+     * @pattern ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$
+     */
+    IndexId: string;
+    /**
+     * The configuration for extracting information from media in documents.
+     */
+    MediaExtractionConfiguration?: MediaExtractionConfiguration | undefined;
+    /**
+     * The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
+     * @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}$
+     */
+    RoleArn?: string | undefined;
+    /**
+     * Sets 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 the `Schedule` parameter when the `Type` parameter is set to `CUSTOM` . If you do, you receive a `ValidationException` exception.
+     * @maxLength 998
+     * @pattern ^[\s\S]*$
+     */
+    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: _ . : / = + - @.
+     */
+    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) .
+     */
+    VpcConfiguration?: DataSourceVpcConfiguration | undefined;
+};
+export type QBusinessDataSourceAttribs = {
+    /**
+     * The Unix timestamp when the Amazon Q Business data source was created.
+     * @format date-time
+     */
+    CreatedAt: string;
+    /**
+     * The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.
+     * @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}$
+     */
+    DataSourceArn: string;
+    /**
+     * The identifier of the Amazon Q Business data source.
+     * @minLength 36
+     * @maxLength 36
+     * @pattern ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$
+     */
+    DataSourceId: string;
+    /**
+     * The status of the Amazon Q Business data source.
+     */
+    Status: DataSourceStatus;
+    /**
+     * The type of the Amazon Q Business data source.
+     * @minLength 1
+     * @maxLength 2048
+     */
+    Type: string;
+    /**
+     * The Unix timestamp when the Amazon Q Business data source was last updated.
+     * @format date-time
+     */
+    UpdatedAt: string;
+};
+export type AttributeValueOperator = "DELETE";
+/**
+ * Configuration settings for audio content extraction and processing.
+ */
+export type AudioExtractionConfiguration = {
+    /**
+     * The status of audio extraction (ENABLED or DISABLED) for processing audio content from files.
+     */
+    AudioExtractionStatus: AudioExtractionStatus;
+};
+export type AudioExtractionStatus = "ENABLED" | "DISABLED";
+export type DataSourceStatus = "PENDING_CREATION" | "CREATING" | "ACTIVE" | "DELETING" | "FAILED" | "UPDATING";
+/**
+ * Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).
+ */
+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.
+     */
+    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.
+     */
+    SubnetIds: string[];
+};
+/**
+ * The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with [`DocumentAttributeTarget`](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html) to apply the condition.
+ *
+ * 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.
+ */
+export type DocumentAttributeCondition = {
+    /**
+     * The identifier of the document attribute used for the condition.
+     *
+     * 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 doesn't support `_document_body` as an attribute key used for the condition.
+     * @minLength 1
+     * @maxLength 200
+     * @pattern ^[a-zA-Z0-9_][a-zA-Z0-9_-]*$
+     */
+    Key: string;
+    /**
+     * The identifier of the document attribute used for the condition.
+     *
+     * 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.
+     */
+    Operator: DocumentEnrichmentConditionOperator;
+    /**
+     * The value of a document attribute. You can only provide one value for a document attribute.
+     */
+    Value?: DocumentAttributeValue | undefined;
+};
+/**
+ * The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.
+ *
+ * For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to `TRUE` . This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.
+ *
+ * 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) .
+ */
+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` .
+     */
+    AttributeValueOperator?: AttributeValueOperator | undefined;
+    /**
+     * The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.
+     * @minLength 1
+     * @maxLength 200
+     * @pattern ^[a-zA-Z0-9_][a-zA-Z0-9_-]*$
+     */
+    Key: string;
+    /**
+     * The value of a document attribute. You can only provide one value for a document attribute.
+     */
+    Value?: DocumentAttributeValue | undefined;
+};
+/**
+ * The value of a document attribute. You can only provide one value for a document attribute.
+ */
+export type DocumentAttributeValue = {
+    /**
+     * @maxLength 2048
+     */
+    StringValue: string;
+} | {
+    StringListValue: string[];
+} | {
+    LongValue: number;
+} | {
+    /**
+     * @format date-time
+     */
+    DateValue: string;
+};
+export type DocumentContentOperator = "DELETE";
+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) .
+ */
+export type DocumentEnrichmentConfiguration = {
+    /**
+     * Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.
+     */
+    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) .
+     */
+    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) .
+     */
+    PreExtractionHookConfiguration?: HookConfiguration | undefined;
+};
+/**
+ * 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.
+ *
+ * You can configure your Lambda function using the `PreExtractionHookConfiguration` parameter if you want to apply advanced alterations on the original or raw documents.
+ *
+ * If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using `PostExtractionHookConfiguration` .
+ *
+ * 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) .
+ */
+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.
+     */
+    InvocationCondition?: DocumentAttributeCondition | undefined;
+    /**
+     * The Amazon Resource Name (ARN) of the Lambda function sduring ingestion. For more information, see [Using Lambda functions for Amazon Q Business document enrichment](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/cde-lambda-operations.html) .
+     * @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-_]+)?$
+     */
+    LambdaArn?: string | undefined;
+    /**
+     * The Amazon Resource Name (ARN) of a role with permission to run `PreExtractionHookConfiguration` and `PostExtractionHookConfiguration` for altering document metadata and content during the document ingestion process.
+     * @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}$
+     */
+    RoleArn?: string | undefined;
+    /**
+     * Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see [Data contracts for Lambda functions](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/cde-lambda-operations.html#cde-lambda-operations-data-contracts) .
+     * @minLength 1
+     * @maxLength 63
+     * @pattern ^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$
+     */
+    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) .
+ */
+export type ImageExtractionConfiguration = {
+    /**
+     * Specify whether to extract semantic meaning from images and visuals from documents.
+     */
+    ImageExtractionStatus: ImageExtractionStatus;
+};
+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.
+ *
+ * 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) .
+ */
+export type InlineDocumentEnrichmentConfiguration = {
+    /**
+     * Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business .
+     */
+    Condition?: DocumentAttributeCondition | undefined;
+    /**
+     * `TRUE` to delete content if the condition used for the target attribute is met.
+     */
+    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.
+     */
+    Target?: DocumentAttributeTarget | undefined;
+};
+/**
+ * The configuration for extracting information from media in documents.
+ */
+export type MediaExtractionConfiguration = {
+    /**
+     * Configuration settings for extracting and processing audio content from media files.
+     */
+    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) .
+     */
+    ImageExtractionConfiguration?: ImageExtractionConfiguration | undefined;
+    /**
+     * Configuration settings for extracting and processing video content from media files.
+     */
+    VideoExtractionConfiguration?: VideoExtractionConfiguration | undefined;
+};
+/**
+ * Configuration settings for video content extraction and processing.
+ */
+export type VideoExtractionConfiguration = {
+    /**
+     * The status of video extraction (ENABLED or DISABLED) for processing video content from files.
+     */
+    VideoExtractionStatus: VideoExtractionStatus;
+};
+export type VideoExtractionStatus = "ENABLED" | "DISABLED";
+//# sourceMappingURL=aws-qbusiness-datasource.d.ts.map

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

@@ -0,0 +1,117 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type QBusinessIndex = ResourceDefinitionWithAttributes<"AWS::QBusiness::Index", QBusinessIndexProps, QBusinessIndexAttribs>;
+/**
+ * Creates an Amazon Q Business index.
+ *
+ * To determine if index creation has completed, check the `Status` field returned from a call to `DescribeIndex` . The `Status` field is set to `ACTIVE` when the index is ready to use.
+ *
+ * Once the index is active, you can index your documents using the [`BatchPutDocument`](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_BatchPutDocument.html) API or the [`CreateDataSource`](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateDataSource.html) API.
+ */
+export type QBusinessIndexProps = {
+    /**
+     * The identifier of the Amazon Q Business application using the index.
+     * @minLength 36
+     * @maxLength 36
+     * @pattern ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$
+     */
+    ApplicationId: string;
+    /**
+     * The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.
+     */
+    CapacityConfiguration?: IndexCapacityConfiguration | undefined;
+    /**
+     * A description for the Amazon Q Business index.
+     * @minLength 0
+     * @maxLength 1000
+     * @pattern ^[\s\S]*$
+     */
+    Description?: string | undefined;
+    /**
+     * The name of the index.
+     * @minLength 1
+     * @maxLength 1000
+     * @pattern ^[a-zA-Z0-9][a-zA-Z0-9_-]*$
+     */
+    DisplayName: string;
+    /**
+     * Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.
+     *
+     * For more information, see [Understanding document attributes](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes.html) .
+     */
+    DocumentAttributeConfigurations?: DocumentAttributeConfiguration[] | undefined;
+    /**
+     * A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
+     */
+    Tags?: Tag[] | undefined;
+    /**
+     * The index type that's suitable for your needs. For more information on what's included in each type of index, see [Amazon Q Business tiers](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#index-tiers) .
+     */
+    Type?: IndexType | undefined;
+};
+export type QBusinessIndexAttribs = {
+    /**
+     * The Unix timestamp when the index was created.
+     * @format date-time
+     */
+    CreatedAt: string;
+    /**
+     * The Amazon Resource Name (ARN) of an Amazon Q Business index.
+     * @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}$
+     */
+    IndexArn: string;
+    /**
+     * The identifier for the index.
+     * @minLength 36
+     * @maxLength 36
+     * @pattern ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$
+     */
+    IndexId: string;
+    /**
+     * The current status of the index. When the status is `ACTIVE` , the index is ready.
+     */
+    Status: IndexStatus;
+    /**
+     * The Unix timestamp when the index was last updated.
+     * @format date-time
+     */
+    UpdatedAt: string;
+};
+export type AttributeType = "STRING" | "STRING_LIST" | "NUMBER" | "DATE";
+/**
+ * Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.
+ *
+ * For more information, see [Understanding document attributes](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes.html) .
+ */
+export type DocumentAttributeConfiguration = {
+    /**
+     * The name of the document attribute.
+     * @minLength 1
+     * @maxLength 30
+     * @pattern ^[a-zA-Z0-9_][a-zA-Z0-9_-]*$
+     */
+    Name?: string | undefined;
+    /**
+     * Information about whether the document attribute can be used by an end user to search for information on their web experience.
+     */
+    Search?: Status | undefined;
+    /**
+     * The type of document attribute.
+     */
+    Type?: AttributeType | undefined;
+};
+/**
+ * Provides information about index capacity configuration.
+ */
+export type IndexCapacityConfiguration = {
+    /**
+     * The number of storage units configured for an Amazon Q Business index.
+     * @min 1
+     */
+    Units?: number | undefined;
+};
+export type IndexStatus = "CREATING" | "ACTIVE" | "DELETING" | "FAILED" | "UPDATING";
+export type IndexType = "ENTERPRISE" | "STARTER";
+export type Status = "ENABLED" | "DISABLED";
+//# sourceMappingURL=aws-qbusiness-index.d.ts.map

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

@@ -0,0 +1,33 @@
+import type { ResourceDefinition } from "../main.ts";
+export type QBusinessPermission = ResourceDefinition<"AWS::QBusiness::Permission", QBusinessPermissionProps>;
+/**
+ * Adds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV. This operation creates a new policy statement for the specified Amazon Q Business application. The policy statement defines the IAM actions that the ISV is allowed to perform on the Amazon Q Business application's resources.
+ */
+export type QBusinessPermissionProps = {
+    /**
+     * The list of Amazon Q Business actions that the ISV is allowed to perform.
+     */
+    Actions: string[];
+    /**
+     * The unique identifier of the Amazon Q Business application.
+     * @minLength 36
+     * @maxLength 36
+     * @pattern ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$
+     */
+    ApplicationId: string;
+    /**
+     * Provides user and group information used for filtering documents to use for generating Amazon Q Business conversation responses.
+     * @minLength 1
+     * @maxLength 1284
+     * @pattern ^arn:aws:iam::[0-9]{12}:role/[a-zA-Z0-9_/+=,.@-]+$
+     */
+    Principal: string;
+    /**
+     * A unique identifier for the policy statement.
+     * @minLength 1
+     * @maxLength 100
+     * @pattern ^[a-zA-Z0-9_-]+$
+     */
+    StatementId: string;
+};
+//# sourceMappingURL=aws-qbusiness-permission.d.ts.map

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

@@ -0,0 +1,190 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type QBusinessPlugin = ResourceDefinitionWithAttributes<"AWS::QBusiness::Plugin", QBusinessPluginProps, QBusinessPluginAttribs>;
+/**
+ * Information about an Amazon Q Business plugin and its configuration.
+ */
+export type QBusinessPluginProps = {
+    /**
+     * The identifier of the application that will contain the plugin.
+     * @minLength 36
+     * @maxLength 36
+     * @pattern ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$
+     */
+    ApplicationId?: string | undefined;
+    /**
+     * Authentication configuration information for an Amazon Q Business plugin.
+     */
+    AuthConfiguration: PluginAuthConfiguration;
+    /**
+     * Configuration information required to create a custom plugin.
+     */
+    CustomPluginConfiguration?: CustomPluginConfiguration | undefined;
+    /**
+     * The name of the plugin.
+     * @minLength 1
+     * @maxLength 100
+     * @pattern ^[a-zA-Z0-9][a-zA-Z0-9_-]*$
+     */
+    DisplayName: string;
+    /**
+     * The plugin server URL used for configuration.
+     * @minLength 1
+     * @maxLength 2048
+     * @pattern ^(https?|ftp|file)://([^\s]*)$
+     */
+    ServerUrl?: string | undefined;
+    /**
+     * The current status of the plugin.
+     */
+    State?: PluginState | 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: _ . : / = + - @.
+     */
+    Tags?: Tag[] | undefined;
+    /**
+     * The type of the plugin.
+     */
+    Type: PluginType;
+};
+export type QBusinessPluginAttribs = {
+    /**
+     * The current status of a plugin. A plugin is modified asynchronously.
+     */
+    BuildStatus: PluginBuildStatus;
+    /**
+     * The timestamp for when the plugin was created.
+     * @format date-time
+     */
+    CreatedAt: string;
+    /**
+     * The Amazon Resource Name (ARN) of a plugin.
+     * @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}$
+     */
+    PluginArn: string;
+    /**
+     * The identifier of the plugin.
+     * @minLength 36
+     * @maxLength 36
+     * @pattern ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
+     */
+    PluginId: string;
+    /**
+     * The timestamp for when the plugin was last updated.
+     * @format date-time
+     */
+    UpdatedAt: string;
+};
+/**
+ * Contains details about the OpenAPI schema for a custom plugin. For more information, see [custom plugin OpenAPI schemas](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/custom-plugin.html#plugins-api-schema) . You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the `s3` field.
+ */
+export type APISchema = {
+    Payload: string;
+} | {
+    S3: S3;
+};
+export type APISchemaType = "OPEN_API_V3";
+/**
+ * Information about the basic authentication credentials used to configure a plugin.
+ */
+export type BasicAuthConfiguration = {
+    /**
+     * The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
+     * @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}$
+     */
+    RoleArn: string;
+    /**
+     * The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..
+     * @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}$
+     */
+    SecretArn: string;
+};
+/**
+ * Configuration information required to create a custom plugin.
+ */
+export type CustomPluginConfiguration = {
+    /**
+     * Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.
+     */
+    ApiSchema: APISchema;
+    /**
+     * The type of OpenAPI schema to use.
+     */
+    ApiSchemaType: APISchemaType;
+    /**
+     * A description for your custom plugin configuration.
+     * @minLength 1
+     * @maxLength 200
+     */
+    Description: string;
+};
+/**
+ * Information about the OAuth 2.0 authentication credential/token used to configure a plugin.
+ */
+export type OAuth2ClientCredentialConfiguration = {
+    /**
+     * The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to authenticate a plugin user through a third party authentication server.
+     * @minLength 1
+     * @maxLength 2048
+     * @pattern ^(https?|ftp|file)://([^\s]*)$
+     */
+    AuthorizationUrl?: string | undefined;
+    /**
+     * The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.
+     * @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}$
+     */
+    RoleArn: string;
+    /**
+     * The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.
+     * @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}$
+     */
+    SecretArn: string;
+    /**
+     * The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token.
+     * @minLength 1
+     * @maxLength 2048
+     * @pattern ^(https?|ftp|file)://([^\s]*)$
+     */
+    TokenUrl?: string | undefined;
+};
+/**
+ * Authentication configuration information for an Amazon Q Business plugin.
+ */
+export type PluginAuthConfiguration = {
+    BasicAuthConfiguration: BasicAuthConfiguration;
+} | {
+    OAuth2ClientCredentialConfiguration: OAuth2ClientCredentialConfiguration;
+} | {
+    NoAuthConfiguration: Record<string, unknown>;
+};
+export type PluginBuildStatus = "READY" | "CREATE_IN_PROGRESS" | "CREATE_FAILED" | "UPDATE_IN_PROGRESS" | "UPDATE_FAILED" | "DELETE_IN_PROGRESS" | "DELETE_FAILED";
+export type PluginState = "ENABLED" | "DISABLED";
+export type PluginType = "SERVICE_NOW" | "SALESFORCE" | "JIRA" | "ZENDESK" | "CUSTOM" | "QUICKSIGHT" | "SERVICENOW_NOW_PLATFORM" | "JIRA_CLOUD" | "SALESFORCE_CRM" | "ZENDESK_SUITE" | "ATLASSIAN_CONFLUENCE" | "GOOGLE_CALENDAR" | "MICROSOFT_TEAMS" | "MICROSOFT_EXCHANGE" | "PAGERDUTY_ADVANCE" | "SMARTSHEET" | "ASANA";
+/**
+ * Information required for Amazon Q Business to find a specific file in an Amazon S3 bucket.
+ */
+export type S3 = {
+    /**
+     * The name of the S3 bucket that contains the file.
+     * @minLength 1
+     * @maxLength 63
+     * @pattern ^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$
+     */
+    Bucket: string;
+    /**
+     * The name of the file.
+     * @minLength 1
+     * @maxLength 1024
+     */
+    Key: string;
+};
+//# sourceMappingURL=aws-qbusiness-plugin.d.ts.map