@propulsionworks/cloudformation 0.1.0 → 0.1.2

package/out/exports/resources.generated/aws-ec2-subnet.d.ts

@@ -1,4 +1,12 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Specifies a subnet for the specified VPC.
+ *
+ * For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block.
+ *
+ * For more information, see [Subnets for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html) in the *Amazon VPC User Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html}
+ */
 export type EC2Subnet = ResourceDefinitionWithAttributes<"AWS::EC2::Subnet", EC2SubnetProps, EC2SubnetAttribs>;
 /**
  * Specifies a subnet for the specified VPC.
@@ -6,74 +14,89 @@ export type EC2Subnet = ResourceDefinitionWithAttributes<"AWS::EC2::Subnet", EC2
  * For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block.
  *
  * For more information, see [Subnets for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html) in the *Amazon VPC User Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html}
  */
 export type EC2SubnetProps = {
     /**
      * Indicates whether a network interface created in this subnet receives an IPv6 address. The default value is `false` .
      *
      * If you specify `AssignIpv6AddressOnCreation` , you must also specify an IPv6 CIDR block.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-assignipv6addressoncreation}
      */
     AssignIpv6AddressOnCreation?: boolean | undefined;
     /**
      * The Availability Zone of the subnet.
      *
      * If you update this property, you must also update the `CidrBlock` property.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-availabilityzone}
      */
     AvailabilityZone?: string | undefined;
     /**
      * The AZ ID of the subnet.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-availabilityzoneid}
      */
     AvailabilityZoneId?: string | undefined;
     /**
      * The IPv4 CIDR block assigned to the subnet.
      *
      * If you update this property, we create a new subnet, and then delete the existing one.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-cidrblock}
      */
     CidrBlock?: string | undefined;
     /**
      * Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
      *
      * > You must first configure a NAT gateway in a public subnet (separate from the subnet containing the IPv6-only workloads). For example, the subnet containing the NAT gateway should have a `0.0.0.0/0` route pointing to the internet gateway. For more information, see [Configure DNS64 and NAT64](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-nat64-dns64.html#nat-gateway-nat64-dns64-walkthrough) in the *Amazon Virtual Private Cloud User Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-enabledns64}
      */
     EnableDns64?: boolean | undefined;
     /**
      * Indicates the device position for local network interfaces in this subnet. For example, `1` indicates local network interfaces in this subnet are the secondary network interface (eth1).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-enablelniatdeviceindex}
      */
     EnableLniAtDeviceIndex?: number | undefined;
     /**
      * An IPv4 IPAM pool ID for the subnet.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-ipv4ipampoolid}
      */
     Ipv4IpamPoolId?: string | undefined;
     /**
      * An IPv4 netmask length for the subnet.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-ipv4netmasklength}
      */
     Ipv4NetmaskLength?: number | undefined;
     /**
      * The IPv6 CIDR block.
      *
      * If you specify `AssignIpv6AddressOnCreation` , you must also specify an IPv6 CIDR block.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-ipv6cidrblock}
      */
     Ipv6CidrBlock?: string | undefined;
     /**
      * An IPv6 IPAM pool ID for the subnet.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-ipv6ipampoolid}
      */
     Ipv6IpamPoolId?: string | undefined;
     /**
      * Indicates whether this is an IPv6 only subnet. For more information, see [Subnet basics](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#subnet-basics) in the *Amazon Virtual Private Cloud User Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-ipv6native}
      */
     Ipv6Native?: boolean | undefined;
     /**
      * An IPv6 netmask length for the subnet.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-ipv6netmasklength}
      */
     Ipv6NetmaskLength?: number | undefined;
     /**
      * Indicates whether instances launched in this subnet receive a public IPv4 address. The default value is `false` .
      *
      * AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-mappubliciponlaunch}
      */
     MapPublicIpOnLaunch?: boolean | undefined;
     /**
      * The Amazon Resource Name (ARN) of the Outpost.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-outpostarn}
      */
     OutpostArn?: string | undefined;
     /**
@@ -84,6 +107,7 @@ export type EC2SubnetProps = {
      * - EnableResourceNameDnsAAAARecord (true | false)
      * - EnableResourceNameDnsARecord (true | false)
      * - HostnameType (ip-name | resource-name)
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-privatednsnameoptionsonlaunch}
      */
     PrivateDnsNameOptionsOnLaunch?: {
         EnableResourceNameDnsAAAARecord?: boolean | undefined;
@@ -92,46 +116,59 @@ export type EC2SubnetProps = {
     } | undefined;
     /**
      * Any tags assigned to the subnet.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-tags}
      */
     Tags?: Tag[] | undefined;
     /**
      * The ID of the VPC the subnet is in.
      *
      * If you update this property, you must also update the `CidrBlock` property.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-vpcid}
      */
     VpcId: string;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#aws-resource-ec2-subnet-return-values}
+ */
 export type EC2SubnetAttribs = {
     /**
      * The Availability Zone of this subnet. For example, `us-east-1a` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-availabilityzone}
      */
     AvailabilityZone: string;
     /**
      * The Availability Zone ID of this subnet. For example, `use1-az1` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-availabilityzoneid}
      */
     AvailabilityZoneId: string;
     /**
      * The IPv4 CIDR blocks that are associated with the subnet.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-cidrblock}
      */
     CidrBlock: string;
     /**
      * The IPv6 CIDR blocks that are associated with the subnet.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-ipv6cidrblocks}
      */
     Ipv6CidrBlocks: string[];
     /**
      * The ID of the network ACL that is associated with the subnet's VPC, such as `acl-5fb85d36` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-networkaclassociationid}
      */
     NetworkAclAssociationId: string;
     /**
      * The Amazon Resource Name (ARN) of the Outpost.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-outpostarn}
      */
     OutpostArn: string;
     /**
      * The ID of the subnet.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-subnetid}
      */
     SubnetId: string;
     /**
      * The ID of the subnet's VPC, such as `vpc-11ad4878` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-vpcid}
      */
     VpcId: string;
 };

package/out/exports/resources.generated/aws-ec2-subnetcidrblock.d.ts

@@ -1,40 +1,55 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * Associates a CIDR block with your subnet. You can associate a single IPv6 CIDR block with your subnet.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html}
+ */
 export type EC2SubnetCidrBlock = ResourceDefinitionWithAttributes<"AWS::EC2::SubnetCidrBlock", EC2SubnetCidrBlockProps, EC2SubnetCidrBlockAttribs>;
 /**
  * Associates a CIDR block with your subnet. You can associate a single IPv6 CIDR block with your subnet.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html}
  */
 export type EC2SubnetCidrBlockProps = {
     /**
      * The IPv6 network range for the subnet, in CIDR notation.
      * @maxLength 42
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html#cfn-ec2-subnetcidrblock-ipv6cidrblock}
      */
     Ipv6CidrBlock?: string | undefined;
     /**
      * An IPv6 IPAM pool ID for the subnet.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html#cfn-ec2-subnetcidrblock-ipv6ipampoolid}
      */
     Ipv6IpamPoolId?: string | undefined;
     /**
      * An IPv6 netmask length for the subnet.
      * @min 0
      * @max 128
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html#cfn-ec2-subnetcidrblock-ipv6netmasklength}
      */
     Ipv6NetmaskLength?: number | undefined;
     /**
      * The ID of the subnet.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html#cfn-ec2-subnetcidrblock-subnetid}
      */
     SubnetId: string;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html#aws-resource-ec2-subnetcidrblock-return-values}
+ */
 export type EC2SubnetCidrBlockAttribs = {
     /**
      * The ID of the association.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html#cfn-ec2-subnetcidrblock-id}
      */
     Id: string;
     /**
      * The source that allocated the IP address space. `byoip` or `amazon` indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). `none` indicates private space.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html#cfn-ec2-subnetcidrblock-ipsource}
      */
     IpSource: string;
     /**
      * Public IPv6 addresses are those advertised on the internet from AWS . Private IP addresses are not and cannot be advertised on the internet from AWS .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html#cfn-ec2-subnetcidrblock-ipv6addressattribute}
      */
     Ipv6AddressAttribute: string;
 };

package/out/exports/resources.generated/aws-ec2-subnetnetworkaclassociation.d.ts

@@ -1,23 +1,36 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * Associates a subnet with a network ACL. For more information, see [ReplaceNetworkAclAssociation](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-ReplaceNetworkAclAssociation.html) in the *Amazon EC2 API Reference* .
+ *
+ * When `AWS::EC2::SubnetNetworkAclAssociation` resources are created during create or update operations, AWS CloudFormation adopts existing resources that share the same key properties (the properties that contribute to uniquely identify the resource). However, if the operation fails and rolls back, AWS CloudFormation deletes the previously out-of-band resources. You can protect against this behavior by using `Retain` deletion policies. For more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetnetworkaclassociation.html}
+ */
 export type EC2SubnetNetworkAclAssociation = ResourceDefinitionWithAttributes<"AWS::EC2::SubnetNetworkAclAssociation", EC2SubnetNetworkAclAssociationProps, EC2SubnetNetworkAclAssociationAttribs>;
 /**
  * Associates a subnet with a network ACL. For more information, see [ReplaceNetworkAclAssociation](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-ReplaceNetworkAclAssociation.html) in the *Amazon EC2 API Reference* .
  *
  * When `AWS::EC2::SubnetNetworkAclAssociation` resources are created during create or update operations, AWS CloudFormation adopts existing resources that share the same key properties (the properties that contribute to uniquely identify the resource). However, if the operation fails and rolls back, AWS CloudFormation deletes the previously out-of-band resources. You can protect against this behavior by using `Retain` deletion policies. For more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetnetworkaclassociation.html}
  */
 export type EC2SubnetNetworkAclAssociationProps = {
     /**
      * The ID of the network ACL.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetnetworkaclassociation.html#cfn-ec2-subnetnetworkaclassociation-networkaclid}
      */
     NetworkAclId: string;
     /**
      * The ID of the subnet.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetnetworkaclassociation.html#cfn-ec2-subnetnetworkaclassociation-subnetid}
      */
     SubnetId: string;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetnetworkaclassociation.html#aws-resource-ec2-subnetnetworkaclassociation-return-values}
+ */
 export type EC2SubnetNetworkAclAssociationAttribs = {
     /**
      * Returns the value of this object's AssociationId property.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetnetworkaclassociation.html#cfn-ec2-subnetnetworkaclassociation-associationid}
      */
     AssociationId: string;
 };

package/out/exports/resources.generated/aws-ec2-subnetroutetableassociation.d.ts

@@ -1,23 +1,34 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. A route table can be associated with multiple subnets. To create a route table, see [AWS::EC2::RouteTable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routetable.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetroutetableassociation.html}
+ */
 export type EC2SubnetRouteTableAssociation = ResourceDefinitionWithAttributes<"AWS::EC2::SubnetRouteTableAssociation", EC2SubnetRouteTableAssociationProps, EC2SubnetRouteTableAssociationAttribs>;
 /**
  * Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. A route table can be associated with multiple subnets. To create a route table, see [AWS::EC2::RouteTable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routetable.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetroutetableassociation.html}
  */
 export type EC2SubnetRouteTableAssociationProps = {
     /**
      * The ID of the route table.
      *
      * The physical ID changes when the route table ID is changed.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetroutetableassociation.html#cfn-ec2-subnetroutetableassociation-routetableid}
      */
     RouteTableId: string;
     /**
      * The ID of the subnet.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetroutetableassociation.html#cfn-ec2-subnetroutetableassociation-subnetid}
      */
     SubnetId: string;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetroutetableassociation.html#aws-resource-ec2-subnetroutetableassociation-return-values}
+ */
 export type EC2SubnetRouteTableAssociationAttribs = {
     /**
      * The ID of the subnet route table association.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetroutetableassociation.html#cfn-ec2-subnetroutetableassociation-id}
      */
     Id: string;
 };

package/out/exports/resources.generated/aws-ec2-trafficmirrorfilter.d.ts

@@ -1,4 +1,12 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Specifies a Traffic Mirror filter.
+ *
+ * A Traffic Mirror filter is a set of rules that defines the traffic to mirror.
+ *
+ * By default, no traffic is mirrored. To mirror traffic, use [AWS::EC2::TrafficMirrorFilterRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html) to add Traffic Mirror rules to the filter. The rules you add define what traffic gets mirrored.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilter.html}
+ */
 export type EC2TrafficMirrorFilter = ResourceDefinitionWithAttributes<"AWS::EC2::TrafficMirrorFilter", EC2TrafficMirrorFilterProps, EC2TrafficMirrorFilterAttribs>;
 /**
  * Specifies a Traffic Mirror filter.
@@ -6,24 +14,34 @@ export type EC2TrafficMirrorFilter = ResourceDefinitionWithAttributes<"AWS::EC2:
  * A Traffic Mirror filter is a set of rules that defines the traffic to mirror.
  *
  * By default, no traffic is mirrored. To mirror traffic, use [AWS::EC2::TrafficMirrorFilterRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html) to add Traffic Mirror rules to the filter. The rules you add define what traffic gets mirrored.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilter.html}
  */
 export type EC2TrafficMirrorFilterProps = {
     /**
      * The description of the Traffic Mirror filter.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilter.html#cfn-ec2-trafficmirrorfilter-description}
      */
     Description?: string | undefined;
     /**
      * The network service traffic that is associated with the Traffic Mirror filter.
      *
      * Valid values are `amazon-dns` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilter.html#cfn-ec2-trafficmirrorfilter-networkservices}
      */
     NetworkServices?: string[] | undefined;
     /**
      * The tags to assign to a Traffic Mirror filter.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilter.html#cfn-ec2-trafficmirrorfilter-tags}
      */
     Tags?: Tag[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilter.html#aws-resource-ec2-trafficmirrorfilter-return-values}
+ */
 export type EC2TrafficMirrorFilterAttribs = {
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilter.html#cfn-ec2-trafficmirrorfilter-id}
+     */
     Id: string;
 };
 //# sourceMappingURL=aws-ec2-trafficmirrorfilter.d.ts.map

package/out/exports/resources.generated/aws-ec2-trafficmirrorfilterrule.d.ts

@@ -1,4 +1,12 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Creates a Traffic Mirror filter rule.
+ *
+ * A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror.
+ *
+ * You need the Traffic Mirror filter ID when you create the rule.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html}
+ */
 export type EC2TrafficMirrorFilterRule = ResourceDefinitionWithAttributes<"AWS::EC2::TrafficMirrorFilterRule", EC2TrafficMirrorFilterRuleProps, EC2TrafficMirrorFilterRuleAttribs>;
 /**
  * Creates a Traffic Mirror filter rule.
@@ -6,68 +14,89 @@ export type EC2TrafficMirrorFilterRule = ResourceDefinitionWithAttributes<"AWS::
  * A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror.
  *
  * You need the Traffic Mirror filter ID when you create the rule.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html}
  */
 export type EC2TrafficMirrorFilterRuleProps = {
     /**
      * The description of the Traffic Mirror rule.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-description}
      */
     Description?: string | undefined;
     /**
      * The destination CIDR block to assign to the Traffic Mirror rule.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-destinationcidrblock}
      */
     DestinationCidrBlock: string;
     /**
      * The destination port range.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-destinationportrange}
      */
     DestinationPortRange?: TrafficMirrorPortRange | undefined;
     /**
      * The protocol, for example UDP, to assign to the Traffic Mirror rule.
      *
      * For information about the protocol value, see [Protocol Numbers](https://docs.aws.amazon.com/https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) on the Internet Assigned Numbers Authority (IANA) website.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-protocol}
      */
     Protocol?: number | undefined;
     /**
      * The action to take on the filtered traffic.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-ruleaction}
      */
     RuleAction: string;
     /**
      * The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-rulenumber}
      */
     RuleNumber: number;
     /**
      * The source CIDR block to assign to the Traffic Mirror rule.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-sourcecidrblock}
      */
     SourceCidrBlock: string;
     /**
      * The source port range.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-sourceportrange}
      */
     SourcePortRange?: TrafficMirrorPortRange | undefined;
     /**
      * Tags on Traffic Mirroring filter rules.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-tags}
      */
     Tags?: Tag[] | undefined;
     /**
      * The type of traffic.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-trafficdirection}
      */
     TrafficDirection: string;
     /**
      * The ID of the filter that this rule is associated with.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-trafficmirrorfilterid}
      */
     TrafficMirrorFilterId: string;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#aws-resource-ec2-trafficmirrorfilterrule-return-values}
+ */
 export type EC2TrafficMirrorFilterRuleAttribs = {
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-id}
+     */
     Id: string;
 };
 /**
  * Describes the Traffic Mirror port range.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-trafficmirrorfilterrule-trafficmirrorportrange.html}
  */
 export type TrafficMirrorPortRange = {
     /**
      * The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-trafficmirrorfilterrule-trafficmirrorportrange.html#cfn-ec2-trafficmirrorfilterrule-trafficmirrorportrange-fromport}
      */
     FromPort: number;
     /**
      * The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-trafficmirrorfilterrule-trafficmirrorportrange.html#cfn-ec2-trafficmirrorfilterrule-trafficmirrorportrange-toport}
      */
     ToPort: number;
 };

package/out/exports/resources.generated/aws-ec2-trafficmirrorsession.d.ts

@@ -1,4 +1,14 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Creates a Traffic Mirror session.
+ *
+ * A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it to the session to define a subset of the traffic to mirror, for example all TCP traffic.
+ *
+ * The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in a different VPC connected via VPC peering or a transit gateway.
+ *
+ * By default, no traffic is mirrored. Use [AWS::EC2::TrafficMirrorFilterRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html) to specify filter rules that specify the traffic to mirror.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html}
+ */
 export type EC2TrafficMirrorSession = ResourceDefinitionWithAttributes<"AWS::EC2::TrafficMirrorSession", EC2TrafficMirrorSessionProps, EC2TrafficMirrorSessionAttribs>;
 /**
  * Creates a Traffic Mirror session.
@@ -8,14 +18,17 @@ export type EC2TrafficMirrorSession = ResourceDefinitionWithAttributes<"AWS::EC2
  * The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in a different VPC connected via VPC peering or a transit gateway.
  *
  * By default, no traffic is mirrored. Use [AWS::EC2::TrafficMirrorFilterRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html) to specify filter rules that specify the traffic to mirror.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html}
  */
 export type EC2TrafficMirrorSessionProps = {
     /**
      * The description of the Traffic Mirror session.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-description}
      */
     Description?: string | undefined;
     /**
      * The ID of the source network interface.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-networkinterfaceid}
      */
     NetworkInterfaceId: string;
     /**
@@ -24,32 +37,44 @@ export type EC2TrafficMirrorSessionProps = {
      * If you do not want to mirror the entire packet, use the `PacketLength` parameter to specify the number of bytes in each packet to mirror.
      *
      * For sessions with Network Load Balancer (NLB) Traffic Mirror targets the default `PacketLength` will be set to 8500. Valid values are 1-8500. Setting a `PacketLength` greater than 8500 will result in an error response.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-packetlength}
      */
     PacketLength?: number | undefined;
     /**
      * The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
      *
      * Valid values are 1-32766.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-sessionnumber}
      */
     SessionNumber: number;
     /**
      * The tags to assign to a Traffic Mirror session.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-tags}
      */
     Tags?: Tag[] | undefined;
     /**
      * The ID of the Traffic Mirror filter.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-trafficmirrorfilterid}
      */
     TrafficMirrorFilterId: string;
     /**
      * The ID of the Traffic Mirror target.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-trafficmirrortargetid}
      */
     TrafficMirrorTargetId: string;
     /**
      * The VXLAN ID for the Traffic Mirror session. For more information about the VXLAN protocol, see [RFC 7348](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc7348) . If you do not specify a `VirtualNetworkId` , an account-wide unique ID is chosen at random.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-virtualnetworkid}
      */
     VirtualNetworkId?: number | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#aws-resource-ec2-trafficmirrorsession-return-values}
+ */
 export type EC2TrafficMirrorSessionAttribs = {
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-id}
+     */
     Id: string;
 };
 //# sourceMappingURL=aws-ec2-trafficmirrorsession.d.ts.map

package/out/exports/resources.generated/aws-ec2-trafficmirrortarget.d.ts

@@ -1,4 +1,14 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Specifies a target for your Traffic Mirror session.
+ *
+ * A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in different VPCs connected via VPC peering or a transit gateway.
+ *
+ * A Traffic Mirror target can be a network interface, a Network Load Balancer, or a Gateway Load Balancer endpoint.
+ *
+ * To use the target in a Traffic Mirror session, use [AWS::EC2::TrafficMirrorSession](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html}
+ */
 export type EC2TrafficMirrorTarget = ResourceDefinitionWithAttributes<"AWS::EC2::TrafficMirrorTarget", EC2TrafficMirrorTargetProps, EC2TrafficMirrorTargetAttribs>;
 /**
  * Specifies a target for your Traffic Mirror session.
@@ -8,30 +18,42 @@ export type EC2TrafficMirrorTarget = ResourceDefinitionWithAttributes<"AWS::EC2:
  * A Traffic Mirror target can be a network interface, a Network Load Balancer, or a Gateway Load Balancer endpoint.
  *
  * To use the target in a Traffic Mirror session, use [AWS::EC2::TrafficMirrorSession](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html}
  */
 export type EC2TrafficMirrorTargetProps = {
     /**
      * The description of the Traffic Mirror target.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#cfn-ec2-trafficmirrortarget-description}
      */
     Description?: string | undefined;
     /**
      * The ID of the Gateway Load Balancer endpoint.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#cfn-ec2-trafficmirrortarget-gatewayloadbalancerendpointid}
      */
     GatewayLoadBalancerEndpointId?: string | undefined;
     /**
      * The network interface ID that is associated with the target.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#cfn-ec2-trafficmirrortarget-networkinterfaceid}
      */
     NetworkInterfaceId?: string | undefined;
     /**
      * The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#cfn-ec2-trafficmirrortarget-networkloadbalancerarn}
      */
     NetworkLoadBalancerArn?: string | undefined;
     /**
      * The tags to assign to the Traffic Mirror target.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#cfn-ec2-trafficmirrortarget-tags}
      */
     Tags?: Tag[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#aws-resource-ec2-trafficmirrortarget-return-values}
+ */
 export type EC2TrafficMirrorTargetAttribs = {
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#cfn-ec2-trafficmirrortarget-id}
+     */
     Id: string;
 };
 //# sourceMappingURL=aws-ec2-trafficmirrortarget.d.ts.map