@propulsionworks/cloudformation 0.1.0 → 0.1.2

package/out/exports/resources.generated/aws-m2-application.d.ts

@@ -1,63 +1,83 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * Specifies a new application with given parameters. Requires an existing runtime environment and application definition file.
+ *
+ * For information about application definitions, see the [AWS Mainframe Modernization User Guide](https://docs.aws.amazon.com/m2/latest/userguide/applications-m2-definition.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html}
+ */
 export type M2Application = ResourceDefinitionWithAttributes<"AWS::M2::Application", M2ApplicationProps, M2ApplicationAttribs>;
 /**
  * Specifies a new application with given parameters. Requires an existing runtime environment and application definition file.
  *
  * For information about application definitions, see the [AWS Mainframe Modernization User Guide](https://docs.aws.amazon.com/m2/latest/userguide/applications-m2-definition.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html}
  */
 export type M2ApplicationProps = {
     /**
      * The application definition for a particular application. You can specify either inline JSON or an Amazon S3 bucket location.
      *
      * For information about application definitions, see the [AWS Mainframe Modernization User Guide](https://docs.aws.amazon.com/m2/latest/userguide/applications-m2-definition.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html#cfn-m2-application-definition}
      */
     Definition?: Definition | undefined;
     /**
      * The description of the application.
      * @minLength 0
      * @maxLength 500
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html#cfn-m2-application-description}
      */
     Description?: string | undefined;
     /**
      * The type of the target platform for this application.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html#cfn-m2-application-enginetype}
      */
     EngineType: EngineType;
     /**
      * The identifier of a customer managed key.
      * @maxLength 2048
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html#cfn-m2-application-kmskeyid}
      */
     KmsKeyId?: string | undefined;
     /**
      * The name of the application.
      * @pattern ^[A-Za-z0-9][A-Za-z0-9_\-]{1,59}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html#cfn-m2-application-name}
      */
     Name: string;
     /**
      * The Amazon Resource Name (ARN) of the role associated with the application.
      * @pattern ^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]|):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html#cfn-m2-application-rolearn}
      */
     RoleArn?: string | undefined;
     /**
      * An array of key-value pairs to apply to this resource.
      *
      * For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html#cfn-m2-application-tags}
      */
     Tags?: Record<string, string> | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html#aws-resource-m2-application-return-values}
+ */
 export type M2ApplicationAttribs = {
     /**
      * The Amazon Resource Name (ARN) of the application.
      * @pattern ^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html#cfn-m2-application-applicationarn}
      */
     ApplicationArn: string;
     /**
      * The identifier of the application.
      * @pattern ^\S{1,80}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html#cfn-m2-application-applicationid}
      */
     ApplicationId: string;
 };
 /**
  * The application definition for a particular application. You can specify either inline JSON or an Amazon S3 bucket location.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-application-definition.html}
  */
 export type Definition = {
     /**
@@ -71,5 +91,8 @@ export type Definition = {
      */
     Content: string;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-application-enginetype.html}
+ */
 export type EngineType = "microfocus" | "bluage";
 //# sourceMappingURL=aws-m2-application.d.ts.map

package/out/exports/resources.generated/aws-m2-deployment.d.ts

@@ -1,32 +1,45 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * Creates and starts a deployment to deploy an application into a runtime environment.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-deployment.html}
+ */
 export type M2Deployment = ResourceDefinitionWithAttributes<"AWS::M2::Deployment", M2DeploymentProps, M2DeploymentAttribs>;
 /**
  * Creates and starts a deployment to deploy an application into a runtime environment.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-deployment.html}
  */
 export type M2DeploymentProps = {
     /**
      * The unique identifier of the application.
      * @pattern ^\S{1,80}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-deployment.html#cfn-m2-deployment-applicationid}
      */
     ApplicationId: string;
     /**
      * The version of the application.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-deployment.html#cfn-m2-deployment-applicationversion}
      */
     ApplicationVersion: number;
     /**
      * The unique identifier of the runtime environment.
      * @pattern ^\S{1,80}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-deployment.html#cfn-m2-deployment-environmentid}
      */
     EnvironmentId: string;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-deployment.html#aws-resource-m2-deployment-return-values}
+ */
 export type M2DeploymentAttribs = {
     /**
      * The unique identifier of the deployment.
      * @pattern ^\S{1,80}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-deployment.html#cfn-m2-deployment-deploymentid}
      */
     DeploymentId: string;
     /**
      * The current status of the deployment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-deployment.html#cfn-m2-deployment-status}
      */
     Status: string;
 };

package/out/exports/resources.generated/aws-m2-environment.d.ts

@@ -1,45 +1,58 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * Specifies a runtime environment for a given runtime engine.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html}
+ */
 export type M2Environment = ResourceDefinitionWithAttributes<"AWS::M2::Environment", M2EnvironmentProps, M2EnvironmentAttribs>;
 /**
  * Specifies a runtime environment for a given runtime engine.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html}
  */
 export type M2EnvironmentProps = {
     /**
      * The description of the runtime environment.
      * @minLength 0
      * @maxLength 500
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-description}
      */
     Description?: string | undefined;
     /**
      * The target platform for the runtime environment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-enginetype}
      */
     EngineType: EngineType;
     /**
      * The version of the runtime engine.
      * @pattern ^\S{1,10}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-engineversion}
      */
     EngineVersion?: string | undefined;
     /**
      * Defines the details of a high availability configuration.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-highavailabilityconfig}
      */
     HighAvailabilityConfig?: HighAvailabilityConfig | undefined;
     /**
      * The instance type of the runtime environment.
      * @pattern ^\S{1,20}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-instancetype}
      */
     InstanceType: string;
     /**
      * The identifier of a customer managed key.
      * @maxLength 2048
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-kmskeyid}
      */
     KmsKeyId?: string | undefined;
     /**
      * The name of the runtime environment.
      * @pattern ^[A-Za-z0-9][A-Za-z0-9_\-]{1,59}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-name}
      */
     Name: string;
     /**
      * The network type supported by the runtime environment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-networktype}
      */
     NetworkType?: NetworkType | undefined;
     /**
@@ -47,91 +60,115 @@ export type M2EnvironmentProps = {
      *
      * If you do not provide a value, a random system-generated value will be assigned.
      * @pattern ^\S{1,50}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-preferredmaintenancewindow}
      */
     PreferredMaintenanceWindow?: string | undefined;
     /**
      * Specifies whether the runtime environment is publicly accessible.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-publiclyaccessible}
      */
     PubliclyAccessible?: boolean | undefined;
     /**
      * The list of security groups for the VPC associated with this runtime environment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-securitygroupids}
      */
     SecurityGroupIds?: string[] | undefined;
     /**
      * Defines the storage configuration for a runtime environment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-storageconfigurations}
      */
     StorageConfigurations?: StorageConfiguration[] | undefined;
     /**
      * The list of subnets associated with the VPC for this runtime environment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-subnetids}
      */
     SubnetIds?: string[] | undefined;
     /**
      * An array of key-value pairs to apply to this resource.
      *
      * For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-tags}
      */
     Tags?: Record<string, string> | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#aws-resource-m2-environment-return-values}
+ */
 export type M2EnvironmentAttribs = {
     /**
      * The Amazon Resource Name (ARN) of the runtime environment.
      * @pattern ^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-environmentarn}
      */
     EnvironmentArn: string;
     /**
      * The unique identifier of the runtime environment.
      * @pattern ^\S{1,80}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-environmentid}
      */
     EnvironmentId: string;
 };
 /**
  * Defines the storage configuration for an Amazon EFS file system.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-efsstorageconfiguration.html}
  */
 export type EfsStorageConfiguration = {
     /**
      * The file system identifier.
      * @pattern ^\S{1,200}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-efsstorageconfiguration.html#cfn-m2-environment-efsstorageconfiguration-filesystemid}
      */
     FileSystemId: string;
     /**
      * The mount point for the file system.
      * @pattern ^\S{1,200}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-efsstorageconfiguration.html#cfn-m2-environment-efsstorageconfiguration-mountpoint}
      */
     MountPoint: string;
 };
 /**
  * The target platform for the environment.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-enginetype.html}
  */
 export type EngineType = "microfocus" | "bluage";
 /**
  * Defines the storage configuration for an Amazon FSx file system.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-fsxstorageconfiguration.html}
  */
 export type FsxStorageConfiguration = {
     /**
      * The file system identifier.
      * @pattern ^\S{1,200}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-fsxstorageconfiguration.html#cfn-m2-environment-fsxstorageconfiguration-filesystemid}
      */
     FileSystemId: string;
     /**
      * The mount point for the file system.
      * @pattern ^\S{1,200}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-fsxstorageconfiguration.html#cfn-m2-environment-fsxstorageconfiguration-mountpoint}
      */
     MountPoint: string;
 };
 /**
  * Defines the details of a high availability configuration.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-highavailabilityconfig.html}
  */
 export type HighAvailabilityConfig = {
     /**
      * The number of instances in a high availability configuration. The minimum possible value is 1 and the maximum is 100.
      * @min 1
      * @max 100
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-highavailabilityconfig.html#cfn-m2-environment-highavailabilityconfig-desiredcapacity}
      */
     DesiredCapacity: number;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-networktype.html}
+ */
 export type NetworkType = "ipv4" | "dual";
 /**
  * Defines the storage configuration for a runtime environment.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-storageconfiguration.html}
  */
 export type StorageConfiguration = {
     Efs: EfsStorageConfiguration;

package/out/exports/resources.generated/aws-macie-allowlist.d.ts

@@ -1,4 +1,21 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * The `AWS::Macie::AllowList` resource specifies an allow list. In Amazon Macie , an allow list defines specific text or a text pattern for Macie to ignore when it inspects data sources for sensitive data. If data matches text or a text pattern in an allow list, Macie doesn’t report the data in sensitive data findings or sensitive data discovery results, even if the data matches the criteria of a custom data identifier or a managed data identifier. You can create and use allow lists in all the AWS Regions where Macie is currently available except the Asia Pacific (Osaka) Region.
+ *
+ * Macie supports two types of allow lists:
+ *
+ * - *Predefined text* - For this type of list ( `S3WordsList` ), you create a line-delimited plaintext file that lists specific text to ignore, and you store the file in an Amazon Simple Storage Service ( Amazon S3 ) bucket. You then configure settings for Macie to access the list in the bucket.
+ *
+ * This type of list typically contains specific words, phrases, and other kinds of character sequences that aren’t sensitive, aren't likely to change, and don’t necessarily adhere to a common pattern. If you use this type of list, Macie doesn't report occurrences of text that exactly match a complete entry in the list. Macie treats each entry in the list as a string literal value. Matches aren't case sensitive.
+ * - *Regular expression* - For this type of list ( `Regex` ), you specify a regular expression that defines a text pattern to ignore. Unlike an allow list with predefined text, you store the regex and all other list settings in Macie .
+ *
+ * This type of list is helpful if you want to specify text that isn’t sensitive but varies or is likely to change while also adhering to a common pattern. If you use this type of list, Macie doesn't report occurrences of text that completely match the pattern defined by the list.
+ *
+ * For more information, see [Defining sensitive data exceptions with allow lists](https://docs.aws.amazon.com/macie/latest/user/allow-lists.html) in the *Amazon Macie User Guide* .
+ *
+ * An `AWS::Macie::Session` resource must exist for an AWS account before you can create an `AWS::Macie::AllowList` resource for the account. Use a [DependsOn attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to ensure that an `AWS::Macie::Session` resource is created before other Macie resources are created for an account. For example, `"DependsOn": "Session"` .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-allowlist.html}
+ */
 export type MacieAllowList = ResourceDefinitionWithAttributes<"AWS::Macie::AllowList", MacieAllowListProps, MacieAllowListAttribs>;
 /**
  * The `AWS::Macie::AllowList` resource specifies an allow list. In Amazon Macie , an allow list defines specific text or a text pattern for Macie to ignore when it inspects data sources for sensitive data. If data matches text or a text pattern in an allow list, Macie doesn’t report the data in sensitive data findings or sensitive data discovery results, even if the data matches the criteria of a custom data identifier or a managed data identifier. You can create and use allow lists in all the AWS Regions where Macie is currently available except the Asia Pacific (Osaka) Region.
@@ -15,34 +32,44 @@ export type MacieAllowList = ResourceDefinitionWithAttributes<"AWS::Macie::Allow
  * For more information, see [Defining sensitive data exceptions with allow lists](https://docs.aws.amazon.com/macie/latest/user/allow-lists.html) in the *Amazon Macie User Guide* .
  *
  * An `AWS::Macie::Session` resource must exist for an AWS account before you can create an `AWS::Macie::AllowList` resource for the account. Use a [DependsOn attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to ensure that an `AWS::Macie::Session` resource is created before other Macie resources are created for an account. For example, `"DependsOn": "Session"` .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-allowlist.html}
  */
 export type MacieAllowListProps = {
     /**
      * The criteria that specify the text or text pattern to ignore. The criteria can be the location and name of an Amazon S3 object that lists specific text to ignore ( `S3WordsList` ), or a regular expression ( `Regex` ) that defines a text pattern to ignore.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-allowlist.html#cfn-macie-allowlist-criteria}
      */
     Criteria: Criteria;
     /**
      * A custom description of the allow list. The description can contain 1-512 characters.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-allowlist.html#cfn-macie-allowlist-description}
      */
     Description?: string | undefined;
     /**
      * A custom name for the allow list. The name can contain 1-128 characters.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-allowlist.html#cfn-macie-allowlist-name}
      */
     Name: string;
     /**
      * An array of key-value pairs to apply to the allow list.
      *
      * For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-allowlist.html#cfn-macie-allowlist-tags}
      */
     Tags?: Tag[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-allowlist.html#aws-resource-macie-allowlist-return-values}
+ */
 export type MacieAllowListAttribs = {
     /**
      * The Amazon Resource Name (ARN) of the allow list.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-allowlist.html#cfn-macie-allowlist-arn}
      */
     Arn: string;
     /**
      * The unique identifier for the allow list.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-allowlist.html#cfn-macie-allowlist-id}
      */
     Id: string;
     /**
@@ -58,6 +85,7 @@ export type MacieAllowListAttribs = {
      * - `UNKNOWN_ERROR` - A transient or internal error occurred when Macie attempted to retrieve or parse the object. Wait a few minutes and then try again. A list can also have this status if it's encrypted with a key that Amazon S3 and Macie can't access or use.
      *
      * For more information, see [Allow list options and requirements](https://docs.aws.amazon.com/macie/latest/user/allow-lists-options.html) in the *Amazon Macie User Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-allowlist.html#cfn-macie-allowlist-status}
      */
     Status: Status;
 };
@@ -68,6 +96,7 @@ export type MacieAllowListAttribs = {
  * - A regular expression ( `Regex` ) that defines a text pattern to ignore.
  *
  * The criteria must specify either an S3 object or a regular expression. It can't specify both.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-macie-allowlist-criteria.html}
  */
 export type Criteria = {
     /**
@@ -82,23 +111,27 @@ export type Criteria = {
 };
 /**
  * Specifies the location and name of an Amazon Simple Storage Service ( Amazon S3 ) object that lists specific, predefined text to ignore when inspecting data sources for sensitive data.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-macie-allowlist-s3wordslist.html}
  */
 export type S3WordsList = {
     /**
      * The full name of the S3 bucket that contains the object. This value correlates to the `Name` field of a bucket's properties in Amazon S3 .
      *
      * This value is case sensitive. In addition, don't use wildcard characters or specify partial values for the name.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-macie-allowlist-s3wordslist.html#cfn-macie-allowlist-s3wordslist-bucketname}
      */
     BucketName: string;
     /**
      * The full name of the S3 object. This value correlates to the `Key` field of an object's properties in Amazon S3 . If the name includes a path, include the complete path. For example, `AllowLists/Macie/MyList.txt` .
      *
      * This value is case sensitive. In addition, don't use wildcard characters or specify partial values for the name.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-macie-allowlist-s3wordslist.html#cfn-macie-allowlist-s3wordslist-objectkey}
      */
     ObjectKey: string;
 };
 /**
  * The status for the AllowList
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-macie-allowlist-status.html}
  */
 export type Status = "OK" | "S3_OBJECT_NOT_FOUND" | "S3_USER_ACCESS_DENIED" | "S3_OBJECT_ACCESS_DENIED" | "S3_THROTTLED" | "S3_OBJECT_OVERSIZE" | "S3_OBJECT_EMPTY" | "UNKNOWN_ERROR";
 //# sourceMappingURL=aws-macie-allowlist.d.ts.map

package/out/exports/resources.generated/aws-macie-customdataidentifier.d.ts

@@ -1,4 +1,15 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * The `AWS::Macie::CustomDataIdentifier` resource specifies a custom data identifier. A *custom data identifier* is a set of custom criteria for Amazon Macie to use when it inspects data sources for sensitive data. The criteria consist of a regular expression ( *regex* ) that defines a text pattern to match and, optionally, character sequences and a proximity rule that refine the results. The character sequences can be:
+ *
+ * - *Keywords* , which are words or phrases that must be in proximity of text that matches the regex, or
+ * - *Ignore words* , which are words or phrases to exclude from the results.
+ *
+ * By using custom data identifiers, you can supplement the managed data identifiers that Macie provides and detect sensitive data that reflects your particular scenarios, intellectual property, or proprietary data. For more information, see [Building custom data identifiers](https://docs.aws.amazon.com/macie/latest/user/custom-data-identifiers.html) in the *Amazon Macie User Guide* .
+ *
+ * An `AWS::Macie::Session` resource must exist for an AWS account before you can create an `AWS::Macie::CustomDataIdentifier` resource for the account. Use a [DependsOn attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to ensure that an `AWS::Macie::Session` resource is created before other Macie resources are created for an account. For example, `"DependsOn": "Session"` .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html}
+ */
 export type MacieCustomDataIdentifier = ResourceDefinitionWithAttributes<"AWS::Macie::CustomDataIdentifier", MacieCustomDataIdentifierProps, MacieCustomDataIdentifierAttribs>;
 /**
  * The `AWS::Macie::CustomDataIdentifier` resource specifies a custom data identifier. A *custom data identifier* is a set of custom criteria for Amazon Macie to use when it inspects data sources for sensitive data. The criteria consist of a regular expression ( *regex* ) that defines a text pattern to match and, optionally, character sequences and a proximity rule that refine the results. The character sequences can be:
@@ -9,56 +20,69 @@ export type MacieCustomDataIdentifier = ResourceDefinitionWithAttributes<"AWS::M
  * By using custom data identifiers, you can supplement the managed data identifiers that Macie provides and detect sensitive data that reflects your particular scenarios, intellectual property, or proprietary data. For more information, see [Building custom data identifiers](https://docs.aws.amazon.com/macie/latest/user/custom-data-identifiers.html) in the *Amazon Macie User Guide* .
  *
  * An `AWS::Macie::Session` resource must exist for an AWS account before you can create an `AWS::Macie::CustomDataIdentifier` resource for the account. Use a [DependsOn attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to ensure that an `AWS::Macie::Session` resource is created before other Macie resources are created for an account. For example, `"DependsOn": "Session"` .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html}
  */
 export type MacieCustomDataIdentifierProps = {
     /**
      * A custom description of the custom data identifier. The description can contain 1-512 characters.
      *
      * Avoid including sensitive data in the description. Users of the account might be able to see the description, depending on the actions that they're allowed to perform in Amazon Macie .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-description}
      */
     Description?: string | undefined;
     /**
      * An array of character sequences ( *ignore words* ) to exclude from the results. If text matches the regular expression ( `Regex` ) but it contains a string in this array, Amazon Macie ignores the text and doesn't include it in the results.
      *
      * The array can contain 1-10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-ignorewords}
      */
     IgnoreWords?: string[] | undefined;
     /**
      * An array of character sequences ( *keywords* ), one of which must precede and be in proximity ( `MaximumMatchDistance` ) of the regular expression ( `Regex` ) to match.
      *
      * The array can contain 1-50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-keywords}
      */
     Keywords?: string[] | undefined;
     /**
      * The maximum number of characters that can exist between the end of at least one complete character sequence specified by the `Keywords` array and the end of text that matches the regular expression ( `Regex` ). If a complete keyword precedes all the text that matches the regular expression and the keyword is within the specified distance, Amazon Macie includes the result.
      *
      * The distance can be 1-300 characters. The default value is 50.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-maximummatchdistance}
      */
     MaximumMatchDistance?: number | undefined;
     /**
      * A custom name for the custom data identifier. The name can contain 1-128 characters.
      *
      * Avoid including sensitive data in the name of a custom data identifier. Users of the account might be able to see the name, depending on the actions that they're allowed to perform in Amazon Macie .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-name}
      */
     Name: string;
     /**
      * The regular expression ( *regex* ) that defines the text pattern to match. The expression can contain 1-512 characters.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-regex}
      */
     Regex: string;
     /**
      * An array of key-value pairs to apply to the custom data identifier.
      *
      * For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-tags}
      */
     Tags?: Tag[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#aws-resource-macie-customdataidentifier-return-values}
+ */
 export type MacieCustomDataIdentifierAttribs = {
     /**
      * The Amazon Resource Name (ARN) of the custom data identifier.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-arn}
      */
     Arn: string;
     /**
      * The unique identifier for the custom data identifier.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-id}
      */
     Id: string;
 };