@propulsionworks/cloudformation 0.1.0 → 0.1.2

package/out/exports/resources.generated/aws-lightsail-distribution.d.ts

@@ -1,50 +1,66 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * The `AWS::Lightsail::Distribution` resource specifies a content delivery network (CDN) distribution. You can create distributions only in the `us-east-1` AWS Region.
+ *
+ * A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance, static content hosted on a Lightsail bucket, or through a Lightsail load balancer.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html}
+ */
 export type LightsailDistribution = ResourceDefinitionWithAttributes<"AWS::Lightsail::Distribution", LightsailDistributionProps, LightsailDistributionAttribs>;
 /**
  * The `AWS::Lightsail::Distribution` resource specifies a content delivery network (CDN) distribution. You can create distributions only in the `us-east-1` AWS Region.
  *
  * A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance, static content hosted on a Lightsail bucket, or through a Lightsail load balancer.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html}
  */
 export type LightsailDistributionProps = {
     /**
      * The ID of the bundle applied to the distribution.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-bundleid}
      */
     BundleId: string;
     /**
      * An object that describes the cache behavior settings of the distribution.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-cachebehaviorsettings}
      */
     CacheBehaviorSettings?: CacheSettings | undefined;
     /**
      * An array of objects that describe the per-path cache behavior of the distribution.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-cachebehaviors}
      */
     CacheBehaviors?: CacheBehaviorPerPath[] | undefined;
     /**
      * The name of the SSL/TLS certificate attached to the distribution.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-certificatename}
      */
     CertificateName?: string | undefined;
     /**
      * An object that describes the default cache behavior of the distribution.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-defaultcachebehavior}
      */
     DefaultCacheBehavior: CacheBehavior;
     /**
      * The name of the distribution
      * @pattern \w[\w\-]*\w
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-distributionname}
      */
     DistributionName: string;
     /**
      * The IP address type of the distribution.
      *
      * The possible values are `ipv4` for IPv4 only, and `dualstack` for IPv4 and IPv6.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-ipaddresstype}
      */
     IpAddressType?: string | undefined;
     /**
      * A Boolean value indicating whether the distribution is enabled.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-isenabled}
      */
     IsEnabled?: boolean | undefined;
     /**
      * An object that describes the origin resource of the distribution, such as a Lightsail instance, bucket, or load balancer.
      *
      * The distribution pulls, caches, and serves content from the origin.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-origin}
      */
     Origin: InputOrigin;
     /**
@@ -53,25 +69,33 @@ export type LightsailDistributionProps = {
      * For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *AWS CloudFormation User Guide* .
      *
      * > The `Value` of `Tags` is optional for Lightsail resources.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-tags}
      */
     Tags?: Tag[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#aws-resource-lightsail-distribution-return-values}
+ */
 export type LightsailDistributionAttribs = {
     /**
      * Indicates whether you can update the distribution’s current bundle to another bundle.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-abletoupdatebundle}
      */
     AbleToUpdateBundle: boolean;
     /**
      * The Amazon Resource Name (ARN) of the distribution.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-distributionarn}
      */
     DistributionArn: string;
     /**
      * The status of the distribution.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-status}
      */
     Status: string;
 };
 /**
  * `CacheBehavior` is a property of the [AWS::Lightsail::Distribution](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html) resource. It describes the default cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachebehavior.html}
  */
 export type CacheBehavior = {
     /**
@@ -81,6 +105,7 @@ export type CacheBehavior = {
      *
      * - *`cache`* - This option is best for static sites. When specified, your distribution caches and serves your entire website as static content. This behavior is ideal for websites with static content that doesn't change depending on who views it, or for websites that don't use cookies, headers, or query strings to personalize content.
      * - *`dont-cache`* - This option is best for sites that serve a mix of static and dynamic content. When specified, your distribution caches and serves only the content that is specified in the distribution’s `CacheBehaviorPerPath` parameter. This behavior is ideal for websites or web applications that use cookies, headers, and query strings to personalize content for individual users.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachebehavior.html#cfn-lightsail-distribution-cachebehavior-behavior}
      */
     Behavior?: string | undefined;
 };
@@ -88,6 +113,7 @@ export type CacheBehavior = {
  * `CacheBehaviorPerPath` is a property of the [AWS::Lightsail::Distribution](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html) resource. It describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.
  *
  * Use a per-path cache behavior to override the default cache behavior of a distribution, or to add an exception to it. For example, if you set the `CacheBehavior` to `cache` , you can use a per-path cache behavior to specify a directory, file, or file type that your distribution will cache. If you don’t want your distribution to cache a specified directory, file, or file type, set the per-path cache behavior to `dont-cache` .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachebehaviorperpath.html}
  */
 export type CacheBehaviorPerPath = {
     /**
@@ -97,6 +123,7 @@ export type CacheBehaviorPerPath = {
      *
      * - *`cache`* - This behavior caches the specified path.
      * - *`dont-cache`* - This behavior doesn't cache the specified path.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachebehaviorperpath.html#cfn-lightsail-distribution-cachebehaviorperpath-behavior}
      */
     Behavior?: string | undefined;
     /**
@@ -124,6 +151,7 @@ export type CacheBehaviorPerPath = {
      * Specify the following to cache all files in the images subdirectory of the document root of an Apache web server.
      *
      * `var/www/html/images/`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachebehaviorperpath.html#cfn-lightsail-distribution-cachebehaviorperpath-path}
      */
     Path?: string | undefined;
 };
@@ -131,6 +159,7 @@ export type CacheBehaviorPerPath = {
  * `CacheSettings` is a property of the [AWS::Lightsail::Distribution](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html) resource. It describes the cache settings of an Amazon Lightsail content delivery network (CDN) distribution.
  *
  * These settings apply only to your distribution’s `CacheBehaviors` that have a `Behavior` of `cache` . This includes the `DefaultCacheBehavior` .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html}
  */
 export type CacheSettings = {
     /**
@@ -143,6 +172,7 @@ export type CacheSettings = {
      * - `GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE` - The distribution forwards the `GET` , `HEAD` , `OPTIONS` , `PUT` , `PATCH` , `POST` , and `DELETE` methods.
      *
      * If you specify `GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE` , you might need to restrict access to your distribution's origin so users can't perform operations that you don't want them to. For example, you might not want users to have permission to delete objects from your origin.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html#cfn-lightsail-distribution-cachesettings-allowedhttpmethods}
      */
     AllowedHTTPMethods?: string | undefined;
     /**
@@ -152,6 +182,7 @@ export type CacheSettings = {
      *
      * - `GET,HEAD` - The distribution caches responses to the `GET` and `HEAD` methods.
      * - `GET,HEAD,OPTIONS` - The distribution caches responses to the `GET` , `HEAD` , and `OPTIONS` methods.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html#cfn-lightsail-distribution-cachesettings-cachedhttpmethods}
      */
     CachedHTTPMethods?: string | undefined;
     /**
@@ -159,18 +190,22 @@ export type CacheSettings = {
      *
      * > The value specified applies only when the origin does not add HTTP headers such as `Cache-Control max-age` , `Cache-Control s-maxage` , and `Expires` to objects.
      * @format int64
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html#cfn-lightsail-distribution-cachesettings-defaultttl}
      */
     DefaultTTL?: number | undefined;
     /**
      * An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html#cfn-lightsail-distribution-cachesettings-forwardedcookies}
      */
     ForwardedCookies?: CookieObject | undefined;
     /**
      * An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html#cfn-lightsail-distribution-cachesettings-forwardedheaders}
      */
     ForwardedHeaders?: HeaderObject | undefined;
     /**
      * An object that describes the query strings that are forwarded to the origin. Your content is cached based on the query strings that are forwarded.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html#cfn-lightsail-distribution-cachesettings-forwardedquerystrings}
      */
     ForwardedQueryStrings?: QueryStringObject | undefined;
     /**
@@ -178,6 +213,7 @@ export type CacheSettings = {
      *
      * The value specified applies only when the origin adds HTTP headers such as `Cache-Control max-age` , `Cache-Control s-maxage` , and `Expires` to objects.
      * @format int64
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html#cfn-lightsail-distribution-cachesettings-maximumttl}
      */
     MaximumTTL?: number | undefined;
     /**
@@ -185,6 +221,7 @@ export type CacheSettings = {
      *
      * A value of `0` must be specified for `minimumTTL` if the distribution is configured to forward all headers to the origin.
      * @format int64
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html#cfn-lightsail-distribution-cachesettings-minimumttl}
      */
     MinimumTTL?: number | undefined;
 };
@@ -192,10 +229,12 @@ export type CacheSettings = {
  * `CookieObject` is a property of the [CacheSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html) property. It describes whether an Amazon Lightsail content delivery network (CDN) distribution forwards cookies to the origin and, if so, which ones.
  *
  * For the cookies that you specify, your distribution caches separate versions of the specified content based on the cookie values in viewer requests.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cookieobject.html}
  */
 export type CookieObject = {
     /**
      * The specific cookies to forward to your distribution's origin.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cookieobject.html#cfn-lightsail-distribution-cookieobject-cookiesallowlist}
      */
     CookiesAllowList?: string[] | undefined;
     /**
@@ -206,6 +245,7 @@ export type CookieObject = {
      * - *`all`* - Forwards all cookies to your origin.
      * - *`none`* - Doesn’t forward cookies to your origin.
      * - *`allow-list`* - Forwards only the cookies that you specify using the `CookiesAllowList` parameter.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cookieobject.html#cfn-lightsail-distribution-cookieobject-option}
      */
     Option?: string | undefined;
 };
@@ -213,10 +253,12 @@ export type CookieObject = {
  * `HeaderObject` is a property of the [CacheSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html) property. It describes the request headers used by your distribution, which caches your content based on the request headers.
  *
  * For the headers that you specify, your distribution caches separate versions of the specified content based on the header values in viewer requests. For example, suppose that viewer requests for logo.jpg contain a custom product header that has a value of either acme or apex. Also, suppose that you configure your distribution to cache your content based on values in the product header. Your distribution forwards the product header to the origin and caches the response from the origin once for each header value.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-headerobject.html}
  */
 export type HeaderObject = {
     /**
      * The specific headers to forward to your distribution's origin.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-headerobject.html#cfn-lightsail-distribution-headerobject-headersallowlist}
      */
     HeadersAllowList?: string[] | undefined;
     /**
@@ -227,6 +269,7 @@ export type HeaderObject = {
      * - *`all`* - Forwards all headers to your origin..
      * - *`none`* - Forwards only the default headers.
      * - *`allow-list`* - Forwards only the headers that you specify using the `HeadersAllowList` parameter.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-headerobject.html#cfn-lightsail-distribution-headerobject-option}
      */
     Option?: string | undefined;
 };
@@ -234,18 +277,22 @@ export type HeaderObject = {
  * `InputOrigin` is a property of the [AWS::Lightsail::Distribution](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html) resource. It describes the origin resource of an Amazon Lightsail content delivery network (CDN) distribution.
  *
  * An origin can be a instance, bucket, or load balancer. A distribution pulls content from an origin, caches it, and serves it to viewers through a worldwide network of edge servers.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-inputorigin.html}
  */
 export type InputOrigin = {
     /**
      * The name of the origin resource.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-inputorigin.html#cfn-lightsail-distribution-inputorigin-name}
      */
     Name?: string | undefined;
     /**
      * The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-inputorigin.html#cfn-lightsail-distribution-inputorigin-protocolpolicy}
      */
     ProtocolPolicy?: string | undefined;
     /**
      * The AWS Region name of the origin resource.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-inputorigin.html#cfn-lightsail-distribution-inputorigin-regionname}
      */
     RegionName?: string | undefined;
 };
@@ -253,10 +300,12 @@ export type InputOrigin = {
  * `QueryStringObject` is a property of the [CacheSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html) property. It describes the query string parameters that an Amazon Lightsail content delivery network (CDN) distribution to bases caching on.
  *
  * For the query strings that you specify, your distribution caches separate versions of the specified content based on the query string values in viewer requests.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-querystringobject.html}
  */
 export type QueryStringObject = {
     /**
      * Indicates whether the distribution forwards and caches based on query strings.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-querystringobject.html#cfn-lightsail-distribution-querystringobject-option}
      */
     Option?: boolean | undefined;
     /**
@@ -265,6 +314,7 @@ export type QueryStringObject = {
      * Your distribution caches content based on the specified query strings.
      *
      * If the `option` parameter is true, then your distribution forwards all query strings, regardless of what you specify using the `QueryStringsAllowList` parameter.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-querystringobject.html#cfn-lightsail-distribution-querystringobject-querystringsallowlist}
      */
     QueryStringsAllowList?: string[] | undefined;
 };

package/out/exports/resources.generated/aws-lightsail-instance.d.ts

@@ -1,37 +1,47 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * The `AWS::Lightsail::Instance` resource specifies an Amazon Lightsail instance.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html}
+ */
 export type LightsailInstance = ResourceDefinitionWithAttributes<"AWS::Lightsail::Instance", LightsailInstanceProps, LightsailInstanceAttribs>;
 /**
  * The `AWS::Lightsail::Instance` resource specifies an Amazon Lightsail instance.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html}
  */
 export type LightsailInstanceProps = {
     /**
      * An array of add-ons for the instance.
      *
      * > If the instance has an add-on enabled when performing a delete instance request, the add-on is automatically disabled before the instance is deleted.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-addons}
      */
     AddOns?: AddOn[] | undefined;
     /**
      * The Availability Zone for the instance.
      * @minLength 1
      * @maxLength 255
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-availabilityzone}
      */
     AvailabilityZone?: string | undefined;
     /**
      * The blueprint ID for the instance (for example, `os_amlinux_2016_03` ).
      * @minLength 1
      * @maxLength 255
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-blueprintid}
      */
     BlueprintId: string;
     /**
      * The bundle ID for the instance (for example, `micro_1_0` ).
      * @minLength 1
      * @maxLength 255
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-bundleid}
      */
     BundleId: string;
     /**
      * The hardware properties for the instance, such as the vCPU count, attached disks, and amount of RAM.
      *
      * > The instance restarts when performing an attach disk or detach disk request. This resets the public IP address of your instance if a static IP isn't attached to it.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-hardware}
      */
     Hardware?: Hardware | undefined;
     /**
@@ -39,16 +49,19 @@ export type LightsailInstanceProps = {
      * @minLength 1
      * @maxLength 254
      * @pattern ^[a-zA-Z0-9][\w\-.]*[a-zA-Z0-9]$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-instancename}
      */
     InstanceName: string;
     /**
      * The name of the key pair to use for the instance.
      *
      * If no key pair name is specified, the Regional Lightsail default key pair is used.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-keypairname}
      */
     KeyPairName?: string | undefined;
     /**
      * The public ports and the monthly amount of data transfer allocated for the instance.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-networking}
      */
     Networking?: Networking | undefined;
     /**
@@ -57,6 +70,7 @@ export type LightsailInstanceProps = {
      * For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *AWS CloudFormation User Guide* .
      *
      * > The `Value` of `Tags` is optional for Lightsail resources.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-tags}
      */
     Tags?: Tag[] | undefined;
     /**
@@ -65,79 +79,100 @@ export type LightsailInstanceProps = {
      * Specify a launch script to configure an instance with additional user data. For example, you might want to specify `apt-get -y update` as a launch script.
      *
      * > Depending on the blueprint of your instance, the command to get software on your instance varies. Amazon Linux and CentOS use `yum` , Debian and Ubuntu use `apt-get` , and FreeBSD uses `pkg` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-userdata}
      */
     UserData?: string | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#aws-resource-lightsail-instance-return-values}
+ */
 export type LightsailInstanceAttribs = {
     /**
      * The number of vCPUs the instance has.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-hardware.html#cfn-lightsail-instance-hardware-cpucount}
      */
     "Hardware.CpuCount": number;
     /**
      * The amount of RAM in GB on the instance (for example, `1.0` ).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-hardware.html#cfn-lightsail-instance-hardware-ramsizeingb}
      */
     "Hardware.RamSizeInGb": number;
     /**
      * The Amazon Resource Name (ARN) of the instance (for example, `arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE` ).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-instancearn}
      */
     InstanceArn: string;
     /**
      * The IPv6 addresses of the instance.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-ipv6addresses}
      */
     Ipv6Addresses: string[];
     /**
      * A Boolean value indicating whether the instance has a static IP assigned to it.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-isstaticip}
      */
     IsStaticIp: boolean;
     /**
      * The AWS Region and Availability Zone where the instance is located.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-location.html#cfn-lightsail-instance-location-availabilityzone}
      */
     "Location.AvailabilityZone": string;
     /**
      * The AWS Region of the instance.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-location.html#cfn-lightsail-instance-location-regionname}
      */
     "Location.RegionName": string;
     /**
      * The amount of allocated monthly data transfer (in GB) for an instance.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-monthlytransfer.html#cfn-lightsail-instance-monthlytransfer-gbpermonthallocated}
      */
     "Networking.MonthlyTransfer.GbPerMonthAllocated": string;
     /**
      * The private IP address of the instance.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-privateipaddress}
      */
     PrivateIpAddress: string;
     /**
      * The public IP address of the instance.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-publicipaddress}
      */
     PublicIpAddress: string;
     /**
      * The resource type of the instance (for example, `Instance` ).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-resourcetype}
      */
     ResourceType: string;
     /**
      * The name of the SSH key pair used by the instance.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-sshkeyname}
      */
     SshKeyName: string;
     /**
      * The status code of the instance.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-state.html#cfn-lightsail-instance-state-code}
      */
     "State.Code": number;
     /**
      * The state of the instance (for example, `running` or `pending` ).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-state.html#cfn-lightsail-instance-state-name}
      */
     "State.Name": string;
     /**
      * The support code of the instance.
      *
      * Include this code in your email to support when you have questions about an instance or another resource in Lightsail . This code helps our support team to look up your Lightsail information.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-supportcode}
      */
     SupportCode: string;
     /**
      * The user name for connecting to the instance (for example, `ec2-user` ).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-username}
      */
     UserName: string;
 };
 /**
  * `AddOn` is a property of the [AWS::Lightsail::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html) resource. It describes the add-ons for an instance.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-addon.html}
  */
 export type AddOn = {
     /**
@@ -146,21 +181,25 @@ export type AddOn = {
      * > `AutoSnapshot` is the only add-on that can be enabled for an instance.
      * @minLength 1
      * @maxLength 128
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-addon.html#cfn-lightsail-instance-addon-addontype}
      */
     AddOnType: string;
     /**
      * The parameters for the automatic snapshot add-on, such as the daily time when an automatic snapshot will be created.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-addon.html#cfn-lightsail-instance-addon-autosnapshotaddonrequest}
      */
     AutoSnapshotAddOnRequest?: AutoSnapshotAddOn | undefined;
     /**
      * The status of the add-on.
      *
      * Valid Values: `Enabled` | `Disabled`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-addon.html#cfn-lightsail-instance-addon-status}
      */
     Status?: "Enabling" | "Disabling" | "Enabled" | "Terminating" | "Terminated" | "Disabled" | "Failed" | undefined;
 };
 /**
  * `AutoSnapshotAddOn` is a property of the [AddOn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-addon.html) property. It describes the automatic snapshot add-on for an instance.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-autosnapshotaddon.html}
  */
 export type AutoSnapshotAddOn = {
     /**
@@ -172,21 +211,25 @@ export type AutoSnapshotAddOn = {
      * - Specified in Coordinated Universal Time (UTC).
      * - The snapshot will be automatically created between the time specified and up to 45 minutes after.
      * @pattern ^[0-9]{2}:00$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-autosnapshotaddon.html#cfn-lightsail-instance-autosnapshotaddon-snapshottimeofday}
      */
     SnapshotTimeOfDay?: string | undefined;
 };
 /**
  * `Disk` is a property of the [Hardware](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-hardware.html) property. It describes a disk attached to an instance.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-disk.html}
  */
 export type Disk = {
     /**
      * The resources to which the disk is attached.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-disk.html#cfn-lightsail-instance-disk-attachedto}
      */
     AttachedTo?: string | undefined;
     /**
      * (Deprecated) The attachment state of the disk.
      *
      * > In releases prior to November 14, 2017, this parameter returned `attached` for system disks in the API response. It is now deprecated, but still included in the response. Use `isAttached` instead.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-disk.html#cfn-lightsail-instance-disk-attachmentstate}
      */
     AttachmentState?: string | undefined;
     /**
@@ -194,67 +237,81 @@ export type Disk = {
      * @minLength 1
      * @maxLength 254
      * @pattern ^[a-zA-Z0-9][\w\-.]*[a-zA-Z0-9]$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-disk.html#cfn-lightsail-instance-disk-diskname}
      */
     DiskName: string;
     /**
      * The input/output operations per second (IOPS) of the disk.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-disk.html#cfn-lightsail-instance-disk-iops}
      */
     IOPS?: number | undefined;
     /**
      * A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-disk.html#cfn-lightsail-instance-disk-issystemdisk}
      */
     IsSystemDisk?: boolean | undefined;
     /**
      * The disk path.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-disk.html#cfn-lightsail-instance-disk-path}
      */
     Path: string;
     /**
      * The size of the disk in GB.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-disk.html#cfn-lightsail-instance-disk-sizeingb}
      */
     SizeInGb?: string | undefined;
 };
 /**
  * `Hardware` is a property of the [AWS::Lightsail::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html) resource. It describes the hardware properties for the instance, such as the vCPU count, attached disks, and amount of RAM.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-hardware.html}
  */
 export type Hardware = {
     /**
      * The disks attached to the instance.
      *
      * The instance restarts when performing an attach disk or detach disk request. This resets the public IP address of your instance if a static IP isn't attached to it.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-hardware.html#cfn-lightsail-instance-hardware-disks}
      */
     Disks?: Disk[] | undefined;
 };
 /**
  * `Networking` is a property of the [AWS::Lightsail::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html) resource. It describes the public ports and the monthly amount of data transfer allocated for the instance.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-networking.html}
  */
 export type Networking = {
     /**
      * An array of ports to open on the instance.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-networking.html#cfn-lightsail-instance-networking-ports}
      */
     Ports: Port[];
 };
 /**
  * `Port` is a property of the [Networking](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-networking.html) property. It describes information about ports for an instance.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-port.html}
  */
 export type Port = {
     /**
      * The access direction ( `inbound` or `outbound` ).
      *
      * > Lightsail currently supports only `inbound` access direction.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-port.html#cfn-lightsail-instance-port-accessdirection}
      */
     AccessDirection?: string | undefined;
     /**
      * The location from which access is allowed. For example, `Anywhere (0.0.0.0/0)` , or `Custom` if a specific IP address or range of IP addresses is allowed.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-port.html#cfn-lightsail-instance-port-accessfrom}
      */
     AccessFrom?: string | undefined;
     /**
      * The type of access ( `Public` or `Private` ).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-port.html#cfn-lightsail-instance-port-accesstype}
      */
     AccessType?: string | undefined;
     /**
      * An alias that defines access for a preconfigured range of IP addresses.
      *
      * The only alias currently supported is `lightsail-connect` , which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-port.html#cfn-lightsail-instance-port-cidrlistaliases}
      */
     CidrListAliases?: string[] | undefined;
     /**
@@ -266,10 +323,12 @@ export type Port = {
      *
      * - To allow the IP address `192.0.2.44` , specify `192.0.2.44` or `192.0.2.44/32` .
      * - To allow the IP addresses `192.0.2.0` to `192.0.2.255` , specify `192.0.2.0/24` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-port.html#cfn-lightsail-instance-port-cidrs}
      */
     Cidrs?: string[] | undefined;
     /**
      * The common name of the port information.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-port.html#cfn-lightsail-instance-port-commonname}
      */
     CommonName?: string | undefined;
     /**
@@ -280,12 +339,14 @@ export type Port = {
      * - TCP and UDP - `0` to `65535`
      * - ICMP - The ICMP type for IPv4 addresses. For example, specify `8` as the `fromPort` (ICMP type), and `-1` as the `toPort` (ICMP code), to enable ICMP Ping.
      * - ICMPv6 - The ICMP type for IPv6 addresses. For example, specify `128` as the `fromPort` (ICMPv6 type), and `0` as `toPort` (ICMPv6 code).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-port.html#cfn-lightsail-instance-port-fromport}
      */
     FromPort?: number | undefined;
     /**
      * The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used.
      *
      * > The `cidrs` parameter lists the IPv4 addresses that are allowed to connect to an instance.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-port.html#cfn-lightsail-instance-port-ipv6cidrs}
      */
     Ipv6Cidrs?: string[] | undefined;
     /**
@@ -297,6 +358,7 @@ export type Port = {
      * - `all` - All transport layer protocol types.
      * - `udp` - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.
      * - `icmp` - Internet Control Message Protocol (ICMP) is used to send error messages and operational information indicating success or failure when communicating with an instance. For example, an error is indicated when an instance could not be reached. When you specify `icmp` as the `protocol` , you must specify the ICMP type using the `fromPort` parameter, and ICMP code using the `toPort` parameter.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-port.html#cfn-lightsail-instance-port-protocol}
      */
     Protocol?: string | undefined;
     /**
@@ -307,6 +369,7 @@ export type Port = {
      * - TCP and UDP - `0` to `65535`
      * - ICMP - The ICMP code for IPv4 addresses. For example, specify `8` as the `fromPort` (ICMP type), and `-1` as the `toPort` (ICMP code), to enable ICMP Ping.
      * - ICMPv6 - The ICMP code for IPv6 addresses. For example, specify `128` as the `fromPort` (ICMPv6 type), and `0` as `toPort` (ICMPv6 code).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-port.html#cfn-lightsail-instance-port-toport}
      */
     ToPort?: number | undefined;
 };