@awboost/cfn-resource-types 0.1.22 → 0.1.24

package/lib/AWS-EC2-VPC.d.ts

@@ -1,38 +1,42 @@
 import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
 import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
 /**
- * Resource Type definition for AWS::EC2::VPC
+ * Resource type definition for `AWS::EC2::VPC`.
+ * Specifies a virtual private cloud (VPC).
+ You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).
+ For more information, see [Virtual private clouds (VPC)](https://docs.aws.amazon.com/vpc/latest/userguide/configure-your-vpc.html) in the *Amazon VPC User Guide*.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html}
  */
 export type EC2VPCProperties = {
     /**
-     * The primary IPv4 CIDR block for the VPC.
-     */
+       * The IPv4 network range for the VPC, in CIDR notation. For example, ``10.0.0.0/16``. We modify the specified CIDR block to its canonical form; for example, if you specify ``100.68.0.18/18``, we modify it to ``100.68.0.0/18``.
+       You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``.
+       */
     CidrBlock?: string;
     /**
-     * Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs.
-     */
+       * Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).
+       You can only enable DNS hostnames if you've enabled DNS support.
+       */
     EnableDnsHostnames?: boolean;
     /**
-     * Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default.
+     * Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).
      */
     EnableDnsSupport?: boolean;
     /**
        * The allowed tenancy of instances launched into the VPC.
-      
-      "default": An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch.
-      
-      "dedicated": An instance launched into the VPC is a Dedicated Instance by default, unless you explicitly specify a tenancy of host during instance launch. You cannot specify a tenancy of default during instance launch.
-      
-      Updating InstanceTenancy requires no replacement only if you are updating its value from "dedicated" to "default". Updating InstanceTenancy from "default" to "dedicated" requires replacement.
+        +  ``default``: An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch.
+        +  ``dedicated``: An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy of ``host`` during instance launch. You cannot specify a tenancy of ``default`` during instance launch.
+        
+       Updating ``InstanceTenancy`` requires no replacement only if you are updating its value from ``dedicated`` to ``default``. Updating ``InstanceTenancy`` from ``default`` to ``dedicated`` requires replacement.
        */
     InstanceTenancy?: string;
     /**
-     * The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR
-     */
+       * The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.
+       You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``.
+       */
     Ipv4IpamPoolId?: string;
     /**
-     * The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool
+     * The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.
      */
     Ipv4NetmaskLength?: number;
     /**
@@ -45,37 +49,32 @@ export type EC2VPCProperties = {
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#aws-resource-ec2-vpc-return-values}
  */
 export type EC2VPCAttributes = {
-    /**
-     * A list of IPv4 CIDR block association IDs for the VPC.
-     */
     CidrBlockAssociations: string[];
-    /**
-     * The default network ACL ID that is associated with the VPC.
-     */
     DefaultNetworkAcl: string;
-    /**
-     * The default security group ID that is associated with the VPC.
-     */
     DefaultSecurityGroup: string;
-    /**
-     * A list of IPv6 CIDR blocks that are associated with the VPC.
-     */
     Ipv6CidrBlocks: string[];
-    /**
-     * The Id for the model.
-     */
     VpcId: string;
 };
 /**
  * Type definition for `AWS::EC2::VPC.Tag`.
+ * Specifies a tag. For more information, see [Add tags to a resource](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#cloudformation-add-tag-specifications).
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpc-tag.html}
  */
 export type Tag = {
+    /**
+     * The tag key.
+     */
     Key: string;
+    /**
+     * The tag value.
+     */
     Value: string;
 };
 /**
- * Resource Type definition for AWS::EC2::VPC
+ * Resource type definition for `AWS::EC2::VPC`.
+ * Specifies a virtual private cloud (VPC).
+ You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).
+ For more information, see [Virtual private clouds (VPC)](https://docs.aws.amazon.com/vpc/latest/userguide/configure-your-vpc.html) in the *Amazon VPC User Guide*.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html}
  */
 export declare class EC2VPC extends $Resource<"AWS::EC2::VPC", EC2VPCProperties, EC2VPCAttributes> {

package/lib/AWS-EC2-VPC.js

@@ -1,6 +1,9 @@
 import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
 /**
- * Resource Type definition for AWS::EC2::VPC
+ * Resource type definition for `AWS::EC2::VPC`.
+ * Specifies a virtual private cloud (VPC).
+ You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).
+ For more information, see [Virtual private clouds (VPC)](https://docs.aws.amazon.com/vpc/latest/userguide/configure-your-vpc.html) in the *Amazon VPC User Guide*.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html}
  */
 export class EC2VPC extends $Resource {