@propulsionworks/cloudformation 0.1.0 → 0.1.2

package/out/exports/resources.generated/aws-internetmonitor-monitor.d.ts

@@ -1,4 +1,12 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * The `AWS::InternetMonitor::Monitor` resource is an Internet Monitor resource type that contains information about how you create a monitor in Amazon CloudWatch Internet Monitor. A monitor in Internet Monitor provides visibility into performance and availability between your applications hosted on AWS and your end users, using a traffic profile that it creates based on the application resources that you add: Virtual Private Clouds (VPCs), Amazon CloudFront distributions, or WorkSpaces directories.
+ *
+ * Internet Monitor also alerts you to internet issues that impact your application in the city-networks (geographies and networks) where your end users use it. With Internet Monitor, you can quickly pinpoint the locations and providers that are affected, so that you can address the issue.
+ *
+ * For more information, see [Using Amazon CloudWatch Internet Monitor](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-InternetMonitor.html) in the *Amazon CloudWatch User Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html}
+ */
 export type InternetMonitorMonitor = ResourceDefinitionWithAttributes<"AWS::InternetMonitor::Monitor", InternetMonitorMonitorProps, InternetMonitorMonitorAttribs>;
 /**
  * The `AWS::InternetMonitor::Monitor` resource is an Internet Monitor resource type that contains information about how you create a monitor in Amazon CloudWatch Internet Monitor. A monitor in Internet Monitor provides visibility into performance and availability between your applications hosted on AWS and your end users, using a traffic profile that it creates based on the application resources that you add: Virtual Private Clouds (VPCs), Amazon CloudFront distributions, or WorkSpaces directories.
@@ -6,6 +14,7 @@ export type InternetMonitorMonitor = ResourceDefinitionWithAttributes<"AWS::Inte
  * Internet Monitor also alerts you to internet issues that impact your application in the city-networks (geographies and networks) where your end users use it. With Internet Monitor, you can quickly pinpoint the locations and providers that are affected, so that you can address the issue.
  *
  * For more information, see [Using Amazon CloudWatch Internet Monitor](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-InternetMonitor.html) in the *Amazon CloudWatch User Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html}
  */
 export type InternetMonitorMonitorProps = {
     /**
@@ -20,14 +29,17 @@ export type InternetMonitorMonitorProps = {
      * For local thresholds, you also set a minimum percentage of overall traffic that is impacted by an issue before Internet Monitor creates an event. In addition, you can disable local thresholds, for performance scores, availability scores, or both.
      *
      * For more information, see [Change health event thresholds](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview) in the Internet Monitor section of the *CloudWatch User Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-healtheventsconfig}
      */
     HealthEventsConfig?: HealthEventsConfig | undefined;
     /**
      * A boolean option that you can set to `TRUE` to include monitors for linked accounts in a list of monitors, when you've set up cross-account sharing in Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see [Internet Monitor cross-account observability](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cwim-cross-account.html) in the Amazon CloudWatch User Guide.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-includelinkedaccounts}
      */
     IncludeLinkedAccounts?: boolean | undefined;
     /**
      * Publish internet measurements for a monitor for all city-networks (up to the 500,000 service limit) to another location, such as an Amazon S3 bucket. Measurements are also published to Amazon CloudWatch Logs for the first 500 (by traffic volume) city-networks (client locations and ASNs, typically internet service providers or ISPs).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-internetmeasurementslogdelivery}
      */
     InternetMeasurementsLogDelivery?: InternetMeasurementsLogDelivery | undefined;
     /**
@@ -35,6 +47,7 @@ export type InternetMonitorMonitorProps = {
      * @minLength 12
      * @maxLength 12
      * @pattern ^(\d{12})$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-linkedaccountid}
      */
     LinkedAccountId?: string | undefined;
     /**
@@ -43,6 +56,7 @@ export type InternetMonitorMonitorProps = {
      * For more information, see [Choosing a city-network maximum value](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html) in *Using Amazon CloudWatch Internet Monitor* .
      * @min 1
      * @max 500000
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-maxcitynetworkstomonitor}
      */
     MaxCityNetworksToMonitor?: number | undefined;
     /**
@@ -50,12 +64,14 @@ export type InternetMonitorMonitorProps = {
      * @minLength 1
      * @maxLength 255
      * @pattern ^[a-zA-Z0-9_.-]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-monitorname}
      */
     MonitorName: string;
     /**
      * The resources that have been added for the monitor, listed by their Amazon Resource Names (ARNs). Use this option to add or remove resources when making an update.
      *
      * > Be aware that if you include content in the `Resources` field when you update a monitor, the `ResourcesToAdd` and `ResourcesToRemove` fields must be empty.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-resources}
      */
     Resources?: string[] | undefined;
     /**
@@ -66,36 +82,46 @@ export type InternetMonitorMonitorProps = {
      * If you add only VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.
      *
      * > You can specify this field for a monitor update only if the `Resources` field is empty.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-resourcestoadd}
      */
     ResourcesToAdd?: string[] | undefined;
     /**
      * The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs)
      *
      * > You can specify this field for a monitor update only if the `Resources` field is empty.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-resourcestoremove}
      */
     ResourcesToRemove?: string[] | undefined;
     /**
      * The status of a monitor. The accepted values that you can specify for `Status` are `ACTIVE` and `INACTIVE` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-status}
      */
     Status?: MonitorConfigState | undefined;
     /**
      * The tags for a monitor, listed as a set of *key:value* pairs.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-tags}
      */
     Tags?: Tag[] | undefined;
     /**
      * The percentage of the internet-facing traffic for your application that you want to monitor. You can also, optionally, set a limit for the number of city-networks (client locations and ASNs, typically internet service providers) that Internet Monitor will monitor traffic for. The city-networks maximum limit caps the number of city-networks that Internet Monitor monitors for your application, regardless of the percentage of traffic that you choose to monitor.
      * @min 1
      * @max 100
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-trafficpercentagetomonitor}
      */
     TrafficPercentageToMonitor?: number | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#aws-resource-internetmonitor-monitor-return-values}
+ */
 export type InternetMonitorMonitorAttribs = {
     /**
      * The time when the monitor was created.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-createdat}
      */
     CreatedAt: string;
     /**
      * The last time that the monitor was modified.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-modifiedat}
      */
     ModifiedAt: string;
     /**
@@ -103,14 +129,17 @@ export type InternetMonitorMonitorAttribs = {
      * @minLength 20
      * @maxLength 512
      * @pattern ^arn:.*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-monitorarn}
      */
     MonitorArn: string;
     /**
      * The health of data processing for the monitor. For more information, see `ProcessingStatus` under [MonitorListMember](https://docs.aws.amazon.com/internet-monitor/latest/api/API_MonitorListMember.html) in the *Amazon CloudWatch Internet Monitor API Reference* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-processingstatus}
      */
     ProcessingStatus: MonitorProcessingStatusCode;
     /**
      * Additional information about the health of the data processing for the monitor.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-processingstatusinfo}
      */
     ProcessingStatusInfo: string;
 };
@@ -118,35 +147,42 @@ export type InternetMonitorMonitorAttribs = {
  * Define the health event threshold percentages for the performance score and availability score for your application's monitor. Amazon CloudWatch Internet Monitor creates a health event when there's an internet issue that affects your application end users where a health score percentage is at or below a set threshold.
  *
  * If you don't set a health event threshold, the default value is 95%.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-healtheventsconfig.html}
  */
 export type HealthEventsConfig = {
     /**
      * The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local availability issue.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-healtheventsconfig.html#cfn-internetmonitor-monitor-healtheventsconfig-availabilitylocalhealtheventsconfig}
      */
     AvailabilityLocalHealthEventsConfig?: LocalHealthEventsConfig | undefined;
     /**
      * The health event threshold percentage set for availability scores. When the overall availability score is at or below this percentage, Internet Monitor creates a health event.
      * @min 0
      * @max 100
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-healtheventsconfig.html#cfn-internetmonitor-monitor-healtheventsconfig-availabilityscorethreshold}
      */
     AvailabilityScoreThreshold?: number | undefined;
     /**
      * The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance issue.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-healtheventsconfig.html#cfn-internetmonitor-monitor-healtheventsconfig-performancelocalhealtheventsconfig}
      */
     PerformanceLocalHealthEventsConfig?: LocalHealthEventsConfig | undefined;
     /**
      * The health event threshold percentage set for performance scores. When the overall performance score is at or below this percentage, Internet Monitor creates a health event.
      * @min 0
      * @max 100
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-healtheventsconfig.html#cfn-internetmonitor-monitor-healtheventsconfig-performancescorethreshold}
      */
     PerformanceScoreThreshold?: number | undefined;
 };
 /**
  * Publish internet measurements to an Amazon S3 bucket in addition to CloudWatch Logs.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-internetmeasurementslogdelivery.html}
  */
 export type InternetMeasurementsLogDelivery = {
     /**
      * The configuration for publishing Amazon CloudWatch Internet Monitor internet measurements to Amazon S3.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-internetmeasurementslogdelivery.html#cfn-internetmonitor-monitor-internetmeasurementslogdelivery-s3config}
      */
     S3Config?: S3Config | undefined;
 };
@@ -158,12 +194,14 @@ export type InternetMeasurementsLogDelivery = {
  * If you don't set a local health event threshold, the default value is 60%.
  *
  * For more information, see [Change health event thresholds](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview) in the Internet Monitor section of the *Amazon CloudWatch User Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-localhealtheventsconfig.html}
  */
 export type LocalHealthEventsConfig = {
     /**
      * The health event threshold percentage set for a local health score.
      * @min 0
      * @max 100
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-localhealtheventsconfig.html#cfn-internetmonitor-monitor-localhealtheventsconfig-healthscorethreshold}
      */
     HealthScoreThreshold?: number | undefined;
     /**
@@ -172,32 +210,44 @@ export type LocalHealthEventsConfig = {
      * If you don't set a minimum traffic impact threshold, the default value is 0.01%.
      * @min 0
      * @max 100
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-localhealtheventsconfig.html#cfn-internetmonitor-monitor-localhealtheventsconfig-mintrafficimpact}
      */
     MinTrafficImpact?: number | undefined;
     /**
      * The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score. The status can be `ENABLED` or `DISABLED` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-localhealtheventsconfig.html#cfn-internetmonitor-monitor-localhealtheventsconfig-status}
      */
     Status?: "ENABLED" | "DISABLED" | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-monitorconfigstate.html}
+ */
 export type MonitorConfigState = "PENDING" | "ACTIVE" | "INACTIVE" | "ERROR";
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-monitorprocessingstatuscode.html}
+ */
 export type MonitorProcessingStatusCode = "OK" | "INACTIVE" | "COLLECTING_DATA" | "INSUFFICIENT_DATA" | "FAULT_SERVICE" | "FAULT_ACCESS_CLOUDWATCH";
 /**
  * The configuration for publishing Amazon CloudWatch Internet Monitor internet measurements to Amazon S3. The configuration includes the bucket name and (optionally) bucket prefix for the S3 bucket to store the measurements, and the delivery status. The delivery status is `ENABLED` if you choose to deliver internet measurements to S3 logs, and `DISABLED` otherwise.
  *
  * The measurements are also published to Amazon CloudWatch Logs.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-s3config.html}
  */
 export type S3Config = {
     /**
      * The Amazon S3 bucket name for internet measurements publishing.
      * @minLength 3
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-s3config.html#cfn-internetmonitor-monitor-s3config-bucketname}
      */
     BucketName?: string | undefined;
     /**
      * An optional Amazon S3 bucket prefix for internet measurements publishing.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-s3config.html#cfn-internetmonitor-monitor-s3config-bucketprefix}
      */
     BucketPrefix?: string | undefined;
     /**
      * The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket. The delivery status is `ENABLED` if you choose to deliver internet measurements to an S3 bucket, and `DISABLED` otherwise.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-s3config.html#cfn-internetmonitor-monitor-s3config-logdeliverystatus}
      */
     LogDeliveryStatus?: "ENABLED" | "DISABLED" | undefined;
 };

package/out/exports/resources.generated/aws-invoicing-invoiceunit.d.ts

@@ -1,50 +1,68 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * An invoice unit is a set of mutually exclusive account that correspond to your business entity. Invoice units allow you separate AWS account costs and configures your invoice for each business entity going forward.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-invoicing-invoiceunit.html}
+ */
 export type InvoicingInvoiceUnit = ResourceDefinitionWithAttributes<"AWS::Invoicing::InvoiceUnit", InvoicingInvoiceUnitProps, InvoicingInvoiceUnitAttribs>;
 /**
  * An invoice unit is a set of mutually exclusive account that correspond to your business entity. Invoice units allow you separate AWS account costs and configures your invoice for each business entity going forward.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-invoicing-invoiceunit.html}
  */
 export type InvoicingInvoiceUnitProps = {
     /**
      * The assigned description for an invoice unit. This information can't be modified or deleted.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-invoicing-invoiceunit.html#cfn-invoicing-invoiceunit-description}
      */
     Description?: string | undefined;
     /**
      * The account that receives invoices related to the invoice unit.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-invoicing-invoiceunit.html#cfn-invoicing-invoiceunit-invoicereceiver}
      */
     InvoiceReceiver: string;
     /**
      * A unique name that is distinctive within your AWS .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-invoicing-invoiceunit.html#cfn-invoicing-invoiceunit-name}
      */
     Name: string;
     /**
      * The tag structure that contains a tag key and value.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-invoicing-invoiceunit.html#cfn-invoicing-invoiceunit-resourcetags}
      */
     ResourceTags?: Tag[] | undefined;
     /**
      * An `InvoiceUnitRule` object used the categorize invoice units.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-invoicing-invoiceunit.html#cfn-invoicing-invoiceunit-rule}
      */
     Rule: Rule;
     /**
      * Whether the invoice unit based tax inheritance is/ should be enabled or disabled.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-invoicing-invoiceunit.html#cfn-invoicing-invoiceunit-taxinheritancedisabled}
      */
     TaxInheritanceDisabled?: boolean | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-invoicing-invoiceunit.html#aws-resource-invoicing-invoiceunit-return-values}
+ */
 export type InvoicingInvoiceUnitAttribs = {
     /**
      * The ARN to identify an invoice unit. This information can't be modified or deleted.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-invoicing-invoiceunit.html#cfn-invoicing-invoiceunit-invoiceunitarn}
      */
     InvoiceUnitArn: string;
     /**
      * The last time the invoice unit was updated. This is important to determine the version of invoice unit configuration used to create the invoices. Any invoice created after this modified time will use this invoice unit configuration.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-invoicing-invoiceunit.html#cfn-invoicing-invoiceunit-lastmodified}
      */
     LastModified: number;
 };
 /**
  * The `InvoiceUnitRule` object used to update invoice units.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-invoicing-invoiceunit-rule.html}
  */
 export type Rule = {
     /**
      * The list of `LINKED_ACCOUNT` IDs where charges are included within the invoice unit.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-invoicing-invoiceunit-rule.html#cfn-invoicing-invoiceunit-rule-linkedaccounts}
      */
     LinkedAccounts: string[];
 };

package/out/exports/resources.generated/aws-iot-accountauditconfiguration.d.ts

@@ -1,13 +1,19 @@
 import type { ResourceDefinition } from "../main.ts";
+/**
+ * Use the `AWS::IoT::AccountAuditConfiguration` resource to configure or reconfigure the Device Defender audit settings for your account. Settings include how audit notifications are sent and which audit checks are enabled or disabled. For API reference, see [UpdateAccountAuditConfiguration](https://docs.aws.amazon.com/iot/latest/apireference/API_UpdateAccountAuditConfiguration.html) and for detailed information on all available audit checks, see [Audit checks](https://docs.aws.amazon.com/iot/latest/developerguide/device-defender-audit-checks.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-accountauditconfiguration.html}
+ */
 export type IoTAccountAuditConfiguration = ResourceDefinition<"AWS::IoT::AccountAuditConfiguration", IoTAccountAuditConfigurationProps>;
 /**
  * Use the `AWS::IoT::AccountAuditConfiguration` resource to configure or reconfigure the Device Defender audit settings for your account. Settings include how audit notifications are sent and which audit checks are enabled or disabled. For API reference, see [UpdateAccountAuditConfiguration](https://docs.aws.amazon.com/iot/latest/apireference/API_UpdateAccountAuditConfiguration.html) and for detailed information on all available audit checks, see [Audit checks](https://docs.aws.amazon.com/iot/latest/developerguide/device-defender-audit-checks.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-accountauditconfiguration.html}
  */
 export type IoTAccountAuditConfigurationProps = {
     /**
      * The ID of the account. You can use the expression `!Sub "${AWS::AccountId}"` to use your account ID.
      * @minLength 12
      * @maxLength 12
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-accountauditconfiguration.html#cfn-iot-accountauditconfiguration-accountid}
      */
     AccountId: string;
     /**
@@ -20,171 +26,210 @@ export type IoTAccountAuditConfigurationProps = {
      * You can't disable a check if it's used by any scheduled audit. You must delete the check from the scheduled audit or delete the scheduled audit itself to disable the check.
      *
      * For more information on available audit checks see [AWS::IoT::AccountAuditConfiguration AuditCheckConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html)
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-accountauditconfiguration.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations}
      */
     AuditCheckConfigurations: AuditCheckConfigurations;
     /**
      * Information about the targets to which audit notifications are sent.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-accountauditconfiguration.html#cfn-iot-accountauditconfiguration-auditnotificationtargetconfigurations}
      */
     AuditNotificationTargetConfigurations?: AuditNotificationTargetConfigurations | undefined;
     /**
      * The Amazon Resource Name (ARN) of the role that grants permission to AWS IoT to access information about your devices, policies, certificates, and other items as required when performing an audit.
      * @minLength 20
      * @maxLength 2048
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-accountauditconfiguration.html#cfn-iot-accountauditconfiguration-rolearn}
      */
     RoleArn: string;
 };
 /**
  * Which audit checks are enabled and disabled for this account.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfiguration.html}
  */
 export type AuditCheckConfiguration = {
     /**
      * True if this audit check is enabled for this account.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfiguration.html#cfn-iot-accountauditconfiguration-auditcheckconfiguration-enabled}
      */
     Enabled?: boolean | undefined;
 };
 /**
  * The types of audit checks that can be performed.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html}
  */
 export type AuditCheckConfigurations = {
     /**
      * Checks the permissiveness of an authenticated Amazon Cognito identity pool role. For this check, AWS IoT Device Defender audits all Amazon Cognito identity pools that have been used to connect to the AWS IoT message broker during the 31 days before the audit is performed.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-authenticatedcognitoroleoverlypermissivecheck}
      */
     AuthenticatedCognitoRoleOverlyPermissiveCheck?: AuditCheckConfiguration | undefined;
     /**
      * Checks if a CA certificate is expiring. This check applies to CA certificates expiring within 30 days or that have expired.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-cacertificateexpiringcheck}
      */
     CaCertificateExpiringCheck?: AuditCheckConfiguration | undefined;
     /**
      * Checks the quality of the CA certificate key. The quality checks if the key is in a valid format, not expired, and if the key meets a minimum required size. This check applies to CA certificates that are `ACTIVE` or `PENDING_TRANSFER` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-cacertificatekeyqualitycheck}
      */
     CaCertificateKeyQualityCheck?: AuditCheckConfiguration | undefined;
     /**
      * Checks if multiple devices connect using the same client ID.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-conflictingclientidscheck}
      */
     ConflictingClientIdsCheck?: AuditCheckConfiguration | undefined;
     /**
      * Checks when a device certificate has been active for a number of days greater than or equal to the number you specify.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-devicecertificateagecheck}
      */
     DeviceCertificateAgeCheck?: DeviceCertAgeAuditCheckConfiguration | undefined;
     /**
      * Checks if a device certificate is expiring. By default, this check applies to device certificates expiring within 30 days or that have expired. You can modify this threshold by configuring the DeviceCertExpirationAuditCheckConfiguration.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-devicecertificateexpiringcheck}
      */
     DeviceCertificateExpiringCheck?: DeviceCertExpirationAuditCheckConfiguration | undefined;
     /**
      * Checks the quality of the device certificate key. The quality checks if the key is in a valid format, not expired, signed by a registered certificate authority, and if the key meets a minimum required size.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-devicecertificatekeyqualitycheck}
      */
     DeviceCertificateKeyQualityCheck?: AuditCheckConfiguration | undefined;
     /**
      * Checks if multiple concurrent connections use the same X.509 certificate to authenticate with AWS IoT .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-devicecertificatesharedcheck}
      */
     DeviceCertificateSharedCheck?: AuditCheckConfiguration | undefined;
     /**
      * Checks if device certificates are still active despite being revoked by an intermediate CA.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-intermediatecarevokedforactivedevicecertificatescheck}
      */
     IntermediateCaRevokedForActiveDeviceCertificatesCheck?: AuditCheckConfiguration | undefined;
     /**
      * Checks if an AWS IoT policy is potentially misconfigured. Misconfigured policies, including overly permissive policies, can cause security incidents like allowing devices access to unintended resources. This check is a warning for you to make sure that only intended actions are allowed before updating the policy.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-iotpolicypotentialmisconfigurationcheck}
      */
     IoTPolicyPotentialMisConfigurationCheck?: AuditCheckConfiguration | undefined;
     /**
      * Checks the permissiveness of a policy attached to an authenticated Amazon Cognito identity pool role.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-iotpolicyoverlypermissivecheck}
      */
     IotPolicyOverlyPermissiveCheck?: AuditCheckConfiguration | undefined;
     /**
      * Checks if a role alias has access to services that haven't been used for the AWS IoT device in the last year.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-iotrolealiasallowsaccesstounusedservicescheck}
      */
     IotRoleAliasAllowsAccessToUnusedServicesCheck?: AuditCheckConfiguration | undefined;
     /**
      * Checks if the temporary credentials provided by AWS IoT role aliases are overly permissive.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-iotrolealiasoverlypermissivecheck}
      */
     IotRoleAliasOverlyPermissiveCheck?: AuditCheckConfiguration | undefined;
     /**
      * Checks if AWS IoT logs are disabled.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-loggingdisabledcheck}
      */
     LoggingDisabledCheck?: AuditCheckConfiguration | undefined;
     /**
      * Checks if a revoked CA certificate is still active.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-revokedcacertificatestillactivecheck}
      */
     RevokedCaCertificateStillActiveCheck?: AuditCheckConfiguration | undefined;
     /**
      * Checks if a revoked device certificate is still active.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-revokeddevicecertificatestillactivecheck}
      */
     RevokedDeviceCertificateStillActiveCheck?: AuditCheckConfiguration | undefined;
     /**
      * Checks if policy attached to an unauthenticated Amazon Cognito identity pool role is too permissive.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html#cfn-iot-accountauditconfiguration-auditcheckconfigurations-unauthenticatedcognitoroleoverlypermissivecheck}
      */
     UnauthenticatedCognitoRoleOverlyPermissiveCheck?: AuditCheckConfiguration | undefined;
 };
 /**
  * Information about the targets to which audit notifications are sent.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditnotificationtarget.html}
  */
 export type AuditNotificationTarget = {
     /**
      * True if notifications to the target are enabled.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditnotificationtarget.html#cfn-iot-accountauditconfiguration-auditnotificationtarget-enabled}
      */
     Enabled?: boolean | undefined;
     /**
      * The ARN of the role that grants permission to send notifications to the target.
      * @minLength 20
      * @maxLength 2048
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditnotificationtarget.html#cfn-iot-accountauditconfiguration-auditnotificationtarget-rolearn}
      */
     RoleArn?: string | undefined;
     /**
      * The ARN of the target (SNS topic) to which audit notifications are sent.
      * @maxLength 2048
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditnotificationtarget.html#cfn-iot-accountauditconfiguration-auditnotificationtarget-targetarn}
      */
     TargetArn?: string | undefined;
 };
 /**
  * The configuration of the audit notification target.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditnotificationtargetconfigurations.html}
  */
 export type AuditNotificationTargetConfigurations = {
     /**
      * The `Sns` notification target.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditnotificationtargetconfigurations.html#cfn-iot-accountauditconfiguration-auditnotificationtargetconfigurations-sns}
      */
     Sns?: AuditNotificationTarget | undefined;
 };
 /**
  * Configuration structure containing settings for the device certificate age check.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-certagecheckcustomconfiguration.html}
  */
 export type CertAgeCheckCustomConfiguration = {
     /**
      * The number of days that defines when a device certificate is considered to have aged. The check will report a finding if a certificate has been active for a number of days greater than or equal to this threshold value.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-certagecheckcustomconfiguration.html#cfn-iot-accountauditconfiguration-certagecheckcustomconfiguration-certagethresholdindays}
      */
     CertAgeThresholdInDays?: string | undefined;
 };
 /**
  * Configuration structure containing settings for the device certificate expiration check.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-certexpirationcheckcustomconfiguration.html}
  */
 export type CertExpirationCheckCustomConfiguration = {
     /**
      * The number of days before expiration that defines when a device certificate is considered to be approaching expiration. The check will report a finding if a certificate will expire within this number of days.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-certexpirationcheckcustomconfiguration.html#cfn-iot-accountauditconfiguration-certexpirationcheckcustomconfiguration-certexpirationthresholdindays}
      */
     CertExpirationThresholdInDays?: string | undefined;
 };
 /**
  * Configuration for the device certificate age audit check.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-devicecertageauditcheckconfiguration.html}
  */
 export type DeviceCertAgeAuditCheckConfiguration = {
     /**
      * Configuration settings for the device certificate age check, including the threshold in days for certificate age. This configuration is of type `CertAgeCheckCustomConfiguration` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-devicecertageauditcheckconfiguration.html#cfn-iot-accountauditconfiguration-devicecertageauditcheckconfiguration-configuration}
      */
     Configuration?: CertAgeCheckCustomConfiguration | undefined;
     /**
      * True if this audit check is enabled for this account.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-devicecertageauditcheckconfiguration.html#cfn-iot-accountauditconfiguration-devicecertageauditcheckconfiguration-enabled}
      */
     Enabled?: boolean | undefined;
 };
 /**
  * Configuration for the device certificate expiration audit check.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-devicecertexpirationauditcheckconfiguration.html}
  */
 export type DeviceCertExpirationAuditCheckConfiguration = {
     /**
      * Configuration settings for the device certificate expiration check, including the threshold in days before expiration. This configuration is of type `CertExpirationCheckCustomConfiguration`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-devicecertexpirationauditcheckconfiguration.html#cfn-iot-accountauditconfiguration-devicecertexpirationauditcheckconfiguration-configuration}
      */
     Configuration?: CertExpirationCheckCustomConfiguration | undefined;
     /**
      * True if this audit check is enabled for this account.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-devicecertexpirationauditcheckconfiguration.html#cfn-iot-accountauditconfiguration-devicecertexpirationauditcheckconfiguration-enabled}
      */
     Enabled?: boolean | undefined;
 };

package/out/exports/resources.generated/aws-iot-authorizer.d.ts

@@ -1,11 +1,17 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Specifies an authorizer.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html}
+ */
 export type IoTAuthorizer = ResourceDefinitionWithAttributes<"AWS::IoT::Authorizer", IoTAuthorizerProps, IoTAuthorizerAttribs>;
 /**
  * Specifies an authorizer.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html}
  */
 export type IoTAuthorizerProps = {
     /**
      * The authorizer's Lambda function ARN.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-authorizerfunctionarn}
      */
     AuthorizerFunctionArn: string;
     /**
@@ -13,20 +19,24 @@ export type IoTAuthorizerProps = {
      * @minLength 1
      * @maxLength 128
      * @pattern [\w=,@-]+
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-authorizername}
      */
     AuthorizerName?: string | undefined;
     /**
      * When `true` , the result from the authorizer's Lambda function is cached for clients that use persistent HTTP connections. The results are cached for the time specified by the Lambda function in `refreshAfterInSeconds` . This value doesn't affect authorization of clients that use MQTT connections.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-enablecachingforhttp}
      */
     EnableCachingForHttp?: boolean | undefined;
     /**
      * Specifies whether AWS IoT validates the token signature in an authorization request.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-signingdisabled}
      */
     SigningDisabled?: boolean | undefined;
     /**
      * The status of the authorizer.
      *
      * Valid values: `ACTIVE` | `INACTIVE`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-status}
      */
     Status?: "ACTIVE" | "INACTIVE" | undefined;
     /**
@@ -37,20 +47,27 @@ export type IoTAuthorizerProps = {
      * > For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
      * >
      * > For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-tags}
      */
     Tags?: Tag[] | undefined;
     /**
      * The key used to extract the token from the HTTP headers.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-tokenkeyname}
      */
     TokenKeyName?: string | undefined;
     /**
      * The public keys used to validate the token signature returned by your custom authentication service.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-tokensigningpublickeys}
      */
     TokenSigningPublicKeys?: Record<string, string> | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#aws-resource-iot-authorizer-return-values}
+ */
 export type IoTAuthorizerAttribs = {
     /**
      * The Amazon Resource Name (ARN) of the authorizer.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-arn}
      */
     Arn: string;
 };