@propulsionworks/cloudformation 0.1.0 → 0.1.2

package/out/exports/resources.generated/aws-cognito-userpoolriskconfigurationattachment.d.ts

@@ -1,34 +1,47 @@
 import type { ResourceDefinition } from "../main.ts";
+/**
+ * The `AWS::Cognito::UserPoolRiskConfigurationAttachment` resource sets the risk configuration that is used for Amazon Cognito advanced security features.
+ *
+ * You can specify risk configuration for a single client (with a specific `clientId` ) or for all clients (by setting the `clientId` to `ALL` ). If you specify `ALL` , the default configuration is used for every client that has had no risk configuration set previously. If you specify risk configuration for a particular client, it no longer falls back to the `ALL` configuration.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html}
+ */
 export type CognitoUserPoolRiskConfigurationAttachment = ResourceDefinition<"AWS::Cognito::UserPoolRiskConfigurationAttachment", CognitoUserPoolRiskConfigurationAttachmentProps>;
 /**
  * The `AWS::Cognito::UserPoolRiskConfigurationAttachment` resource sets the risk configuration that is used for Amazon Cognito advanced security features.
  *
  * You can specify risk configuration for a single client (with a specific `clientId` ) or for all clients (by setting the `clientId` to `ALL` ). If you specify `ALL` , the default configuration is used for every client that has had no risk configuration set previously. If you specify risk configuration for a particular client, it no longer falls back to the `ALL` configuration.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html}
  */
 export type CognitoUserPoolRiskConfigurationAttachmentProps = {
     /**
      * The settings for automated responses and notification templates for adaptive authentication with threat protection.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfiguration}
      */
     AccountTakeoverRiskConfiguration?: AccountTakeoverRiskConfigurationType | undefined;
     /**
      * The app client where this configuration is applied. When this parameter isn't present, the risk configuration applies to all user pool app clients that don't have client-level settings.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-clientid}
      */
     ClientId: string;
     /**
      * Settings for compromised-credentials actions and authentication types with threat protection in full-function `ENFORCED` mode.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfiguration}
      */
     CompromisedCredentialsRiskConfiguration?: CompromisedCredentialsRiskConfigurationType | undefined;
     /**
      * Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-riskexceptionconfiguration}
      */
     RiskExceptionConfiguration?: RiskExceptionConfigurationType | undefined;
     /**
      * The ID of the user pool that has the risk configuration applied.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolriskconfigurationattachment.html#cfn-cognito-userpoolriskconfigurationattachment-userpoolid}
      */
     UserPoolId: string;
 };
 /**
  * The automated response to a risk level for adaptive authentication in full-function, or `ENFORCED` , mode. You can assign an action to each risk level that advanced security features evaluates.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype.html}
  */
 export type AccountTakeoverActionType = {
     /**
@@ -38,121 +51,149 @@ export type AccountTakeoverActionType = {
      * - `MFA_IF_CONFIGURED` : Present an MFA challenge if possible. MFA is possible if the user pool has active MFA methods that the user can set up. For example, if the user pool only supports SMS message MFA but the user doesn't have a phone number attribute, MFA setup isn't possible. If MFA setup isn't possible, allow the request.
      * - `MFA_REQUIRED` : Present an MFA challenge if possible. Block the request if a user hasn't set up MFA. To sign in with required MFA, users must have an email address or phone number attribute, or a registered TOTP factor.
      * - `NO_ACTION` : Take no action. Permit sign-in.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype-eventaction}
      */
     EventAction: string;
     /**
      * Determines whether Amazon Cognito sends a user a notification message when your user pools assesses a user's session at the associated risk level.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype-notify}
      */
     Notify: boolean;
 };
 /**
  * A list of account-takeover actions for each level of risk that Amazon Cognito might assess with advanced security features.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype.html}
  */
 export type AccountTakeoverActionsType = {
     /**
      * The action that you assign to a high-risk assessment by threat protection.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype-highaction}
      */
     HighAction?: AccountTakeoverActionType | undefined;
     /**
      * The action that you assign to a low-risk assessment by threat protection.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype-lowaction}
      */
     LowAction?: AccountTakeoverActionType | undefined;
     /**
      * The action that you assign to a medium-risk assessment by threat protection.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractionstype-mediumaction}
      */
     MediumAction?: AccountTakeoverActionType | undefined;
 };
 /**
  * The settings for automated responses and notification templates for adaptive authentication with advanced security features.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype.html}
  */
 export type AccountTakeoverRiskConfigurationType = {
     /**
      * A list of account-takeover actions for each level of risk that Amazon Cognito might assess with threat protection.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype-actions}
      */
     Actions: AccountTakeoverActionsType;
     /**
      * The settings for composing and sending an email message when threat protection assesses a risk level with adaptive authentication. When you choose to notify users in `AccountTakeoverRiskConfiguration` , Amazon Cognito sends an email message using the method and template that you set with this data type.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoverriskconfigurationtype-notifyconfiguration}
      */
     NotifyConfiguration?: NotifyConfigurationType | undefined;
 };
 /**
  * Settings for user pool actions when Amazon Cognito detects compromised credentials with advanced security features in full-function `ENFORCED` mode.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsactionstype.html}
  */
 export type CompromisedCredentialsActionsType = {
     /**
      * The action that Amazon Cognito takes when it detects compromised credentials.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsactionstype.html#cfn-cognito-userpoolriskconfigurationattachment-compromisedcredentialsactionstype-eventaction}
      */
     EventAction: string;
 };
 /**
  * Settings for compromised-credentials actions and authentication-event sources with advanced security features in full-function `ENFORCED` mode.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfigurationtype.html}
  */
 export type CompromisedCredentialsRiskConfigurationType = {
     /**
      * Settings for the actions that you want your user pool to take when Amazon Cognito detects compromised credentials.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfigurationtype-actions}
      */
     Actions: CompromisedCredentialsActionsType;
     /**
      * Settings for the sign-in activity where you want to configure compromised-credentials actions. Defaults to all events.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-compromisedcredentialsriskconfigurationtype-eventfilter}
      */
     EventFilter?: string[] | undefined;
 };
 /**
  * The configuration for Amazon SES email messages that advanced security features sends to a user when your adaptive authentication automated response has a *Notify* action.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html}
  */
 export type NotifyConfigurationType = {
     /**
      * The template for the email message that your user pool sends when a detected risk event is blocked.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-blockemail}
      */
     BlockEmail?: NotifyEmailType | undefined;
     /**
      * The email address that sends the email message. The address must be either individually verified with Amazon Simple Email Service, or from a domain that has been verified with Amazon SES.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-from}
      */
     From?: string | undefined;
     /**
      * The template for the email message that your user pool sends when MFA is challenged in response to a detected risk.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-mfaemail}
      */
     MfaEmail?: NotifyEmailType | undefined;
     /**
      * The template for the email message that your user pool sends when no action is taken in response to a detected risk.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-noactionemail}
      */
     NoActionEmail?: NotifyEmailType | undefined;
     /**
      * The reply-to email address of an email template.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-replyto}
      */
     ReplyTo?: string | undefined;
     /**
      * The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy. This identity permits Amazon Cognito to send for the email address specified in the `From` parameter.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-sourcearn}
      */
     SourceArn: string;
 };
 /**
  * The template for email messages that advanced security features sends to a user when your threat protection automated response has a *Notify* action.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyemailtype.html}
  */
 export type NotifyEmailType = {
     /**
      * The body of an email notification formatted in HTML. Choose an `HtmlBody` or a `TextBody` to send an HTML-formatted or plaintext message, respectively.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyemailtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyemailtype-htmlbody}
      */
     HtmlBody?: string | undefined;
     /**
      * The subject of the threat protection email notification.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyemailtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyemailtype-subject}
      */
     Subject: string;
     /**
      * The body of an email notification formatted in plaintext. Choose an `HtmlBody` or a `TextBody` to send an HTML-formatted or plaintext message, respectively.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyemailtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyemailtype-textbody}
      */
     TextBody?: string | undefined;
 };
 /**
  * Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-riskexceptionconfigurationtype.html}
  */
 export type RiskExceptionConfigurationType = {
     /**
      * An always-block IP address list. Overrides the risk decision and always blocks authentication requests. This parameter is displayed and set in CIDR notation.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-riskexceptionconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-riskexceptionconfigurationtype-blockediprangelist}
      */
     BlockedIPRangeList?: string[] | undefined;
     /**
      * An always-allow IP address list. Risk detection isn't performed on the IP addresses in this range list. This parameter is displayed and set in CIDR notation.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-riskexceptionconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-riskexceptionconfigurationtype-skippediprangelist}
      */
     SkippedIPRangeList?: string[] | undefined;
 };

package/out/exports/resources.generated/aws-cognito-userpooluicustomizationattachment.d.ts

@@ -1,19 +1,27 @@
 import type { ResourceDefinition } from "../main.ts";
+/**
+ * A container for the UI customization information for the hosted UI in a user pool.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluicustomizationattachment.html}
+ */
 export type CognitoUserPoolUICustomizationAttachment = ResourceDefinition<"AWS::Cognito::UserPoolUICustomizationAttachment", CognitoUserPoolUICustomizationAttachmentProps>;
 /**
  * A container for the UI customization information for the hosted UI in a user pool.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluicustomizationattachment.html}
  */
 export type CognitoUserPoolUICustomizationAttachmentProps = {
     /**
      * A plaintext CSS file that contains the custom fields that you want to apply to your user pool or app client. To download a template, go to the Amazon Cognito console. Navigate to your user pool *App clients* tab, select *Login pages* , edit *Hosted UI (classic) style* , and select the link to `CSS template.css` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluicustomizationattachment.html#cfn-cognito-userpooluicustomizationattachment-css}
      */
     CSS?: string | undefined;
     /**
      * The app client ID for your UI customization. When this value isn't present, the customization applies to all user pool app clients that don't have client-level settings..
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluicustomizationattachment.html#cfn-cognito-userpooluicustomizationattachment-clientid}
      */
     ClientId: string;
     /**
      * The ID of the user pool where you want to apply branding to the classic hosted UI.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluicustomizationattachment.html#cfn-cognito-userpooluicustomizationattachment-userpoolid}
      */
     UserPoolId: string;
 };

package/out/exports/resources.generated/aws-cognito-userpooluser.d.ts

@@ -1,7 +1,12 @@
 import type { ResourceDefinition } from "../main.ts";
+/**
+ * The `AWS::Cognito::UserPoolUser` resource creates an Amazon Cognito user pool user.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html}
+ */
 export type CognitoUserPoolUser = ResourceDefinition<"AWS::Cognito::UserPoolUser", CognitoUserPoolUserProps>;
 /**
  * The `AWS::Cognito::UserPoolUser` resource creates an Amazon Cognito user pool user.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html}
  */
 export type CognitoUserPoolUserProps = {
     /**
@@ -16,10 +21,12 @@ export type CognitoUserPoolUserProps = {
      * > - Store the `ClientMetadata` value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the `ClientMetadata` parameter serves no purpose.
      * > - Validate the `ClientMetadata` value.
      * > - Encrypt the `ClientMetadata` value. Don't send sensitive information in this parameter.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-clientmetadata}
      */
     ClientMetadata?: Record<string, string> | undefined;
     /**
      * Specify `EMAIL` if email will be used to send the welcome message. Specify `SMS` if the phone number will be used. The default value is `SMS` . You can specify more than one value.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-desireddeliverymediums}
      */
     DesiredDeliveryMediums?: string[] | undefined;
     /**
@@ -28,10 +35,12 @@ export type CognitoUserPoolUserProps = {
      * If this parameter is set to `True` and the phone number or email address specified in the `UserAttributes` parameter already exists as an alias with a different user, this request migrates the alias from the previous user to the newly-created user. The previous user will no longer be able to log in using that alias.
      *
      * If this parameter is set to `False` , the API throws an `AliasExistsException` error if the alias already exists. The default value is `False` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-forcealiascreation}
      */
     ForceAliasCreation?: boolean | undefined;
     /**
      * Set to `RESEND` to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password. Set to `SUPPRESS` to suppress sending the message. You can specify only one value.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-messageaction}
      */
     MessageAction?: string | undefined;
     /**
@@ -47,10 +56,12 @@ export type CognitoUserPoolUserProps = {
      *
      * - *email* : The email address of the user to whom the message that contains the code and username will be sent. Required if the `email_verified` attribute is set to `True` , or if `"EMAIL"` is specified in the `DesiredDeliveryMediums` parameter.
      * - *phone_number* : The phone number of the user to whom the message that contains the code and username will be sent. Required if the `phone_number_verified` attribute is set to `True` , or if `"SMS"` is specified in the `DesiredDeliveryMediums` parameter.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-userattributes}
      */
     UserAttributes?: AttributeType[] | undefined;
     /**
      * The ID of the user pool where you want to create a user.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-userpoolid}
      */
     UserPoolId: string;
     /**
@@ -59,6 +70,7 @@ export type CognitoUserPoolUserProps = {
      * - The username can't be a duplicate of another username in the same user pool.
      * - You can't change the value of a username after you create it.
      * - You can only provide a value if usernames are a valid sign-in attribute for your user pool. If your user pool only supports phone numbers or email addresses as sign-in attributes, Amazon Cognito automatically generates a username value. For more information, see [Customizing sign-in attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-username}
      */
     Username?: string | undefined;
     /**
@@ -67,19 +79,23 @@ export type CognitoUserPoolUserProps = {
      * Your Lambda function can analyze this additional data and act on it. Your function can automatically confirm and verify select users or perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs.
      *
      * For more information about the pre sign-up Lambda trigger, see [Pre sign-up Lambda trigger](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-validationdata}
      */
     ValidationData?: AttributeType[] | undefined;
 };
 /**
  * The name and value of a user attribute.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooluser-attributetype.html}
  */
 export type AttributeType = {
     /**
      * The name of the attribute.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooluser-attributetype.html#cfn-cognito-userpooluser-attributetype-name}
      */
     Name?: string | undefined;
     /**
      * The value of the attribute.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooluser-attributetype.html#cfn-cognito-userpooluser-attributetype-value}
      */
     Value?: string | undefined;
 };

package/out/exports/resources.generated/aws-cognito-userpoolusertogroupattachment.d.ts

@@ -1,4 +1,13 @@
 import type { ResourceDefinition } from "../main.ts";
+/**
+ * Adds a user to a group. A user who is in a group can present a preferred-role claim to an identity pool, and populates a `cognito:groups` claim to their access and identity tokens.
+ *
+ * > Amazon Cognito evaluates AWS Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
+ * >
+ * > **Learn more** - [Signing AWS API Requests](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)
+ * > - [Using the Amazon Cognito user pools API and user pool endpoints](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html)
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolusertogroupattachment.html}
+ */
 export type CognitoUserPoolUserToGroupAttachment = ResourceDefinition<"AWS::Cognito::UserPoolUserToGroupAttachment", CognitoUserPoolUserToGroupAttachmentProps>;
 /**
  * Adds a user to a group. A user who is in a group can present a preferred-role claim to an identity pool, and populates a `cognito:groups` claim to their access and identity tokens.
@@ -7,18 +16,22 @@ export type CognitoUserPoolUserToGroupAttachment = ResourceDefinition<"AWS::Cogn
  * >
  * > **Learn more** - [Signing AWS API Requests](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)
  * > - [Using the Amazon Cognito user pools API and user pool endpoints](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html)
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolusertogroupattachment.html}
  */
 export type CognitoUserPoolUserToGroupAttachmentProps = {
     /**
      * The name of the group that you want to add your user to.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolusertogroupattachment.html#cfn-cognito-userpoolusertogroupattachment-groupname}
      */
     GroupName: string;
     /**
      * The ID of the user pool that contains the group that you want to add the user to.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolusertogroupattachment.html#cfn-cognito-userpoolusertogroupattachment-userpoolid}
      */
     UserPoolId: string;
     /**
      * The user's username.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolusertogroupattachment.html#cfn-cognito-userpoolusertogroupattachment-username}
      */
     Username: string;
 };

package/out/exports/resources.generated/aws-comprehend-documentclassifier.d.ts

@@ -1,7 +1,12 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * This resource creates and trains a document classifier to categorize documents. You provide a set of training documents that are labeled with the categories that you want to identify. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see [Document Classification](https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html) in the Comprehend Developer Guide.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html}
+ */
 export type ComprehendDocumentClassifier = ResourceDefinitionWithAttributes<"AWS::Comprehend::DocumentClassifier", ComprehendDocumentClassifierProps, ComprehendDocumentClassifierAttribs>;
 /**
  * This resource creates and trains a document classifier to categorize documents. You provide a set of training documents that are labeled with the categories that you want to identify. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see [Document Classification](https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html) in the Comprehend Developer Guide.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html}
  */
 export type ComprehendDocumentClassifierProps = {
     /**
@@ -9,6 +14,7 @@ export type ComprehendDocumentClassifierProps = {
      * @minLength 20
      * @maxLength 2048
      * @pattern arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-dataaccessrolearn}
      */
     DataAccessRoleArn: string;
     /**
@@ -16,18 +22,22 @@ export type ComprehendDocumentClassifierProps = {
      * @minLength 1
      * @maxLength 63
      * @pattern ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-documentclassifiername}
      */
     DocumentClassifierName: string;
     /**
      * Specifies the format and location of the input data for the job.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-inputdataconfig}
      */
     InputDataConfig: DocumentClassifierInputDataConfig;
     /**
      * The language of the input documents. You can specify any of the languages supported by Amazon Comprehend. All documents must be in the same language.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-languagecode}
      */
     LanguageCode: "en" | "es" | "fr" | "it" | "de" | "pt";
     /**
      * Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class (single-label) mode or multi-label mode. Multi-class mode identifies a single class label for each document and multi-label mode identifies one or more class labels for each document. Multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-mode}
      */
     Mode?: "MULTI_CLASS" | "MULTI_LABEL" | undefined;
     /**
@@ -35,6 +45,7 @@ export type ComprehendDocumentClassifierProps = {
      *
      * - KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
      * - Amazon Resource Name (ARN) of a KMS Key: `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-modelkmskeyid}
      */
     ModelKmsKeyId?: string | undefined;
     /**
@@ -50,14 +61,17 @@ export type ComprehendDocumentClassifierProps = {
      * @minLength 1
      * @maxLength 20000
      * @pattern [\u0009\u000A\u000D\u0020-\u00FF]+
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-modelpolicy}
      */
     ModelPolicy?: string | undefined;
     /**
      * Provides output results configuration parameters for custom classifier jobs.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-outputdataconfig}
      */
     OutputDataConfig?: DocumentClassifierOutputDataConfig | undefined;
     /**
      * Tags to associate with the document classifier. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-tags}
      */
     Tags?: Tag[] | undefined;
     /**
@@ -65,6 +79,7 @@ export type ComprehendDocumentClassifierProps = {
      * @minLength 1
      * @maxLength 63
      * @pattern ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-versionname}
      */
     VersionName?: string | undefined;
     /**
@@ -72,24 +87,31 @@ export type ComprehendDocumentClassifierProps = {
      *
      * - KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
      * - Amazon Resource Name (ARN) of a KMS Key: `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-volumekmskeyid}
      */
     VolumeKmsKeyId?: string | undefined;
     /**
      * Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see [Amazon VPC](https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-vpcconfig}
      */
     VpcConfig?: VpcConfig | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#aws-resource-comprehend-documentclassifier-return-values}
+ */
 export type ComprehendDocumentClassifierAttribs = {
     /**
      * The Amazon Resource Name (ARN) of the document classifier.
      * @minLength 1
      * @maxLength 256
      * @pattern arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document-classifier/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-arn}
      */
     Arn: string;
 };
 /**
  * An augmented manifest file that provides training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-augmentedmanifestslistitem.html}
  */
 export type AugmentedManifestsListItem = {
     /**
@@ -98,10 +120,12 @@ export type AugmentedManifestsListItem = {
      * If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.
      *
      * If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-augmentedmanifestslistitem.html#cfn-comprehend-documentclassifier-augmentedmanifestslistitem-attributenames}
      */
     AttributeNames: string[];
     /**
      * The Amazon S3 location of the augmented manifest file.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-augmentedmanifestslistitem.html#cfn-comprehend-documentclassifier-augmentedmanifestslistitem-s3uri}
      */
     S3Uri: string;
     /**
@@ -110,19 +134,23 @@ export type AugmentedManifestsListItem = {
      * TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.
      *
      * TEST - all of the documents in the manifest will be used for testing.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-augmentedmanifestslistitem.html#cfn-comprehend-documentclassifier-augmentedmanifestslistitem-split}
      */
     Split?: "TRAIN" | "TEST" | undefined;
 };
 /**
  * The location of the training documents. This parameter is required in a request to create a semi-structured document classification model.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierdocuments.html}
  */
 export type DocumentClassifierDocuments = {
     /**
      * The S3 URI location of the training documents specified in the S3Uri CSV file.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierdocuments.html#cfn-comprehend-documentclassifier-documentclassifierdocuments-s3uri}
      */
     S3Uri: string;
     /**
      * The S3 URI location of the test documents included in the TestS3Uri CSV file. This field is not required if you do not specify a test CSV file.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierdocuments.html#cfn-comprehend-documentclassifier-documentclassifierdocuments-tests3uri}
      */
     TestS3Uri?: string | undefined;
 };
@@ -130,12 +158,14 @@ export type DocumentClassifierDocuments = {
  * The input properties for training a document classifier.
  *
  * For more information on how the input file is formatted, see [Preparing training data](https://docs.aws.amazon.com/comprehend/latest/dg/prep-classifier-data.html) in the Comprehend Developer Guide.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html}
  */
 export type DocumentClassifierInputDataConfig = {
     /**
      * A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
      *
      * This parameter is required if you set `DataFormat` to `AUGMENTED_MANIFEST` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-augmentedmanifests}
      */
     AugmentedManifests?: AugmentedManifestsListItem[] | undefined;
     /**
@@ -147,15 +177,21 @@ export type DocumentClassifierInputDataConfig = {
      * If you use this value, you must provide the `AugmentedManifests` parameter in your request.
      *
      * If you don't specify a value, Amazon Comprehend uses `COMPREHEND_CSV` as the default.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-dataformat}
      */
     DataFormat?: "COMPREHEND_CSV" | "AUGMENTED_MANIFEST" | undefined;
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-documentreaderconfig}
+     */
     DocumentReaderConfig?: DocumentReaderConfig | undefined;
     /**
      * The type of input documents for training the model. Provide plain-text documents to create a plain-text model, and provide semi-structured documents to create a native document model.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-documenttype}
      */
     DocumentType?: "PLAIN_TEXT_DOCUMENT" | "SEMI_STRUCTURED_DOCUMENT" | undefined;
     /**
      * The S3 location of the training documents. This parameter is required in a request to create a native document model.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-documents}
      */
     Documents?: DocumentClassifierDocuments | undefined;
     /**
@@ -163,6 +199,7 @@ export type DocumentClassifierInputDataConfig = {
      * @minLength 1
      * @maxLength 1
      * @pattern ^[ ~!@#$%^*\-_+=|\\:;\t>?/]$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-labeldelimiter}
      */
     LabelDelimiter?: string | undefined;
     /**
@@ -171,15 +208,18 @@ export type DocumentClassifierInputDataConfig = {
      * For example, if you use the URI `S3://bucketName/prefix` , if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.
      *
      * This parameter is required if you set `DataFormat` to `COMPREHEND_CSV` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-s3uri}
      */
     S3Uri?: string | undefined;
     /**
      * This specifies the Amazon S3 location that contains the test annotations for the document classifier. The URI must be in the same AWS Region as the API endpoint that you are calling.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-tests3uri}
      */
     TestS3Uri?: string | undefined;
 };
 /**
  * Provide the location for output data from a custom classifier job. This field is mandatory if you are training a native document model.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifieroutputdataconfig.html}
  */
 export type DocumentClassifierOutputDataConfig = {
     /**
@@ -189,12 +229,14 @@ export type DocumentClassifierOutputDataConfig = {
      * - Amazon Resource Name (ARN) of a KMS Key: `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
      * - KMS Key Alias: `"alias/ExampleAlias"`
      * - ARN of a KMS Key Alias: `"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifieroutputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifieroutputdataconfig-kmskeyid}
      */
     KmsKeyId?: string | undefined;
     /**
      * When you use the `OutputDataConfig` object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix and other output files. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of this output file.
      *
      * When the custom classifier job is finished, the service creates the output file in a directory specific to the job. The `S3Uri` field contains the location of the output file, called `output.tar.gz` . It is a compressed archive that contains the confusion matrix.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifieroutputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifieroutputdataconfig-s3uri}
      */
     S3Uri?: string | undefined;
 };
@@ -210,6 +252,7 @@ export type DocumentClassifierOutputDataConfig = {
  * `DocumentReaderConfig` does not apply to plain text files or Word files.
  *
  * For image files and PDF documents, you can override these default actions using the fields listed below. For more information, see [Setting text extraction options](https://docs.aws.amazon.com/comprehend/latest/dg/idp-set-textract-options.html) in the Comprehend Developer Guide.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentreaderconfig.html}
  */
 export type DocumentReaderConfig = {
     /**
@@ -217,6 +260,7 @@ export type DocumentReaderConfig = {
      *
      * - `TEXTRACT_DETECT_DOCUMENT_TEXT` - The Amazon Comprehend service uses the `DetectDocumentText` API operation.
      * - `TEXTRACT_ANALYZE_DOCUMENT` - The Amazon Comprehend service uses the `AnalyzeDocument` API operation.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentreaderconfig.html#cfn-comprehend-documentclassifier-documentreaderconfig-documentreadaction}
      */
     DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" | "TEXTRACT_ANALYZE_DOCUMENT";
     /**
@@ -224,6 +268,7 @@ export type DocumentReaderConfig = {
      *
      * - `SERVICE_DEFAULT` - use the Amazon Comprehend service defaults for PDF files.
      * - `FORCE_DOCUMENT_READ_ACTION` - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentreaderconfig.html#cfn-comprehend-documentclassifier-documentreaderconfig-documentreadmode}
      */
     DocumentReadMode?: "SERVICE_DEFAULT" | "FORCE_DOCUMENT_READ_ACTION" | undefined;
     /**
@@ -231,19 +276,23 @@ export type DocumentReaderConfig = {
      *
      * - `TABLES` - Returns additional information about any tables that are detected in the input document.
      * - `FORMS` - Returns additional information about any forms that are detected in the input document.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentreaderconfig.html#cfn-comprehend-documentclassifier-documentreaderconfig-featuretypes}
      */
     FeatureTypes?: ("TABLES" | "FORMS")[] | undefined;
 };
 /**
  * Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see [Amazon VPC](https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-vpcconfig.html}
  */
 export type VpcConfig = {
     /**
      * The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see [Security Groups for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-vpcconfig.html#cfn-comprehend-documentclassifier-vpcconfig-securitygroupids}
      */
     SecurityGroupIds: string[];
     /**
      * The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see [VPCs and Subnets](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-vpcconfig.html#cfn-comprehend-documentclassifier-vpcconfig-subnets}
      */
     Subnets: string[];
 };