@propulsionworks/cloudformation 0.1.0 → 0.1.2

package/out/exports/resources.generated/aws-logs-destination.d.ts

@@ -1,7 +1,12 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * The AWS::Logs::Destination resource specifies a CloudWatch Logs destination. A destination encapsulates a physical resource (such as an Amazon Kinesis data stream) and enables you to subscribe that resource to a stream of log events.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html}
+ */
 export type LogsDestination = ResourceDefinitionWithAttributes<"AWS::Logs::Destination", LogsDestinationProps, LogsDestinationAttribs>;
 /**
  * The AWS::Logs::Destination resource specifies a CloudWatch Logs destination. A destination encapsulates a physical resource (such as an Amazon Kinesis data stream) and enables you to subscribe that resource to a stream of log events.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html}
  */
 export type LogsDestinationProps = {
     /**
@@ -9,27 +14,35 @@ export type LogsDestinationProps = {
      * @minLength 1
      * @maxLength 512
      * @pattern ^[^:*]{1,512}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-destinationname}
      */
     DestinationName: string;
     /**
      * An IAM policy document that governs which AWS accounts can create subscription filters against this destination.
      * @minLength 1
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-destinationpolicy}
      */
     DestinationPolicy?: string | undefined;
     /**
      * The ARN of an IAM role that permits CloudWatch Logs to send data to the specified AWS resource.
      * @minLength 1
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-rolearn}
      */
     RoleArn: string;
     /**
      * The Amazon Resource Name (ARN) of the physical target where the log events are delivered (for example, a Kinesis stream).
      * @minLength 1
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-targetarn}
      */
     TargetArn: string;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#aws-resource-logs-destination-return-values}
+ */
 export type LogsDestinationAttribs = {
     /**
      * The ARN of the CloudWatch Logs destination, such as `arn:aws:logs:us-west-1:123456789012:destination:MyDestination` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-arn}
      */
     Arn: string;
 };

package/out/exports/resources.generated/aws-logs-integration.d.ts

@@ -1,4 +1,12 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * Creates an integration between CloudWatch Logs and another service in this account. Currently, only integrations with OpenSearch Service are supported, and currently you can have only one integration in your account.
+ *
+ * Integrating with OpenSearch Service makes it possible for you to create curated vended logs dashboards, powered by OpenSearch Service analytics. For more information, see [Vended log dashboards powered by Amazon OpenSearch Service](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-OpenSearch-Dashboards.html) .
+ *
+ * You can use this operation only to create a new integration. You can't modify an existing integration.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-integration.html}
+ */
 export type LogsIntegration = ResourceDefinitionWithAttributes<"AWS::Logs::Integration", LogsIntegrationProps, LogsIntegrationAttribs>;
 /**
  * Creates an integration between CloudWatch Logs and another service in this account. Currently, only integrations with OpenSearch Service are supported, and currently you can have only one integration in your account.
@@ -6,6 +14,7 @@ export type LogsIntegration = ResourceDefinitionWithAttributes<"AWS::Logs::Integ
  * Integrating with OpenSearch Service makes it possible for you to create curated vended logs dashboards, powered by OpenSearch Service analytics. For more information, see [Vended log dashboards powered by Amazon OpenSearch Service](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-OpenSearch-Dashboards.html) .
  *
  * You can use this operation only to create a new integration. You can't modify an existing integration.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-integration.html}
  */
 export type LogsIntegrationProps = {
     /**
@@ -13,51 +22,64 @@ export type LogsIntegrationProps = {
      * @minLength 1
      * @maxLength 50
      * @pattern [\.\-_/#A-Za-z0-9]+
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-integration.html#cfn-logs-integration-integrationname}
      */
     IntegrationName: string;
     /**
      * The type of integration. Integrations with OpenSearch Service have the type `OPENSEARCH` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-integration.html#cfn-logs-integration-integrationtype}
      */
     IntegrationType: "OPENSEARCH";
     /**
      * This structure contains configuration details about an integration between CloudWatch Logs and another entity.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-integration.html#cfn-logs-integration-resourceconfig}
      */
     ResourceConfig: {
         OpenSearchResourceConfig?: OpenSearchResourceConfig | undefined;
     };
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-integration.html#aws-resource-logs-integration-return-values}
+ */
 export type LogsIntegrationAttribs = {
     /**
      * The current status of this integration.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-integration.html#cfn-logs-integration-integrationstatus}
      */
     IntegrationStatus: "PROVISIONING" | "ACTIVE" | "FAILED";
 };
 /**
  * This structure contains configuration details about an integration between CloudWatch Logs and OpenSearch Service.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-integration-opensearchresourceconfig.html}
  */
 export type OpenSearchResourceConfig = {
     /**
      * If you want to use an existing OpenSearch Service application for your integration with OpenSearch Service, specify it here. If you omit this, a new application will be created.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-integration-opensearchresourceconfig.html#cfn-logs-integration-opensearchresourceconfig-applicationarn}
      */
     ApplicationARN?: string | undefined;
     /**
      * Specify the ARNs of IAM roles and IAM users who you want to grant permission to for viewing the dashboards.
      *
      * > In addition to specifying these users here, you must also grant them the *CloudWatchOpenSearchDashboardAccess* IAM policy. For more information, see [IAM policies for users](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/OpenSearch-Dashboards-UserRoles.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-integration-opensearchresourceconfig.html#cfn-logs-integration-opensearchresourceconfig-dashboardviewerprincipals}
      */
     DashboardViewerPrincipals: string[];
     /**
      * Specify the ARN of an IAM role that CloudWatch Logs will use to create the integration. This role must have the permissions necessary to access the OpenSearch Service collection to be able to create the dashboards. For more information about the permissions needed, see [Permissions that the integration needs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/OpenSearch-Dashboards-CreateRole.html) in the CloudWatch Logs User Guide.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-integration-opensearchresourceconfig.html#cfn-logs-integration-opensearchresourceconfig-datasourcerolearn}
      */
     DataSourceRoleArn: string;
     /**
      * To have the vended dashboard data encrypted with AWS KMS instead of the CloudWatch Logs default encryption method, specify the ARN of the AWS KMS key that you want to use.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-integration-opensearchresourceconfig.html#cfn-logs-integration-opensearchresourceconfig-kmskeyarn}
      */
     KmsKeyArn?: string | undefined;
     /**
      * Specify how many days that you want the data derived by OpenSearch Service to be retained in the index that the dashboard refers to. This also sets the maximum time period that you can choose when viewing data in the dashboard. Choosing a longer time frame will incur additional costs.
      * @min 1
      * @max 3650
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-integration-opensearchresourceconfig.html#cfn-logs-integration-opensearchresourceconfig-retentiondays}
      */
     RetentionDays?: number | undefined;
 };

package/out/exports/resources.generated/aws-logs-loganomalydetector.d.ts

@@ -1,4 +1,16 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * Creates or updates an *anomaly detector* that regularly scans one or more log groups and look for patterns and anomalies in the logs.
+ *
+ * An anomaly detector can help surface issues by automatically discovering anomalies in your log event traffic. An anomaly detector uses machine learning algorithms to scan log events and find *patterns* . A pattern is a shared text structure that recurs among your log fields. Patterns provide a useful tool for analyzing large sets of logs because a large number of log events can often be compressed into a few patterns.
+ *
+ * The anomaly detector uses pattern recognition to find `anomalies` , which are unusual log events. It compares current log events and patterns with trained baselines.
+ *
+ * Fields within a pattern are called *tokens* . Fields that vary within a pattern, such as a request ID or timestamp, are referred to as *dynamic tokens* and represented by `<*>` .
+ *
+ * For more information see [Log anomaly detection](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/LogsAnomalyDetection.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html}
+ */
 export type LogsLogAnomalyDetector = ResourceDefinitionWithAttributes<"AWS::Logs::LogAnomalyDetector", LogsLogAnomalyDetectorProps, LogsLogAnomalyDetectorAttribs>;
 /**
  * Creates or updates an *anomaly detector* that regularly scans one or more log groups and look for patterns and anomalies in the logs.
@@ -10,27 +22,33 @@ export type LogsLogAnomalyDetector = ResourceDefinitionWithAttributes<"AWS::Logs
  * Fields within a pattern are called *tokens* . Fields that vary within a pattern, such as a request ID or timestamp, are referred to as *dynamic tokens* and represented by `<*>` .
  *
  * For more information see [Log anomaly detection](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/LogsAnomalyDetection.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html}
  */
 export type LogsLogAnomalyDetectorProps = {
     /**
      * The ID of the account to create the anomaly detector in.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html#cfn-logs-loganomalydetector-accountid}
      */
     AccountId?: string | undefined;
     /**
      * The number of days to have visibility on an anomaly. After this time period has elapsed for an anomaly, it will be automatically baselined and the anomaly detector will treat new occurrences of a similar anomaly as normal. Therefore, if you do not correct the cause of an anomaly during the time period specified in `AnomalyVisibilityTime` , it will be considered normal going forward and will not be detected as an anomaly.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html#cfn-logs-loganomalydetector-anomalyvisibilitytime}
      */
     AnomalyVisibilityTime?: number | undefined;
     /**
      * A name for this anomaly detector.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html#cfn-logs-loganomalydetector-detectorname}
      */
     DetectorName?: string | undefined;
     /**
      * Specifies how often the anomaly detector is to run and look for anomalies. Set this value according to the frequency that the log group receives new logs. For example, if the log group receives new log events every 10 minutes, then 15 minutes might be a good setting for `EvaluationFrequency` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html#cfn-logs-loganomalydetector-evaluationfrequency}
      */
     EvaluationFrequency?: "FIVE_MIN" | "TEN_MIN" | "FIFTEEN_MIN" | "THIRTY_MIN" | "ONE_HOUR" | undefined;
     /**
      * You can use this parameter to limit the anomaly detection model to examine only log events that match the pattern you specify here. For more information, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html) .
      * @pattern
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html#cfn-logs-loganomalydetector-filterpattern}
      */
     FilterPattern?: string | undefined;
     /**
@@ -38,28 +56,37 @@ export type LogsLogAnomalyDetectorProps = {
      *
      * For more information about using a AWS KMS key and to see the required IAM policy, see [Use a AWS KMS key with an anomaly detector](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/LogsAnomalyDetection-KMS.html) .
      * @maxLength 256
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html#cfn-logs-loganomalydetector-kmskeyid}
      */
     KmsKeyId?: string | undefined;
     /**
      * The ARN of the log group that is associated with this anomaly detector. You can specify only one log group ARN.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html#cfn-logs-loganomalydetector-loggrouparnlist}
      */
     LogGroupArnList?: string[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html#aws-resource-logs-loganomalydetector-return-values}
+ */
 export type LogsLogAnomalyDetectorAttribs = {
     /**
      * The ARN of the anomaly detector.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html#cfn-logs-loganomalydetector-anomalydetectorarn}
      */
     AnomalyDetectorArn: string;
     /**
      * Specifies whether the anomaly detector is currently active.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html#cfn-logs-loganomalydetector-anomalydetectorstatus}
      */
     AnomalyDetectorStatus: string;
     /**
      * The time that the anomaly detector was created.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html#cfn-logs-loganomalydetector-creationtimestamp}
      */
     CreationTimeStamp: number;
     /**
      * The time that the anomaly detector was most recently modified.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html#cfn-logs-loganomalydetector-lastmodifiedtimestamp}
      */
     LastModifiedTimeStamp: number;
 };

package/out/exports/resources.generated/aws-logs-loggroup.d.ts

@@ -1,4 +1,14 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * The `AWS::Logs::LogGroup` resource specifies a log group. A log group defines common properties for log streams, such as their retention and access control rules. Each log stream must belong to one log group.
+ *
+ * You can create up to 1,000,000 log groups per Region per account. You must use the following guidelines when naming a log group:
+ *
+ * - Log group names must be unique within a Region for an AWS account.
+ * - Log group names can be between 1 and 512 characters long.
+ * - Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html}
+ */
 export type LogsLogGroup = ResourceDefinitionWithAttributes<"AWS::Logs::LogGroup", LogsLogGroupProps, LogsLogGroupAttribs>;
 /**
  * The `AWS::Logs::LogGroup` resource specifies a log group. A log group defines common properties for log streams, such as their retention and access control rules. Each log stream must belong to one log group.
@@ -8,12 +18,14 @@ export type LogsLogGroup = ResourceDefinitionWithAttributes<"AWS::Logs::LogGroup
  * - Log group names must be unique within a Region for an AWS account.
  * - Log group names can be between 1 and 512 characters long.
  * - Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html}
  */
 export type LogsLogGroupProps = {
     /**
      * Creates a data protection policy and assigns it to the log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data. When a user who does not have permission to view masked data views a log event that includes masked data, the sensitive data is replaced by asterisks.
      *
      * For more information, including a list of types of data that can be audited and masked, see [Protect sensitive log data with masking](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-dataprotectionpolicy}
      */
     DataProtectionPolicy?: Record<string, unknown> | undefined;
     /**
@@ -22,6 +34,7 @@ export type LogsLogGroupProps = {
      * You can use field index policies to create *field indexes* on fields found in log events in the log group. Creating field indexes lowers the costs for CloudWatch Logs Insights queries that reference those field indexes, because these queries attempt to skip the processing of log events that are known to not match the indexed field. Good fields to index are fields that you often need to query for and fields that have high cardinality of values Common examples of indexes include request ID, session ID, userID, and instance IDs. For more information, see [Create field indexes to improve query performance and reduce costs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-Field-Indexing.html) .
      *
      * Currently, this array supports only one field index policy object.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-fieldindexpolicies}
      */
     FieldIndexPolicies?: Record<string, unknown>[] | undefined;
     /**
@@ -34,6 +47,7 @@ export type LogsLogGroupProps = {
      * Log group data is always encrypted in CloudWatch Logs . If you omit this key, the encryption does not use AWS KMS . For more information, see [Encrypt log data in CloudWatch Logs using AWS Key Management Service](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/encrypt-log-data-kms.html)
      * @maxLength 256
      * @pattern ^arn:[a-z0-9-]+:kms:[a-z0-9-]+:\d{12}:(key|alias)/.+\Z
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-kmskeyid}
      */
     KmsKeyId?: string | undefined;
     /**
@@ -44,6 +58,7 @@ export type LogsLogGroupProps = {
      *
      * For details about the features supported by each class, see [Log classes](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html)
      * @default "STANDARD"
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-loggroupclass}
      */
     LogGroupClass?: "STANDARD" | "INFREQUENT_ACCESS" | "DELIVERY" | undefined;
     /**
@@ -51,24 +66,31 @@ export type LogsLogGroupProps = {
      * @minLength 1
      * @maxLength 512
      * @pattern ^[.\-_/#A-Za-z0-9]{1,512}\Z
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-loggroupname}
      */
     LogGroupName?: string | undefined;
     /**
      * The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, and 3653.
      *
      * To set a log group so that its log events do not expire, use [DeleteRetentionPolicy](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-retentionindays}
      */
     RetentionInDays?: 1 | 3 | 5 | 7 | 14 | 30 | 60 | 90 | 120 | 150 | 180 | 365 | 400 | 545 | 731 | 1096 | 1827 | 2192 | 2557 | 2922 | 3288 | 3653 | undefined;
     /**
      * An array of key-value pairs to apply to the log group.
      *
      * 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-logs-loggroup.html#cfn-logs-loggroup-tags}
      */
     Tags?: Tag[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#aws-resource-logs-loggroup-return-values}
+ */
 export type LogsLogGroupAttribs = {
     /**
      * The ARN of the log group, such as `arn:aws:logs:us-west-1:123456789012:log-group:/mystack-testgroup-12ABC1AB12A1:*`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-arn}
      */
     Arn: string;
 };

package/out/exports/resources.generated/aws-logs-logstream.d.ts

@@ -1,4 +1,16 @@
 import type { ResourceDefinition } from "../main.ts";
+/**
+ * The `AWS::Logs::LogStream` resource specifies an Amazon CloudWatch Logs log stream in a specific log group. A log stream represents the sequence of events coming from an application instance or resource that you are monitoring.
+ *
+ * There is no limit on the number of log streams that you can create for a log group.
+ *
+ * You must use the following guidelines when naming a log stream:
+ *
+ * - Log stream names must be unique within the log group.
+ * - Log stream names can be between 1 and 512 characters long.
+ * - The ':' (colon) and '*' (asterisk) characters are not allowed.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html}
+ */
 export type LogsLogStream = ResourceDefinition<"AWS::Logs::LogStream", LogsLogStreamProps>;
 /**
  * The `AWS::Logs::LogStream` resource specifies an Amazon CloudWatch Logs log stream in a specific log group. A log stream represents the sequence of events coming from an application instance or resource that you are monitoring.
@@ -10,14 +22,17 @@ export type LogsLogStream = ResourceDefinition<"AWS::Logs::LogStream", LogsLogSt
  * - Log stream names must be unique within the log group.
  * - Log stream names can be between 1 and 512 characters long.
  * - The ':' (colon) and '*' (asterisk) characters are not allowed.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html}
  */
 export type LogsLogStreamProps = {
     /**
      * The name of the log group where the log stream is created.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html#cfn-logs-logstream-loggroupname}
      */
     LogGroupName: string;
     /**
      * The name of the log stream. The name must be unique within the log group.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html#cfn-logs-logstream-logstreamname}
      */
     LogStreamName?: string | undefined;
 };

package/out/exports/resources.generated/aws-logs-metricfilter.d.ts

@@ -1,15 +1,23 @@
 import type { ResourceDefinition } from "../main.ts";
+/**
+ * The `AWS::Logs::MetricFilter` resource specifies a metric filter that describes how CloudWatch Logs extracts information from logs and transforms it into Amazon CloudWatch metrics. If you have multiple metric filters that are associated with a log group, all the filters are applied to the log streams in that group.
+ *
+ * The maximum number of metric filters that can be associated with a log group is 100.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html}
+ */
 export type LogsMetricFilter = ResourceDefinition<"AWS::Logs::MetricFilter", LogsMetricFilterProps>;
 /**
  * The `AWS::Logs::MetricFilter` resource specifies a metric filter that describes how CloudWatch Logs extracts information from logs and transforms it into Amazon CloudWatch metrics. If you have multiple metric filters that are associated with a log group, all the filters are applied to the log streams in that group.
  *
  * The maximum number of metric filters that can be associated with a log group is 100.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html}
  */
 export type LogsMetricFilterProps = {
     /**
      * This parameter is valid only for log groups that have an active log transformer. For more information about log transformers, see [PutTransformer](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutTransformer.html) .
      *
      * If this value is `true` , the metric filter is applied on the transformed version of the log events instead of the original ingested log events.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-applyontransformedlogs}
      */
     ApplyOnTransformedLogs?: boolean | undefined;
     /**
@@ -17,11 +25,13 @@ export type LogsMetricFilterProps = {
      * @minLength 1
      * @maxLength 512
      * @pattern ^[^:*]{1,512}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-filtername}
      */
     FilterName?: string | undefined;
     /**
      * A filter pattern for extracting metric data out of ingested log events. For more information, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html) .
      * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-filterpattern}
      */
     FilterPattern: string;
     /**
@@ -29,10 +39,12 @@ export type LogsMetricFilterProps = {
      * @minLength 1
      * @maxLength 512
      * @pattern ^[.\-_/#A-Za-z0-9]{1,512}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-loggroupname}
      */
     LogGroupName: string;
     /**
      * The metric transformations.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-metrictransformations}
      */
     MetricTransformations: MetricTransformation[];
 };
@@ -48,6 +60,7 @@ export type LogsMetricFilterProps = {
  * > To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.
  * >
  * > You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see [Creating a Billing Alarm to Monitor Your Estimated AWS Charges](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-dimension.html}
  */
 export type Dimension = {
     /**
@@ -56,21 +69,25 @@ export type Dimension = {
      * Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:).
      * @minLength 1
      * @maxLength 255
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-dimension.html#cfn-logs-metricfilter-dimension-key}
      */
     Key: string;
     /**
      * The log event field that will contain the value for this dimension. This dimension will only be published for a metric if the value is found in the log event. For example, `$.eventType` for JSON log events, or `$server` for space-delimited log events.
      * @minLength 1
      * @maxLength 255
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-dimension.html#cfn-logs-metricfilter-dimension-value}
      */
     Value: string;
 };
 /**
  * `MetricTransformation` is a property of the `AWS::Logs::MetricFilter` resource that describes how to transform log streams into a CloudWatch metric.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html}
  */
 export type MetricTransformation = {
     /**
      * (Optional) The value to emit when a filter pattern does not match a log event. This value can be null.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html#cfn-logs-metricfilter-metrictransformation-defaultvalue}
      */
     DefaultValue?: number | undefined;
     /**
@@ -81,6 +98,7 @@ export type MetricTransformation = {
      * > CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges.
      * >
      * > You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see [Creating a Billing Alarm to Monitor Your Estimated AWS Charges](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html#cfn-logs-metricfilter-metrictransformation-dimensions}
      */
     Dimensions?: Dimension[] | undefined;
     /**
@@ -88,6 +106,7 @@ export type MetricTransformation = {
      * @minLength 1
      * @maxLength 255
      * @pattern ^((?![:*$])[\x00-\x7F]){1,255}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html#cfn-logs-metricfilter-metrictransformation-metricname}
      */
     MetricName: string;
     /**
@@ -95,6 +114,7 @@ export type MetricTransformation = {
      * @minLength 1
      * @maxLength 256
      * @pattern ^[0-9a-zA-Z\.\-_\/#]{1,256}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html#cfn-logs-metricfilter-metrictransformation-metricnamespace}
      */
     MetricNamespace: string;
     /**
@@ -102,10 +122,12 @@ export type MetricTransformation = {
      * @minLength 1
      * @maxLength 100
      * @pattern .{1,100}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html#cfn-logs-metricfilter-metrictransformation-metricvalue}
      */
     MetricValue: string;
     /**
      * The unit to assign to the metric. If you omit this, the unit is set as `None` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html#cfn-logs-metricfilter-metrictransformation-unit}
      */
     Unit?: "Seconds" | "Microseconds" | "Milliseconds" | "Bytes" | "Kilobytes" | "Megabytes" | "Gigabytes" | "Terabytes" | "Bits" | "Kilobits" | "Megabits" | "Gigabits" | "Terabits" | "Percent" | "Count" | "Bytes/Second" | "Kilobytes/Second" | "Megabytes/Second" | "Gigabytes/Second" | "Terabytes/Second" | "Bits/Second" | "Kilobits/Second" | "Megabits/Second" | "Gigabits/Second" | "Terabits/Second" | "Count/Second" | "None" | undefined;
 };

package/out/exports/resources.generated/aws-logs-querydefinition.d.ts

@@ -1,11 +1,17 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * Creates a query definition for CloudWatch Logs Insights. For more information, see [Analyzing Log Data with CloudWatch Logs Insights](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AnalyzingLogData.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html}
+ */
 export type LogsQueryDefinition = ResourceDefinitionWithAttributes<"AWS::Logs::QueryDefinition", LogsQueryDefinitionProps, LogsQueryDefinitionAttribs>;
 /**
  * Creates a query definition for CloudWatch Logs Insights. For more information, see [Analyzing Log Data with CloudWatch Logs Insights](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AnalyzingLogData.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html}
  */
 export type LogsQueryDefinitionProps = {
     /**
      * Use this parameter if you want the query to query only certain log groups.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html#cfn-logs-querydefinition-loggroupnames}
      */
     LogGroupNames?: string[] | undefined;
     /**
@@ -14,25 +20,32 @@ export type LogsQueryDefinitionProps = {
      * > You can use the name to create a folder structure for your queries. To create a folder, use a forward slash (/) to prefix your desired query name with your desired folder name. For example, `*folder-name* / *query-name*` .
      * @minLength 1
      * @maxLength 255
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html#cfn-logs-querydefinition-name}
      */
     Name: string;
     /**
      * The query language used for this query. For more information about the query languages that CloudWatch Logs supports, see [Supported query languages](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData_Languages.html) .
      * @default "CWLI"
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html#cfn-logs-querydefinition-querylanguage}
      */
     QueryLanguage?: "CWLI" | "SQL" | "PPL" | undefined;
     /**
      * The query string to use for this query definition. For more information, see [CloudWatch Logs Insights Query Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html) .
      * @minLength 1
      * @maxLength 10000
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html#cfn-logs-querydefinition-querystring}
      */
     QueryString: string;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html#aws-resource-logs-querydefinition-return-values}
+ */
 export type LogsQueryDefinitionAttribs = {
     /**
      * The ID of the query definition.
      * @minLength 0
      * @maxLength 256
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html#cfn-logs-querydefinition-querydefinitionid}
      */
     QueryDefinitionId: string;
 };

package/out/exports/resources.generated/aws-logs-resourcepolicy.d.ts

@@ -1,7 +1,12 @@
 import type { ResourceDefinition } from "../main.ts";
+/**
+ * Creates or updates a resource policy that allows other AWS services to put log events to this account. An account can have up to 10 resource policies per AWS Region.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-resourcepolicy.html}
+ */
 export type LogsResourcePolicy = ResourceDefinition<"AWS::Logs::ResourcePolicy", LogsResourcePolicyProps>;
 /**
  * Creates or updates a resource policy that allows other AWS services to put log events to this account. An account can have up to 10 resource policies per AWS Region.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-resourcepolicy.html}
  */
 export type LogsResourcePolicyProps = {
     /**
@@ -9,6 +14,7 @@ export type LogsResourcePolicyProps = {
      * @minLength 1
      * @maxLength 5120
      * @pattern [\u0009\u000A\u000D\u0020-\u00FF]+
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-resourcepolicy.html#cfn-logs-resourcepolicy-policydocument}
      */
     PolicyDocument: string;
     /**
@@ -16,6 +22,7 @@ export type LogsResourcePolicyProps = {
      * @minLength 1
      * @maxLength 255
      * @pattern ^([^:*\/]+\/?)*[^:*\/]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-resourcepolicy.html#cfn-logs-resourcepolicy-policyname}
      */
     PolicyName: string;
 };

package/out/exports/resources.generated/aws-logs-subscriptionfilter.d.ts

@@ -1,4 +1,15 @@
 import type { ResourceDefinition } from "../main.ts";
+/**
+ * The `AWS::Logs::SubscriptionFilter` resource specifies a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events and have them delivered to a specific destination. Currently, the supported destinations are:
+ *
+ * - An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery.
+ * - A logical destination that belongs to a different account, for cross-account delivery.
+ * - An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.
+ * - An AWS Lambda function that belongs to the same account as the subscription filter, for same-account delivery.
+ *
+ * There can be as many as two subscription filters associated with a log group.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html}
+ */
 export type LogsSubscriptionFilter = ResourceDefinition<"AWS::Logs::SubscriptionFilter", LogsSubscriptionFilterProps>;
 /**
  * The `AWS::Logs::SubscriptionFilter` resource specifies a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events and have them delivered to a specific destination. Currently, the supported destinations are:
@@ -9,36 +20,44 @@ export type LogsSubscriptionFilter = ResourceDefinition<"AWS::Logs::Subscription
  * - An AWS Lambda function that belongs to the same account as the subscription filter, for same-account delivery.
  *
  * There can be as many as two subscription filters associated with a log group.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html}
  */
 export type LogsSubscriptionFilterProps = {
     /**
      * This parameter is valid only for log groups that have an active log transformer. For more information about log transformers, see [PutTransformer](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutTransformer.html) .
      *
      * If this value is `true` , the subscription filter is applied on the transformed version of the log events instead of the original ingested log events.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-applyontransformedlogs}
      */
     ApplyOnTransformedLogs?: boolean | undefined;
     /**
      * The Amazon Resource Name (ARN) of the destination.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-destinationarn}
      */
     DestinationArn: string;
     /**
      * The method used to distribute log data to the destination, which can be either random or grouped by log stream.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-distribution}
      */
     Distribution?: "Random" | "ByLogStream" | undefined;
     /**
      * The name of the subscription filter.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-filtername}
      */
     FilterName?: string | undefined;
     /**
      * The filtering expressions that restrict what gets delivered to the destination AWS resource. For more information about the filter pattern syntax, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-filterpattern}
      */
     FilterPattern: string;
     /**
      * The log group to associate with the subscription filter. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-loggroupname}
      */
     LogGroupName: string;
     /**
      * The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-rolearn}
      */
     RoleArn?: string | undefined;
 };