@propulsionworks/cloudformation 0.1.0 → 0.1.2

package/out/exports/resources.generated/aws-cloudfront-vpcorigin.d.ts

@@ -1,65 +1,86 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * An Amazon CloudFront VPC origin.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-vpcorigin.html}
+ */
 export type CloudFrontVpcOrigin = ResourceDefinitionWithAttributes<"AWS::CloudFront::VpcOrigin", CloudFrontVpcOriginProps, CloudFrontVpcOriginAttribs>;
 /**
  * An Amazon CloudFront VPC origin.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-vpcorigin.html}
  */
 export type CloudFrontVpcOriginProps = {
     /**
      * A complex type that contains zero or more `Tag` elements.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-vpcorigin.html#cfn-cloudfront-vpcorigin-tags}
      */
     Tags?: Tag[] | undefined;
     /**
      * The VPC origin endpoint configuration.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-vpcorigin.html#cfn-cloudfront-vpcorigin-vpcoriginendpointconfig}
      */
     VpcOriginEndpointConfig: VpcOriginEndpointConfig;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-vpcorigin.html#aws-resource-cloudfront-vpcorigin-return-values}
+ */
 export type CloudFrontVpcOriginAttribs = {
     /**
      * The VPC origin ARN.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-vpcorigin.html#cfn-cloudfront-vpcorigin-arn}
      */
     Arn: string;
     /**
      * The VPC origin created time.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-vpcorigin.html#cfn-cloudfront-vpcorigin-createdtime}
      */
     CreatedTime: string;
     /**
      * The VPC origin ID.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-vpcorigin.html#cfn-cloudfront-vpcorigin-id}
      */
     Id: string;
     /**
      * The VPC origin last modified time.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-vpcorigin.html#cfn-cloudfront-vpcorigin-lastmodifiedtime}
      */
     LastModifiedTime: string;
     /**
      * The VPC origin status.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-vpcorigin.html#cfn-cloudfront-vpcorigin-status}
      */
     Status: string;
 };
 /**
  * An Amazon CloudFront VPC origin endpoint configuration.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-vpcorigin-vpcoriginendpointconfig.html}
  */
 export type VpcOriginEndpointConfig = {
     /**
      * The ARN of the CloudFront VPC origin endpoint configuration.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-vpcorigin-vpcoriginendpointconfig.html#cfn-cloudfront-vpcorigin-vpcoriginendpointconfig-arn}
      */
     Arn: string;
     /**
      * The HTTP port for the CloudFront VPC origin endpoint configuration. The default value is `80` .
      * @default 80
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-vpcorigin-vpcoriginendpointconfig.html#cfn-cloudfront-vpcorigin-vpcoriginendpointconfig-httpport}
      */
     HTTPPort?: number | undefined;
     /**
      * The HTTPS port of the CloudFront VPC origin endpoint configuration. The default value is `443` .
      * @default 443
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-vpcorigin-vpcoriginendpointconfig.html#cfn-cloudfront-vpcorigin-vpcoriginendpointconfig-httpsport}
      */
     HTTPSPort?: number | undefined;
     /**
      * The name of the CloudFront VPC origin endpoint configuration.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-vpcorigin-vpcoriginendpointconfig.html#cfn-cloudfront-vpcorigin-vpcoriginendpointconfig-name}
      */
     Name: string;
     /**
      * The origin protocol policy for the CloudFront VPC origin endpoint configuration.
      * @default "match-viewer"
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-vpcorigin-vpcoriginendpointconfig.html#cfn-cloudfront-vpcorigin-vpcoriginendpointconfig-originprotocolpolicy}
      */
     OriginProtocolPolicy?: string | undefined;
     /**
@@ -67,6 +88,7 @@ export type VpcOriginEndpointConfig = {
      *
      * For more information, see [Minimum Origin SSL Protocol](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginSSLProtocols) in the *Amazon CloudFront Developer Guide* .
      * @default ["TLSv1","SSLv3"]
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-vpcorigin-vpcoriginendpointconfig.html#cfn-cloudfront-vpcorigin-vpcoriginendpointconfig-originsslprotocols}
      */
     OriginSSLProtocols?: string[] | undefined;
 };

package/out/exports/resources.generated/aws-cloudtrail-channel.d.ts

@@ -1,15 +1,22 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Contains information about a returned CloudTrail channel.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-channel.html}
+ */
 export type CloudTrailChannel = ResourceDefinitionWithAttributes<"AWS::CloudTrail::Channel", CloudTrailChannelProps, CloudTrailChannelAttribs>;
 /**
  * Contains information about a returned CloudTrail channel.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-channel.html}
  */
 export type CloudTrailChannelProps = {
     /**
      * One or more event data stores to which events arriving through a channel will be logged.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-channel.html#cfn-cloudtrail-channel-destinations}
      */
     Destinations?: Destination[] | undefined;
     /**
      * The name of the channel.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-channel.html#cfn-cloudtrail-channel-name}
      */
     Name?: string | undefined;
     /**
@@ -19,21 +26,28 @@ export type CloudTrailChannelProps = {
      * @minLength 1
      * @maxLength 256
      * @pattern (.*)
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-channel.html#cfn-cloudtrail-channel-source}
      */
     Source?: string | undefined;
     /**
      * A list of tags.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-channel.html#cfn-cloudtrail-channel-tags}
      */
     Tags?: Tag[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-channel.html#aws-resource-cloudtrail-channel-return-values}
+ */
 export type CloudTrailChannelAttribs = {
     /**
      * `Ref` returns the ARN of the CloudTrail channel, such as `arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-channel.html#cfn-cloudtrail-channel-channelarn}
      */
     ChannelArn: string;
 };
 /**
  * Contains information about the destination receiving events.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-channel-destination.html}
  */
 export type Destination = {
     /**
@@ -41,10 +55,12 @@ export type Destination = {
      * @minLength 3
      * @maxLength 1024
      * @pattern (^[a-zA-Z0-9._/\-:]+$)
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-channel-destination.html#cfn-cloudtrail-channel-destination-location}
      */
     Location: string;
     /**
      * The type of destination for events arriving from a channel. For channels used for a CloudTrail Lake integration, the value is `EVENT_DATA_STORE` . For service-linked channels, the value is `AWS_SERVICE` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-channel-destination.html#cfn-cloudtrail-channel-destination-type}
      */
     Type: "EVENT_DATA_STORE";
 };

package/out/exports/resources.generated/aws-cloudtrail-dashboard.d.ts

@@ -1,4 +1,17 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Creates a custom dashboard or the Highlights dashboard.
+ *
+ * - *Custom dashboards* - Custom dashboards allow you to query events in any event data store type. You can add up to 10 widgets to a custom dashboard. You can manually refresh a custom dashboard, or you can set a refresh schedule.
+ * - *Highlights dashboard* - You can create the Highlights dashboard to see a summary of key user activities and API usage across all your event data stores. CloudTrail Lake manages the Highlights dashboard and refreshes the dashboard every 6 hours. To create the Highlights dashboard, you must set and enable a refresh schedule.
+ *
+ * CloudTrail runs queries to populate the dashboard's widgets during a manual or scheduled refresh. CloudTrail must be granted permissions to run the `StartQuery` operation on your behalf. To provide permissions, run the `PutResourcePolicy` operation to attach a resource-based policy to each event data store. For more information, see [Example: Allow CloudTrail to run queries to populate a dashboard](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/security_iam_resource-based-policy-examples.html#security_iam_resource-based-policy-examples-eds-dashboard) in the *AWS CloudTrail User Guide* .
+ *
+ * To set a refresh schedule, CloudTrail must be granted permissions to run the `StartDashboardRefresh` operation to refresh the dashboard on your behalf. To provide permissions, run the `PutResourcePolicy` operation to attach a resource-based policy to the dashboard. For more information, see [Resource-based policy example for a dashboard](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/security_iam_resource-based-policy-examples.html#security_iam_resource-based-policy-examples-dashboards) in the *AWS CloudTrail User Guide* .
+ *
+ * For more information about dashboards, see [CloudTrail Lake dashboards](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/lake-dashboard.html) in the *AWS CloudTrail User Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-dashboard.html}
+ */
 export type CloudTrailDashboard = ResourceDefinitionWithAttributes<"AWS::CloudTrail::Dashboard", CloudTrailDashboardProps, CloudTrailDashboardAttribs>;
 /**
  * Creates a custom dashboard or the Highlights dashboard.
@@ -11,6 +24,7 @@ export type CloudTrailDashboard = ResourceDefinitionWithAttributes<"AWS::CloudTr
  * To set a refresh schedule, CloudTrail must be granted permissions to run the `StartDashboardRefresh` operation to refresh the dashboard on your behalf. To provide permissions, run the `PutResourcePolicy` operation to attach a resource-based policy to the dashboard. For more information, see [Resource-based policy example for a dashboard](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/security_iam_resource-based-policy-examples.html#security_iam_resource-based-policy-examples-dashboards) in the *AWS CloudTrail User Guide* .
  *
  * For more information about dashboards, see [CloudTrail Lake dashboards](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/lake-dashboard.html) in the *AWS CloudTrail User Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-dashboard.html}
  */
 export type CloudTrailDashboardProps = {
     /**
@@ -18,56 +32,71 @@ export type CloudTrailDashboardProps = {
      *
      * To create the Highlights dashboard, the name must be `AWSCloudTrail-Highlights` .
      * @pattern ^[a-zA-Z0-9_\-]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-dashboard.html#cfn-cloudtrail-dashboard-name}
      */
     Name?: string | undefined;
     /**
      * The schedule for a dashboard refresh.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-dashboard.html#cfn-cloudtrail-dashboard-refreshschedule}
      */
     RefreshSchedule?: RefreshSchedule | undefined;
     /**
      * A list of tags.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-dashboard.html#cfn-cloudtrail-dashboard-tags}
      */
     Tags?: Tag[] | undefined;
     /**
      * Specifies whether termination protection is enabled for the dashboard. If termination protection is enabled, you cannot delete the dashboard until termination protection is disabled.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-dashboard.html#cfn-cloudtrail-dashboard-terminationprotectionenabled}
      */
     TerminationProtectionEnabled?: boolean | undefined;
     /**
      * An array of widgets for a custom dashboard. A custom dashboard can have a maximum of ten widgets.
      *
      * You do not need to specify widgets for the Highlights dashboard.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-dashboard.html#cfn-cloudtrail-dashboard-widgets}
      */
     Widgets?: Widget[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-dashboard.html#aws-resource-cloudtrail-dashboard-return-values}
+ */
 export type CloudTrailDashboardAttribs = {
     /**
      * The timestamp that shows when the dashboard was created.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-dashboard.html#cfn-cloudtrail-dashboard-createdtimestamp}
      */
     CreatedTimestamp: string;
     /**
      * The ARN for the dashboard.
      * @pattern ^[a-zA-Z0-9._/\-:]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-dashboard.html#cfn-cloudtrail-dashboard-dashboardarn}
      */
     DashboardArn: string;
     /**
      * The status of the dashboard.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-dashboard.html#cfn-cloudtrail-dashboard-status}
      */
     Status: "CREATING" | "CREATED" | "UPDATING" | "UPDATED" | "DELETING";
     /**
      * The type of dashboard.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-dashboard.html#cfn-cloudtrail-dashboard-type}
      */
     Type: "MANAGED" | "CUSTOM";
     /**
      * The timestamp that shows when the dashboard was updated.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-dashboard.html#cfn-cloudtrail-dashboard-updatedtimestamp}
      */
     UpdatedTimestamp: string;
 };
 /**
  * The schedule for a dashboard refresh.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-dashboard-refreshschedule.html}
  */
 export type RefreshSchedule = {
     /**
      * The frequency at which you want the dashboard refreshed.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-dashboard-refreshschedule.html#cfn-cloudtrail-dashboard-refreshschedule-frequency}
      */
     Frequency?: {
         /**
@@ -81,20 +110,24 @@ export type RefreshSchedule = {
     } | undefined;
     /**
      * Specifies whether the refresh schedule is enabled. Set the value to `ENABLED` to enable the refresh schedule, or to `DISABLED` to turn off the refresh schedule.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-dashboard-refreshschedule.html#cfn-cloudtrail-dashboard-refreshschedule-status}
      */
     Status?: "ENABLED" | "DISABLED" | undefined;
     /**
      * The time of day in UTC to run the schedule; for hourly only refer to minutes; default is 00:00.
      * @pattern ^[0-9]{2}:[0-9]{2}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-dashboard-refreshschedule.html#cfn-cloudtrail-dashboard-refreshschedule-timeofday}
      */
     TimeOfDay?: string | undefined;
 };
 /**
  * Contains information about a widget on a CloudTrail Lake dashboard.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-dashboard-widget.html}
  */
 export type Widget = {
     /**
      * The optional query parameters. The following query parameters are valid: `$StartTime$` , `$EndTime$` , and `$Period$` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-dashboard-widget.html#cfn-cloudtrail-dashboard-widget-queryparameters}
      */
     QueryParameters?: string[] | undefined;
     /**
@@ -104,10 +137,12 @@ export type Widget = {
      * @minLength 1
      * @maxLength 10000
      * @pattern (?s).*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-dashboard-widget.html#cfn-cloudtrail-dashboard-widget-querystatement}
      */
     QueryStatement: string;
     /**
      * The view properties for the widget. For more information about view properties, see [View properties for widgets](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/lake-widget-properties.html) in the *AWS CloudTrail User Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-dashboard-widget.html#cfn-cloudtrail-dashboard-widget-viewproperties}
      */
     ViewProperties?: Record<string, string> | undefined;
 };

package/out/exports/resources.generated/aws-cloudtrail-eventdatastore.d.ts

@@ -1,7 +1,12 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Creates a new event data store.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html}
+ */
 export type CloudTrailEventDataStore = ResourceDefinitionWithAttributes<"AWS::CloudTrail::EventDataStore", CloudTrailEventDataStoreProps, CloudTrailEventDataStoreAttribs>;
 /**
  * Creates a new event data store.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html}
  */
 export type CloudTrailEventDataStoreProps = {
     /**
@@ -12,6 +17,7 @@ export type CloudTrailEventDataStoreProps = {
      * For more information about how to use advanced event selectors to include AWS Config configuration items in your event data store, see [Create an event data store for AWS Config configuration items](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/lake-eds-cli.html#lake-cli-create-eds-config) in the CloudTrail User Guide.
      *
      * For more information about how to use advanced event selectors to include events outside of AWS events in your event data store, see [Create an integration to log events from outside AWS](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/lake-integrations-cli.html#lake-cli-create-integration) in the CloudTrail User Guide.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-advancedeventselectors}
      */
     AdvancedEventSelectors?: AdvancedEventSelector[] | undefined;
     /**
@@ -25,20 +31,24 @@ export type CloudTrailEventDataStoreProps = {
      * The default value is `EXTENDABLE_RETENTION_PRICING` .
      *
      * For more information about CloudTrail pricing, see [AWS CloudTrail Pricing](https://docs.aws.amazon.com/cloudtrail/pricing/) and [Managing CloudTrail Lake costs](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-lake-manage-costs.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-billingmode}
      */
     BillingMode?: string | undefined;
     /**
      * Indicates if [Lake query federation](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-federation.html) is enabled. By default, Lake query federation is disabled. You cannot delete an event data store if Lake query federation is enabled.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-federationenabled}
      */
     FederationEnabled?: boolean | undefined;
     /**
      * If Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store.
      *
      * The federation role must exist in your account and provide the [required minimum permissions](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-federation.html#query-federation-permissions-role) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-federationrolearn}
      */
     FederationRoleArn?: string | undefined;
     /**
      * Specifies whether the event data store should start ingesting live events. The default is true.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-ingestionenabled}
      */
     IngestionEnabled?: boolean | undefined;
     /**
@@ -47,10 +57,12 @@ export type CloudTrailEventDataStoreProps = {
      * The `ApiCallRateInsight` Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume.
      *
      * The `ApiErrorRateInsight` Insights type analyzes management API calls that result in error codes. The error is shown if the API call is unsuccessful.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-insightselectors}
      */
     InsightSelectors?: InsightSelector[] | undefined;
     /**
      * The ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events. For more information, see [Create an event data store for CloudTrail Insights events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store-insights.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-insightsdestination}
      */
     InsightsDestination?: string | undefined;
     /**
@@ -66,18 +78,22 @@ export type CloudTrailEventDataStoreProps = {
      * - `arn:aws:kms:us-east-2:123456789012:alias/MyAliasName`
      * - `arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012`
      * - `12345678-1234-1234-1234-123456789012`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-kmskeyid}
      */
     KmsKeyId?: string | undefined;
     /**
      * Specifies whether the event data store includes events from all Regions, or only from the Region in which the event data store is created.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-multiregionenabled}
      */
     MultiRegionEnabled?: boolean | undefined;
     /**
      * The name of the event data store.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-name}
      */
     Name?: string | undefined;
     /**
      * Specifies whether an event data store collects events logged for an organization in AWS Organizations .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-organizationenabled}
      */
     OrganizationEnabled?: boolean | undefined;
     /**
@@ -86,32 +102,42 @@ export type CloudTrailEventDataStoreProps = {
      * CloudTrail Lake determines whether to retain an event by checking if the `eventTime` of the event is within the specified retention period. For example, if you set a retention period of 90 days, CloudTrail will remove events when the `eventTime` is older than 90 days.
      *
      * > If you plan to copy trail events to this event data store, we recommend that you consider both the age of the events that you want to copy as well as how long you want to keep the copied events in your event data store. For example, if you copy trail events that are 5 years old and specify a retention period of 7 years, the event data store will retain those events for two years.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-retentionperiod}
      */
     RetentionPeriod?: number | undefined;
     /**
      * A list of tags.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-tags}
      */
     Tags?: Tag[] | undefined;
     /**
      * Specifies whether termination protection is enabled for the event data store. If termination protection is enabled, you cannot delete the event data store until termination protection is disabled.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-terminationprotectionenabled}
      */
     TerminationProtectionEnabled?: boolean | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#aws-resource-cloudtrail-eventdatastore-return-values}
+ */
 export type CloudTrailEventDataStoreAttribs = {
     /**
      * `Ref` returns the time stamp of the creation of the event data store, such as `1248496624` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-createdtimestamp}
      */
     CreatedTimestamp: string;
     /**
      * `Ref` returns the ARN of the CloudTrail event data store, such as `arn:aws:cloudtrail:us-east-1:12345678910:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-eventdatastorearn}
      */
     EventDataStoreArn: string;
     /**
      * `Ref` returns the status of the event data store, such as `ENABLED` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-status}
      */
     Status: string;
     /**
      * `Ref` returns the time stamp that updates were made to an event data store, such as `1598296624` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-updatedtimestamp}
      */
     UpdatedTimestamp: string;
 };
@@ -154,29 +180,35 @@ export type CloudTrailEventDataStoreAttribs = {
  * - `vpcEndpointId`
  *
  * > For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the only supported field is `eventCategory` .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedeventselector.html}
  */
 export type AdvancedEventSelector = {
     /**
      * Contains all selector statements in an advanced event selector.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedeventselector.html#cfn-cloudtrail-eventdatastore-advancedeventselector-fieldselectors}
      */
     FieldSelectors: AdvancedFieldSelector[];
     /**
      * An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".
      * @minLength 1
      * @maxLength 1000
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedeventselector.html#cfn-cloudtrail-eventdatastore-advancedeventselector-name}
      */
     Name?: string | undefined;
 };
 /**
  * A single selector statement in an advanced event selector.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html}
  */
 export type AdvancedFieldSelector = {
     /**
      * An operator that includes events that match the last few characters of the event record field specified as the value of `Field` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-endswith}
      */
     EndsWith?: string[] | undefined;
     /**
      * An operator that includes events that match the exact value of the event record field specified as the value of `Field` . This is the only valid operator that you can use with the `readOnly` , `eventCategory` , and `resources.type` fields.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-equals}
      */
     Equals?: string[] | undefined;
     /**
@@ -233,27 +265,33 @@ export type AdvancedFieldSelector = {
      * @minLength 1
      * @maxLength 1000
      * @pattern ([\w|\d|\.|_]+)
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-field}
      */
     Field: string;
     /**
      * An operator that excludes events that match the last few characters of the event record field specified as the value of `Field` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-notendswith}
      */
     NotEndsWith?: string[] | undefined;
     /**
      * An operator that excludes events that match the exact value of the event record field specified as the value of `Field` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-notequals}
      */
     NotEquals?: string[] | undefined;
     /**
      * An operator that excludes events that match the first few characters of the event record field specified as the value of `Field` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-notstartswith}
      */
     NotStartsWith?: string[] | undefined;
     /**
      * An operator that includes events that match the first few characters of the event record field specified as the value of `Field` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-startswith}
      */
     StartsWith?: string[] | undefined;
 };
 /**
  * A JSON string that contains a list of Insights types that are logged on an event data store.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-insightselector.html}
  */
 export type InsightSelector = {
     /**
@@ -262,6 +300,7 @@ export type InsightSelector = {
      * The `ApiCallRateInsight` Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume.
      *
      * The `ApiErrorRateInsight` Insights type analyzes management API calls that result in error codes. The error is shown if the API call is unsuccessful.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-insightselector.html#cfn-cloudtrail-eventdatastore-insightselector-insighttype}
      */
     InsightType?: string | undefined;
 };

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

@@ -1,7 +1,12 @@
 import type { ResourceDefinition, TemplatePolicyDocument } from "../main.ts";
+/**
+ * Attaches a resource-based permission policy to a CloudTrail event data store, dashboard, or channel. For more information about resource-based policies, see [CloudTrail resource-based policy examples](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/security_iam_resource-based-policy-examples.html) in the *CloudTrail User Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-resourcepolicy.html}
+ */
 export type CloudTrailResourcePolicy = ResourceDefinition<"AWS::CloudTrail::ResourcePolicy", CloudTrailResourcePolicyProps>;
 /**
  * Attaches a resource-based permission policy to a CloudTrail event data store, dashboard, or channel. For more information about resource-based policies, see [CloudTrail resource-based policy examples](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/security_iam_resource-based-policy-examples.html) in the *CloudTrail User Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-resourcepolicy.html}
  */
 export type CloudTrailResourcePolicyProps = {
     /**
@@ -12,13 +17,14 @@ export type CloudTrailResourcePolicyProps = {
      * Example dashboard ARN format: `arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash`
      *
      * Example channel ARN format: `arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-resourcepolicy.html#cfn-cloudtrail-resourcepolicy-resourcearn}
      */
     ResourceArn: string;
     /**
      * A JSON-formatted string for an AWS resource-based policy.
      *
      * For example resource-based policies, see [CloudTrail resource-based policy examples](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/security_iam_resource-based-policy-examples.html) in the *CloudTrail User Guide* .
-     * @policy
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-resourcepolicy.html#cfn-cloudtrail-resourcepolicy-resourcepolicy}
      */
     ResourcePolicy: TemplatePolicyDocument;
 };