@propulsionworks/cloudformation 0.1.0 → 0.1.2

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

@@ -1,4 +1,12 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html}
+ */
 export type QBusinessIndex = ResourceDefinitionWithAttributes<"AWS::QBusiness::Index", QBusinessIndexProps, QBusinessIndexAttribs>;
 /**
  * Creates an Amazon Q Business index.
@@ -6,6 +14,7 @@ export type QBusinessIndex = ResourceDefinitionWithAttributes<"AWS::QBusiness::I
  * 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html}
  */
 export type QBusinessIndexProps = {
     /**
@@ -13,10 +22,12 @@ export type QBusinessIndexProps = {
      * @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-index.html#cfn-qbusiness-index-applicationid}
      */
     ApplicationId: string;
     /**
      * The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-capacityconfiguration}
      */
     CapacityConfiguration?: IndexCapacityConfiguration | undefined;
     /**
@@ -24,6 +35,7 @@ export type QBusinessIndexProps = {
      * @minLength 0
      * @maxLength 1000
      * @pattern ^[\s\S]*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-description}
      */
     Description?: string | undefined;
     /**
@@ -31,27 +43,35 @@ export type QBusinessIndexProps = {
      * @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-index.html#cfn-qbusiness-index-displayname}
      */
     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) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-documentattributeconfigurations}
      */
     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: _ . : / = + - @.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-tags}
      */
     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) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-type}
      */
     Type?: IndexType | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#aws-resource-qbusiness-index-return-values}
+ */
 export type QBusinessIndexAttribs = {
     /**
      * The Unix timestamp when the index was created.
      * @format date-time
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-createdat}
      */
     CreatedAt: string;
     /**
@@ -59,6 +79,7 @@ export type QBusinessIndexAttribs = {
      * @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-index.html#cfn-qbusiness-index-indexarn}
      */
     IndexArn: string;
     /**
@@ -66,23 +87,30 @@ export type QBusinessIndexAttribs = {
      * @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-index.html#cfn-qbusiness-index-indexid}
      */
     IndexId: string;
     /**
      * The current status of the index. When the status is `ACTIVE` , the index is ready.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-status}
      */
     Status: IndexStatus;
     /**
      * The Unix timestamp when the index was last updated.
      * @format date-time
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-updatedat}
      */
     UpdatedAt: string;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-attributetype.html}
+ */
 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) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-documentattributeconfiguration.html}
  */
 export type DocumentAttributeConfiguration = {
     /**
@@ -90,28 +118,42 @@ export type DocumentAttributeConfiguration = {
      * @minLength 1
      * @maxLength 30
      * @pattern ^[a-zA-Z0-9_][a-zA-Z0-9_-]*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-documentattributeconfiguration.html#cfn-qbusiness-index-documentattributeconfiguration-name}
      */
     Name?: string | undefined;
     /**
      * Information about whether the document attribute can be used by an end user to search for information on their web experience.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-documentattributeconfiguration.html#cfn-qbusiness-index-documentattributeconfiguration-search}
      */
     Search?: Status | undefined;
     /**
      * The type of document attribute.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-documentattributeconfiguration.html#cfn-qbusiness-index-documentattributeconfiguration-type}
      */
     Type?: AttributeType | undefined;
 };
 /**
  * Provides information about index capacity configuration.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-indexcapacityconfiguration.html}
  */
 export type IndexCapacityConfiguration = {
     /**
      * The number of storage units configured for an Amazon Q Business index.
      * @min 1
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-indexcapacityconfiguration.html#cfn-qbusiness-index-indexcapacityconfiguration-units}
      */
     Units?: number | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-indexstatus.html}
+ */
 export type IndexStatus = "CREATING" | "ACTIVE" | "DELETING" | "FAILED" | "UPDATING";
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-indextype.html}
+ */
 export type IndexType = "ENTERPRISE" | "STARTER";
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-status.html}
+ */
 export type Status = "ENABLED" | "DISABLED";
 //# sourceMappingURL=aws-qbusiness-index.d.ts.map

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

@@ -1,11 +1,17 @@
 import type { ResourceDefinition } from "../main.ts";
+/**
+ * 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-permission.html}
+ */
 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-permission.html}
  */
 export type QBusinessPermissionProps = {
     /**
      * The list of Amazon Q Business actions that the ISV is allowed to perform.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-permission.html#cfn-qbusiness-permission-actions}
      */
     Actions: string[];
     /**
@@ -13,6 +19,7 @@ export type QBusinessPermissionProps = {
      * @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-permission.html#cfn-qbusiness-permission-applicationid}
      */
     ApplicationId: string;
     /**
@@ -20,6 +27,7 @@ export type QBusinessPermissionProps = {
      * @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-permission.html#cfn-qbusiness-permission-principal}
      */
     Principal: string;
     /**
@@ -27,6 +35,7 @@ export type QBusinessPermissionProps = {
      * @minLength 1
      * @maxLength 100
      * @pattern ^[a-zA-Z0-9_-]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-permission.html#cfn-qbusiness-permission-statementid}
      */
     StatementId: string;
 };

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

@@ -1,7 +1,12 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Information about an Amazon Q Business plugin and its configuration.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html}
+ */
 export type QBusinessPlugin = ResourceDefinitionWithAttributes<"AWS::QBusiness::Plugin", QBusinessPluginProps, QBusinessPluginAttribs>;
 /**
  * Information about an Amazon Q Business plugin and its configuration.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html}
  */
 export type QBusinessPluginProps = {
     /**
@@ -9,14 +14,17 @@ export type QBusinessPluginProps = {
      * @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-plugin.html#cfn-qbusiness-plugin-applicationid}
      */
     ApplicationId?: string | undefined;
     /**
      * Authentication configuration information for an Amazon Q Business plugin.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html#cfn-qbusiness-plugin-authconfiguration}
      */
     AuthConfiguration: PluginAuthConfiguration;
     /**
      * Configuration information required to create a custom plugin.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html#cfn-qbusiness-plugin-custompluginconfiguration}
      */
     CustomPluginConfiguration?: CustomPluginConfiguration | undefined;
     /**
@@ -24,6 +32,7 @@ export type QBusinessPluginProps = {
      * @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-plugin.html#cfn-qbusiness-plugin-displayname}
      */
     DisplayName: string;
     /**
@@ -31,29 +40,38 @@ export type QBusinessPluginProps = {
      * @minLength 1
      * @maxLength 2048
      * @pattern ^(https?|ftp|file)://([^\s]*)$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html#cfn-qbusiness-plugin-serverurl}
      */
     ServerUrl?: string | undefined;
     /**
      * The current status of the plugin.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html#cfn-qbusiness-plugin-state}
      */
     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: _ . : / = + - @.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html#cfn-qbusiness-plugin-tags}
      */
     Tags?: Tag[] | undefined;
     /**
      * The type of the plugin.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html#cfn-qbusiness-plugin-type}
      */
     Type: PluginType;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html#aws-resource-qbusiness-plugin-return-values}
+ */
 export type QBusinessPluginAttribs = {
     /**
      * The current status of a plugin. A plugin is modified asynchronously.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html#cfn-qbusiness-plugin-buildstatus}
      */
     BuildStatus: PluginBuildStatus;
     /**
      * The timestamp for when the plugin was created.
      * @format date-time
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html#cfn-qbusiness-plugin-createdat}
      */
     CreatedAt: string;
     /**
@@ -61,6 +79,7 @@ export type QBusinessPluginAttribs = {
      * @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-plugin.html#cfn-qbusiness-plugin-pluginarn}
      */
     PluginArn: string;
     /**
@@ -68,25 +87,32 @@ export type QBusinessPluginAttribs = {
      * @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}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html#cfn-qbusiness-plugin-pluginid}
      */
     PluginId: string;
     /**
      * The timestamp for when the plugin was last updated.
      * @format date-time
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html#cfn-qbusiness-plugin-updatedat}
      */
     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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-apischema.html}
  */
 export type APISchema = {
     Payload: string;
 } | {
     S3: S3;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-apischematype.html}
+ */
 export type APISchemaType = "OPEN_API_V3";
 /**
  * Information about the basic authentication credentials used to configure a plugin.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-basicauthconfiguration.html}
  */
 export type BasicAuthConfiguration = {
     /**
@@ -94,6 +120,7 @@ export type BasicAuthConfiguration = {
      * @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-plugin-basicauthconfiguration.html#cfn-qbusiness-plugin-basicauthconfiguration-rolearn}
      */
     RoleArn: string;
     /**
@@ -101,30 +128,36 @@ export type BasicAuthConfiguration = {
      * @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-plugin-basicauthconfiguration.html#cfn-qbusiness-plugin-basicauthconfiguration-secretarn}
      */
     SecretArn: string;
 };
 /**
  * Configuration information required to create a custom plugin.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-custompluginconfiguration.html}
  */
 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-custompluginconfiguration.html#cfn-qbusiness-plugin-custompluginconfiguration-apischema}
      */
     ApiSchema: APISchema;
     /**
      * The type of OpenAPI schema to use.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-custompluginconfiguration.html#cfn-qbusiness-plugin-custompluginconfiguration-apischematype}
      */
     ApiSchemaType: APISchemaType;
     /**
      * A description for your custom plugin configuration.
      * @minLength 1
      * @maxLength 200
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-custompluginconfiguration.html#cfn-qbusiness-plugin-custompluginconfiguration-description}
      */
     Description: string;
 };
 /**
  * Information about the OAuth 2.0 authentication credential/token used to configure a plugin.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-oauth2clientcredentialconfiguration.html}
  */
 export type OAuth2ClientCredentialConfiguration = {
     /**
@@ -132,6 +165,7 @@ export type OAuth2ClientCredentialConfiguration = {
      * @minLength 1
      * @maxLength 2048
      * @pattern ^(https?|ftp|file)://([^\s]*)$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-oauth2clientcredentialconfiguration.html#cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-authorizationurl}
      */
     AuthorizationUrl?: string | undefined;
     /**
@@ -139,6 +173,7 @@ export type OAuth2ClientCredentialConfiguration = {
      * @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-plugin-oauth2clientcredentialconfiguration.html#cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-rolearn}
      */
     RoleArn: string;
     /**
@@ -146,6 +181,7 @@ export type OAuth2ClientCredentialConfiguration = {
      * @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-plugin-oauth2clientcredentialconfiguration.html#cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-secretarn}
      */
     SecretArn: string;
     /**
@@ -153,11 +189,13 @@ export type OAuth2ClientCredentialConfiguration = {
      * @minLength 1
      * @maxLength 2048
      * @pattern ^(https?|ftp|file)://([^\s]*)$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-oauth2clientcredentialconfiguration.html#cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-tokenurl}
      */
     TokenUrl?: string | undefined;
 };
 /**
  * Authentication configuration information for an Amazon Q Business plugin.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-pluginauthconfiguration.html}
  */
 export type PluginAuthConfiguration = {
     BasicAuthConfiguration: BasicAuthConfiguration;
@@ -166,11 +204,21 @@ export type PluginAuthConfiguration = {
 } | {
     NoAuthConfiguration: Record<string, unknown>;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-pluginbuildstatus.html}
+ */
 export type PluginBuildStatus = "READY" | "CREATE_IN_PROGRESS" | "CREATE_FAILED" | "UPDATE_IN_PROGRESS" | "UPDATE_FAILED" | "DELETE_IN_PROGRESS" | "DELETE_FAILED";
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-pluginstate.html}
+ */
 export type PluginState = "ENABLED" | "DISABLED";
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-plugintype.html}
+ */
 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-s3.html}
  */
 export type S3 = {
     /**
@@ -178,12 +226,14 @@ export type S3 = {
      * @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-plugin-s3.html#cfn-qbusiness-plugin-s3-bucket}
      */
     Bucket: string;
     /**
      * The name of the file.
      * @minLength 1
      * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-s3.html#cfn-qbusiness-plugin-s3-key}
      */
     Key: string;
 };

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

@@ -1,7 +1,12 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Adds a retriever to your Amazon Q Business application.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html}
+ */
 export type QBusinessRetriever = ResourceDefinitionWithAttributes<"AWS::QBusiness::Retriever", QBusinessRetrieverProps, QBusinessRetrieverAttribs>;
 /**
  * Adds a retriever to your Amazon Q Business application.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html}
  */
 export type QBusinessRetrieverProps = {
     /**
@@ -9,10 +14,12 @@ export type QBusinessRetrieverProps = {
      * @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-retriever.html#cfn-qbusiness-retriever-applicationid}
      */
     ApplicationId: string;
     /**
      * Provides information on how the retriever used for your Amazon Q Business application is configured.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html#cfn-qbusiness-retriever-configuration}
      */
     Configuration: RetrieverConfiguration;
     /**
@@ -20,6 +27,7 @@ export type QBusinessRetrieverProps = {
      * @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-retriever.html#cfn-qbusiness-retriever-displayname}
      */
     DisplayName: string;
     /**
@@ -27,21 +35,28 @@ export type QBusinessRetrieverProps = {
      * @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-retriever.html#cfn-qbusiness-retriever-rolearn}
      */
     RoleArn?: string | undefined;
     /**
      * A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. 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-retriever.html#cfn-qbusiness-retriever-tags}
      */
     Tags?: Tag[] | undefined;
     /**
      * The type of your retriever.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html#cfn-qbusiness-retriever-type}
      */
     Type: RetrieverType;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html#aws-resource-qbusiness-retriever-return-values}
+ */
 export type QBusinessRetrieverAttribs = {
     /**
      * The Unix timestamp when the retriever was created.
      * @format date-time
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html#cfn-qbusiness-retriever-createdat}
      */
     CreatedAt: string;
     /**
@@ -49,6 +64,7 @@ export type QBusinessRetrieverAttribs = {
      * @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-retriever.html#cfn-qbusiness-retriever-retrieverarn}
      */
     RetrieverArn: string;
     /**
@@ -56,20 +72,24 @@ export type QBusinessRetrieverAttribs = {
      * @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-retriever.html#cfn-qbusiness-retriever-retrieverid}
      */
     RetrieverId: string;
     /**
      * The status of your retriever.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html#cfn-qbusiness-retriever-status}
      */
     Status: RetrieverStatus;
     /**
      * The Unix timestamp when the retriever was last updated.
      * @format date-time
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html#cfn-qbusiness-retriever-updatedat}
      */
     UpdatedAt: string;
 };
 /**
  * Stores an Amazon Kendra index as a retriever.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-retriever-kendraindexconfiguration.html}
  */
 export type KendraIndexConfiguration = {
     /**
@@ -77,11 +97,13 @@ export type KendraIndexConfiguration = {
      * @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-properties-qbusiness-retriever-kendraindexconfiguration.html#cfn-qbusiness-retriever-kendraindexconfiguration-indexid}
      */
     IndexId: string;
 };
 /**
  * Configuration information for an Amazon Q Business index.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-retriever-nativeindexconfiguration.html}
  */
 export type NativeIndexConfiguration = {
     /**
@@ -89,17 +111,25 @@ export type NativeIndexConfiguration = {
      * @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-properties-qbusiness-retriever-nativeindexconfiguration.html#cfn-qbusiness-retriever-nativeindexconfiguration-indexid}
      */
     IndexId: string;
 };
 /**
  * Provides information on how the retriever used for your Amazon Q Business application is configured.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-retriever-retrieverconfiguration.html}
  */
 export type RetrieverConfiguration = {
     NativeIndexConfiguration: NativeIndexConfiguration;
 } | {
     KendraIndexConfiguration: KendraIndexConfiguration;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-retriever-retrieverstatus.html}
+ */
 export type RetrieverStatus = "CREATING" | "ACTIVE" | "FAILED";
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-retriever-retrievertype.html}
+ */
 export type RetrieverType = "NATIVE_INDEX" | "KENDRA_INDEX";
 //# sourceMappingURL=aws-qbusiness-retriever.d.ts.map