@propulsionworks/cloudformation 0.1.0 → 0.1.2

package/out/exports/resources.generated/aws-resiliencehub-resiliencypolicy.d.ts

@@ -1,62 +1,97 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * Defines a resiliency policy.
+ *
+ * > AWS Resilience Hub allows you to provide a value of zero for `rtoInSecs` and `rpoInSecs` of your resiliency policy. But, while assessing your application, the lowest possible assessment result is near zero. Hence, if you provide value zero for `rtoInSecs` and `rpoInSecs` , the estimated workload RTO and estimated workload RPO result will be near zero and the *Compliance status* for your application will be set to *Policy breached* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-resiliencypolicy.html}
+ */
 export type ResilienceHubResiliencyPolicy = ResourceDefinitionWithAttributes<"AWS::ResilienceHub::ResiliencyPolicy", ResilienceHubResiliencyPolicyProps, ResilienceHubResiliencyPolicyAttribs>;
 /**
  * Defines a resiliency policy.
  *
  * > AWS Resilience Hub allows you to provide a value of zero for `rtoInSecs` and `rpoInSecs` of your resiliency policy. But, while assessing your application, the lowest possible assessment result is near zero. Hence, if you provide value zero for `rtoInSecs` and `rpoInSecs` , the estimated workload RTO and estimated workload RPO result will be near zero and the *Compliance status* for your application will be set to *Policy breached* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-resiliencypolicy.html}
  */
 export type ResilienceHubResiliencyPolicyProps = {
     /**
      * Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-resiliencypolicy.html#cfn-resiliencehub-resiliencypolicy-datalocationconstraint}
      */
     DataLocationConstraint?: "AnyLocation" | "SameContinent" | "SameCountry" | undefined;
     /**
      * The resiliency policy.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-resiliencypolicy.html#cfn-resiliencehub-resiliencypolicy-policy}
      */
     Policy: PolicyMap;
     /**
      * Description of the resiliency policy.
      * @maxLength 500
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-resiliencypolicy.html#cfn-resiliencehub-resiliencypolicy-policydescription}
      */
     PolicyDescription?: string | undefined;
     /**
      * The name of the policy
      * @pattern ^[A-Za-z0-9][A-Za-z0-9_\-]{1,59}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-resiliencypolicy.html#cfn-resiliencehub-resiliencypolicy-policyname}
      */
     PolicyName: string;
     /**
      * Tags assigned to the resource. A tag is a label that you assign to an AWS resource. Each tag consists of a key/value pair.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-resiliencypolicy.html#cfn-resiliencehub-resiliencypolicy-tags}
      */
     Tags?: Record<string, string> | undefined;
     /**
      * The tier for this resiliency policy, ranging from the highest severity ( `MissionCritical` ) to lowest ( `NonCritical` ).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-resiliencypolicy.html#cfn-resiliencehub-resiliencypolicy-tier}
      */
     Tier: "MissionCritical" | "Critical" | "Important" | "CoreServices" | "NonCritical";
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-resiliencypolicy.html#aws-resource-resiliencehub-resiliencypolicy-return-values}
+ */
 export type ResilienceHubResiliencyPolicyAttribs = {
     /**
      * Amazon Resource Name (ARN) of the resiliency policy.
      * @pattern ^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-resiliencypolicy.html#cfn-resiliencehub-resiliencypolicy-policyarn}
      */
     PolicyArn: string;
 };
 /**
  * Defines a failure policy.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-resiliencypolicy-failurepolicy.html}
  */
 export type FailurePolicy = {
     /**
      * Recovery Point Objective (RPO) in seconds.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-resiliencypolicy-failurepolicy.html#cfn-resiliencehub-resiliencypolicy-failurepolicy-rpoinsecs}
      */
     RpoInSecs: number;
     /**
      * Recovery Time Objective (RTO) in seconds.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-resiliencypolicy-failurepolicy.html#cfn-resiliencehub-resiliencypolicy-failurepolicy-rtoinsecs}
      */
     RtoInSecs: number;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-resiliencypolicy-policymap.html}
+ */
 export type PolicyMap = {
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-resiliencypolicy-policymap.html#cfn-resiliencehub-resiliencypolicy-policymap-az}
+     */
     AZ: FailurePolicy;
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-resiliencypolicy-policymap.html#cfn-resiliencehub-resiliencypolicy-policymap-hardware}
+     */
     Hardware: FailurePolicy;
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-resiliencypolicy-policymap.html#cfn-resiliencehub-resiliencypolicy-policymap-region}
+     */
     Region?: FailurePolicy | undefined;
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-resiliencypolicy-policymap.html#cfn-resiliencehub-resiliencypolicy-policymap-software}
+     */
     Software: FailurePolicy;
 };
 //# sourceMappingURL=aws-resiliencehub-resiliencypolicy.d.ts.map

package/out/exports/resources.generated/aws-resourceexplorer2-defaultviewassociation.d.ts

@@ -1,20 +1,30 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * Sets the specified view as the default for the AWS Region in which you call this operation. If a user makes a search query that doesn't explicitly specify the view to use, Resource Explorer chooses this default view automatically for searches performed in this AWS Region .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-defaultviewassociation.html}
+ */
 export type ResourceExplorer2DefaultViewAssociation = ResourceDefinitionWithAttributes<"AWS::ResourceExplorer2::DefaultViewAssociation", ResourceExplorer2DefaultViewAssociationProps, ResourceExplorer2DefaultViewAssociationAttribs>;
 /**
  * Sets the specified view as the default for the AWS Region in which you call this operation. If a user makes a search query that doesn't explicitly specify the view to use, Resource Explorer chooses this default view automatically for searches performed in this AWS Region .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-defaultviewassociation.html}
  */
 export type ResourceExplorer2DefaultViewAssociationProps = {
     /**
      * The ARN of the view to set as the default for the AWS Region and AWS account in which you call this operation. The specified view must already exist in the specified Region.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-defaultviewassociation.html#cfn-resourceexplorer2-defaultviewassociation-viewarn}
      */
     ViewArn: string;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-defaultviewassociation.html#aws-resource-resourceexplorer2-defaultviewassociation-return-values}
+ */
 export type ResourceExplorer2DefaultViewAssociationAttribs = {
     /**
      * The unique identifier of the principal for which the specified view was made the default for the AWS Region that contains the view. For example:
      *
      * `123456789012`
      * @pattern ^[0-9]{12}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-defaultviewassociation.html#cfn-resourceexplorer2-defaultviewassociation-associatedawsprincipal}
      */
     AssociatedAwsPrincipal: string;
 };

package/out/exports/resources.generated/aws-resourceexplorer2-index.d.ts

@@ -1,4 +1,14 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * Turns on Resource Explorer in the AWS Region in which you called this operation by creating an index. Resource Explorer begins discovering the resources in this Region and stores the details about the resources in the index so that they can be queried by using the [Search](https://docs.aws.amazon.com/resource-explorer/latest/apireference/API_Search.html) operation.
+ *
+ * You can create either a local index that returns search results from only the AWS Region in which the index exists, or you can create an aggregator index that returns search results from all AWS Regions in the AWS account .
+ *
+ * For more details about what happens when you turn on Resource Explorer in an AWS Region , see [Turning on Resource Explorer to index your resources in an AWS Region](https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-service-activate.html) in the *AWS Resource Explorer User Guide.*
+ *
+ * If this is the first AWS Region in which you've created an index for Resource Explorer, this operation also creates a service-linked role in your AWS account that allows Resource Explorer to search for your resources and populate the index.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-index.html}
+ */
 export type ResourceExplorer2Index = ResourceDefinitionWithAttributes<"AWS::ResourceExplorer2::Index", ResourceExplorer2IndexProps, ResourceExplorer2IndexAttribs>;
 /**
  * Turns on Resource Explorer in the AWS Region in which you called this operation by creating an index. Resource Explorer begins discovering the resources in this Region and stores the details about the resources in the index so that they can be queried by using the [Search](https://docs.aws.amazon.com/resource-explorer/latest/apireference/API_Search.html) operation.
@@ -8,31 +18,45 @@ export type ResourceExplorer2Index = ResourceDefinitionWithAttributes<"AWS::Reso
  * For more details about what happens when you turn on Resource Explorer in an AWS Region , see [Turning on Resource Explorer to index your resources in an AWS Region](https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-service-activate.html) in the *AWS Resource Explorer User Guide.*
  *
  * If this is the first AWS Region in which you've created an index for Resource Explorer, this operation also creates a service-linked role in your AWS account that allows Resource Explorer to search for your resources and populate the index.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-index.html}
  */
 export type ResourceExplorer2IndexProps = {
     /**
      * The specified tags are attached to only the index created in this AWS Region . The tags don't attach to any of the resources listed in the index.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-index.html#cfn-resourceexplorer2-index-tags}
      */
     Tags?: Record<string, string> | undefined;
     /**
      * Specifies the type of the index in this Region. For information about the aggregator index and how it differs from a local index, see [Turning on cross-Region search by creating an aggregator index](https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html) in the *AWS Resource Explorer User Guide.* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-index.html#cfn-resourceexplorer2-index-type}
      */
     Type: IndexType;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-index.html#aws-resource-resourceexplorer2-index-return-values}
+ */
 export type ResourceExplorer2IndexAttribs = {
     /**
      * The ARN of the new index for the AWS Region . For example:
      *
      * `arn:aws:resource-explorer-2:us-east-1:123456789012:index/EXAMPLE8-90ab-cdef-fedc-EXAMPLE22222`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-index.html#cfn-resourceexplorer2-index-arn}
      */
     Arn: string;
     /**
      * Indicates the current state of the index. For example:
      *
      * `CREATING`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-index.html#cfn-resourceexplorer2-index-indexstate}
      */
     IndexState: IndexState;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourceexplorer2-index-indexstate.html}
+ */
 export type IndexState = "ACTIVE" | "CREATING" | "DELETING" | "DELETED" | "UPDATING";
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourceexplorer2-index-indextype.html}
+ */
 export type IndexType = "LOCAL" | "AGGREGATOR";
 //# sourceMappingURL=aws-resourceexplorer2-index.d.ts.map

package/out/exports/resources.generated/aws-resourceexplorer2-view.d.ts

@@ -1,7 +1,12 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * Creates a view that users can query by using the [Search](https://docs.aws.amazon.com/resource-explorer/latest/apireference/API_Search.html) operation. Results from queries that you make using this view include only resources that match the view's `Filters` .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-view.html}
+ */
 export type ResourceExplorer2View = ResourceDefinitionWithAttributes<"AWS::ResourceExplorer2::View", ResourceExplorer2ViewProps, ResourceExplorer2ViewAttribs>;
 /**
  * Creates a view that users can query by using the [Search](https://docs.aws.amazon.com/resource-explorer/latest/apireference/API_Search.html) operation. Results from queries that you make using this view include only resources that match the view's `Filters` .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-view.html}
  */
 export type ResourceExplorer2ViewProps = {
     /**
@@ -10,47 +15,59 @@ export type ResourceExplorer2ViewProps = {
      * For information about the supported syntax, see [Search query reference for Resource Explorer](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html) in the *AWS Resource Explorer User Guide* .
      *
      * > This query string in the context of this operation supports only [filter prefixes](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters) with optional [operators](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators) . It doesn't support free-form text. For example, the string `region:us* service:ec2 -tag:stage=prod` includes all Amazon EC2 resources in any AWS Region that begin with the letters `us` and are *not* tagged with a key `Stage` that has the value `prod` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-view.html#cfn-resourceexplorer2-view-filters}
      */
     Filters?: SearchFilter | undefined;
     /**
      * A list of fields that provide additional information about the view.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-view.html#cfn-resourceexplorer2-view-includedproperties}
      */
     IncludedProperties?: IncludedProperty[] | undefined;
     /**
      * The root ARN of the account, an organizational unit (OU), or an organization ARN. If left empty, the default is account.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-view.html#cfn-resourceexplorer2-view-scope}
      */
     Scope?: string | undefined;
     /**
      * Tag key and value pairs that are attached to the view.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-view.html#cfn-resourceexplorer2-view-tags}
      */
     Tags?: Record<string, string> | undefined;
     /**
      * The name of the new view.
      * @pattern ^[a-zA-Z0-9\-]{1,64}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-view.html#cfn-resourceexplorer2-view-viewname}
      */
     ViewName: string;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-view.html#aws-resource-resourceexplorer2-view-return-values}
+ */
 export type ResourceExplorer2ViewAttribs = {
     /**
      * The ARN of the new view. For example:
      *
      * `arn:aws:resource-explorer-2:us-east-1:123456789012:view/MyView/EXAMPLE8-90ab-cdef-fedc-EXAMPLE22222`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-view.html#cfn-resourceexplorer2-view-viewarn}
      */
     ViewArn: string;
 };
 /**
  * Information about an additional property that describes a resource, that you can optionally include in a view.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourceexplorer2-view-includedproperty.html}
  */
 export type IncludedProperty = {
     /**
      * The name of the property that is included in this view.
      * @minLength 1
      * @maxLength 1011
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourceexplorer2-view-includedproperty.html#cfn-resourceexplorer2-view-includedproperty-name}
      */
     Name: string;
 };
 /**
  * A search filter defines which resources can be part of a search query result set.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourceexplorer2-view-searchfilter.html}
  */
 export type SearchFilter = {
     /**
@@ -61,6 +78,7 @@ export type SearchFilter = {
      * > This query string in the context of this operation supports only [filter prefixes](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters) with optional [operators](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators) . It doesn't support free-form text. For example, the string `region:us* service:ec2 -tag:stage=prod` includes all Amazon EC2 resources in any AWS Region that begin with the letters `us` and are *not* tagged with a key `Stage` that has the value `prod` .
      * @minLength 0
      * @maxLength 2048
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourceexplorer2-view-searchfilter.html#cfn-resourceexplorer2-view-searchfilter-filterstring}
      */
     FilterString: string;
 };

package/out/exports/resources.generated/aws-resourcegroups-group.d.ts

@@ -1,4 +1,14 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Creates a resource group with the specified name and description. You can optionally include either a resource query or a service configuration. For more information about constructing a resource query, see [Build queries and groups in AWS Resource Groups](https://docs.aws.amazon.com//ARG/latest/userguide/getting_started-query.html) in the *AWS Resource Groups User Guide* . For more information about service-linked groups and service configurations, see [Service configurations for Resource Groups](https://docs.aws.amazon.com//ARG/latest/APIReference/about-slg.html) .
+ *
+ * *Minimum permissions*
+ *
+ * To run this command, you must have the following permissions:
+ *
+ * - `resource-groups:CreateGroup`
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html}
+ */
 export type ResourceGroupsGroup = ResourceDefinitionWithAttributes<"AWS::ResourceGroups::Group", ResourceGroupsGroupProps, ResourceGroupsGroupAttribs>;
 /**
  * Creates a resource group with the specified name and description. You can optionally include either a resource query or a service configuration. For more information about constructing a resource query, see [Build queries and groups in AWS Resource Groups](https://docs.aws.amazon.com//ARG/latest/userguide/getting_started-query.html) in the *AWS Resource Groups User Guide* . For more information about service-linked groups and service configurations, see [Service configurations for Resource Groups](https://docs.aws.amazon.com//ARG/latest/APIReference/about-slg.html) .
@@ -8,22 +18,26 @@ export type ResourceGroupsGroup = ResourceDefinitionWithAttributes<"AWS::Resourc
  * To run this command, you must have the following permissions:
  *
  * - `resource-groups:CreateGroup`
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html}
  */
 export type ResourceGroupsGroupProps = {
     /**
      * The service configuration currently associated with the resource group and in effect for the members of the resource group. A `Configuration` consists of one or more `ConfigurationItem` entries. For information about service configurations for resource groups and how to construct them, see [Service configurations for resource groups](https://docs.aws.amazon.com//ARG/latest/APIReference/about-slg.html) in the *AWS Resource Groups User Guide* .
      *
      * > You can include either a `Configuration` or a `ResourceQuery` , but not both.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html#cfn-resourcegroups-group-configuration}
      */
     Configuration?: ConfigurationItem[] | undefined;
     /**
      * The description of the resource group.
      * @maxLength 512
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html#cfn-resourcegroups-group-description}
      */
     Description?: string | undefined;
     /**
      * The name of a resource group. The name must be unique within the AWS Region in which you create the resource. To create multiple resource groups based on the same CloudFormation stack, you must generate unique names for each.
      * @maxLength 128
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html#cfn-resourcegroups-group-name}
      */
     Name: string;
     /**
@@ -31,6 +45,7 @@ export type ResourceGroupsGroupProps = {
      *
      * > - You can include either a `ResourceQuery` or a `Configuration` , but not both.
      * > - You can specify the group's membership either by using a `ResourceQuery` or by using a list of `Resources` , but not both.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html#cfn-resourcegroups-group-resourcequery}
      */
     ResourceQuery?: ResourceQuery | undefined;
     /**
@@ -38,68 +53,85 @@ export type ResourceGroupsGroupProps = {
      *
      * > - You can specify the group membership either by using a list of `Resources` or by using a `ResourceQuery` , but not both.
      * > - You can include a `Resources` property only if you also specify a `Configuration` property.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html#cfn-resourcegroups-group-resources}
      */
     Resources?: string[] | undefined;
     /**
      * The tag key and value pairs that are attached to the resource group.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html#cfn-resourcegroups-group-tags}
      */
     Tags?: Tag[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html#aws-resource-resourcegroups-group-return-values}
+ */
 export type ResourceGroupsGroupAttribs = {
     /**
      * The ARN of the new resource group.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-group.html#cfn-resourcegroups-group-arn}
      */
     Arn: string;
 };
 /**
  * One of the items in the service configuration assigned to a resource group. A service configuration can consist of one or more items. For details service configurations and how to construct them, see [Service configurations for resource groups](https://docs.aws.amazon.com//ARG/latest/APIReference/about-slg.html) in the *AWS Resource Groups User Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-configurationitem.html}
  */
 export type ConfigurationItem = {
     /**
      * A collection of parameters for this configuration item. For the list of parameters that you can use with each configuration item `Type` , see [Supported resource types and parameters](https://docs.aws.amazon.com//ARG/latest/APIReference/about-slg.html#about-slg-types) in the *AWS Resource Groups User Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-configurationitem.html#cfn-resourcegroups-group-configurationitem-parameters}
      */
     Parameters?: ConfigurationParameter[] | undefined;
     /**
      * Specifies the type of configuration item. Each item must have a unique value for type. For the list of the types that you can specify for a configuration item, see [Supported resource types and parameters](https://docs.aws.amazon.com//ARG/latest/APIReference/about-slg.html#about-slg-types) in the *AWS Resource Groups User Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-configurationitem.html#cfn-resourcegroups-group-configurationitem-type}
      */
     Type?: string | undefined;
 };
 /**
  * One parameter for a group configuration item. For details about service configurations and how to construct them, see [Service configurations for resource groups](https://docs.aws.amazon.com//ARG/latest/APIReference/about-slg.html) in the *AWS Resource Groups User Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-configurationparameter.html}
  */
 export type ConfigurationParameter = {
     /**
      * The name of the group configuration parameter. For the list of parameters that you can use with each configuration item type, see [Supported resource types and parameters](https://docs.aws.amazon.com//ARG/latest/APIReference/about-slg.html#about-slg-types) in the *AWS Resource Groups User Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-configurationparameter.html#cfn-resourcegroups-group-configurationparameter-name}
      */
     Name?: string | undefined;
     /**
      * The value or values to be used for the specified parameter. For the list of values you can use with each parameter, see [Supported resource types and parameters](https://docs.aws.amazon.com//ARG/latest/APIReference/about-slg.html#about-slg-types) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-configurationparameter.html#cfn-resourcegroups-group-configurationparameter-values}
      */
     Values?: string[] | undefined;
 };
 /**
  * Specifies details within a `ResourceQuery` structure that determines the membership of the resource group. The contents required in the `Query` structure are determined by the `Type` property of the containing `ResourceQuery` structure.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-query.html}
  */
 export type Query = {
     /**
      * Specifies limits to the types of resources that can be included in the resource group. For example, if `ResourceTypeFilters` is `["AWS::EC2::Instance", "AWS::DynamoDB::Table"]` , only EC2 instances or DynamoDB tables can be members of this resource group. The default value is `["AWS::AllSupported"]` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-query.html#cfn-resourcegroups-group-query-resourcetypefilters}
      */
     ResourceTypeFilters?: string[] | undefined;
     /**
      * Specifies the ARN of a CloudFormation stack. All supported resources of the CloudFormation stack are members of the resource group. If you don't specify an ARN, this parameter defaults to the current stack that you are defining, which means that all the resources of the current stack are grouped.
      *
      * You can specify a value for `StackIdentifier` only when the `ResourceQuery.Type` property is `CLOUDFORMATION_STACK_1_0.`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-query.html#cfn-resourcegroups-group-query-stackidentifier}
      */
     StackIdentifier?: string | undefined;
     /**
      * A list of key-value pair objects that limit which resources can be members of the resource group. This property is required when the `ResourceQuery.Type` property is `TAG_FILTERS_1_0` .
      *
      * A resource must have a tag that matches every filter that is provided in the `TagFilters` list.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-query.html#cfn-resourcegroups-group-query-tagfilters}
      */
     TagFilters?: TagFilter[] | undefined;
 };
 /**
  * The query used to dynamically define the members of a group. For more information about how to construct a query, see [Build queries and groups in AWS Resource Groups](https://docs.aws.amazon.com//ARG/latest/userguide/gettingstarted-query.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-resourcequery.html}
  */
 export type ResourceQuery = {
     /**
@@ -109,6 +141,7 @@ export type ResourceQuery = {
      *
      * - When the `Type` is `TAG_FILTERS_1_0` , you must specify a `Query` structure that contains a `TagFilters` list of tags. Resources with tags that match those in the `TagFilter` list become members of the resource group.
      * - When the `Type` is `CLOUDFORMATION_STACK_1_0` then this field is required only when you must specify a CloudFormation stack other than the one you are defining. To do this, the `Query` structure must contain the `StackIdentifier` property. If you don't specify either a `Query` structure or a `StackIdentifier` within that `Query` , then it defaults to the CloudFormation stack that you're currently constructing.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-resourcequery.html#cfn-resourcegroups-group-resourcequery-query}
      */
     Query?: Query | undefined;
     /**
@@ -116,6 +149,7 @@ export type ResourceQuery = {
      *
      * - `TAG_FILTERS_1_0` indicates that the group is a tag-based group. To complete the group membership, you must include the `TagFilters` property to specify the tag filters to use in the query.
      * - `CLOUDFORMATION_STACK_1_0` , the default, indicates that the group is a CloudFormation stack-based group. Group membership is based on the CloudFormation stack. You must specify the `StackIdentifier` property in the query to define which stack to associate the group with, or leave it empty to default to the stack where the group is defined.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-resourcequery.html#cfn-resourcegroups-group-resourcequery-type}
      */
     Type?: "TAG_FILTERS_1_0" | "CLOUDFORMATION_STACK_1_0" | undefined;
 };
@@ -128,16 +162,19 @@ export type ResourceQuery = {
  *
  * - `Stage` tag key with a value of either `Test` or `Beta`
  * - `Storage` tag key with any value
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-tagfilter.html}
  */
 export type TagFilter = {
     /**
      * A string that defines a tag key. Only resources in the account that are tagged with a specified tag key are members of the tag-based resource group.
      *
      * This field is required when the `ResourceQuery` structure's `Type` property is `TAG_FILTERS_1_0` . You must specify at least one tag key.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-tagfilter.html#cfn-resourcegroups-group-tagfilter-key}
      */
     Key?: string | undefined;
     /**
      * A list of tag values that can be included in the tag-based resource group. This is optional. If you don't specify a value or values for a key, then an AWS resource with any value for that key is a member.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-tagfilter.html#cfn-resourcegroups-group-tagfilter-values}
      */
     Values?: string[] | undefined;
 };

package/out/exports/resources.generated/aws-resourcegroups-tagsynctask.d.ts

@@ -1,4 +1,16 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * Onboards and syncs resources tagged with a specific tag key-value pair to an application.
+ *
+ * *Minimum permissions*
+ *
+ * To run this command, you must have the following permissions:
+ *
+ * - `resource-groups:StartTagSyncTask`
+ * - `resource-groups:CreateGroup`
+ * - `iam:PassRole` for the role you provide to create a tag-sync task
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-tagsynctask.html}
+ */
 export type ResourceGroupsTagSyncTask = ResourceDefinitionWithAttributes<"AWS::ResourceGroups::TagSyncTask", ResourceGroupsTagSyncTaskProps, ResourceGroupsTagSyncTaskAttribs>;
 /**
  * Onboards and syncs resources tagged with a specific tag key-value pair to an application.
@@ -10,6 +22,7 @@ export type ResourceGroupsTagSyncTask = ResourceDefinitionWithAttributes<"AWS::R
  * - `resource-groups:StartTagSyncTask`
  * - `resource-groups:CreateGroup`
  * - `iam:PassRole` for the role you provide to create a tag-sync task
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-tagsynctask.html}
  */
 export type ResourceGroupsTagSyncTaskProps = {
     /**
@@ -17,6 +30,7 @@ export type ResourceGroupsTagSyncTaskProps = {
      * @minLength 12
      * @maxLength 1600
      * @pattern ([a-zA-Z0-9_\\.-]{1,150}/[a-z0-9]{26})|(arn:aws(-[a-z]+)*:resource-groups(-(test|beta|gamma))?:[a-z]{2}(-[a-z]+)+-\d{1}:[0-9]{12}:group/[a-zA-Z0-9_\\.-]{1,150}/[a-z0-9]{26})
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-tagsynctask.html#cfn-resourcegroups-tagsynctask-group}
      */
     Group: string;
     /**
@@ -24,6 +38,7 @@ export type ResourceGroupsTagSyncTaskProps = {
      * @minLength 20
      * @maxLength 2048
      * @pattern arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-tagsynctask.html#cfn-resourcegroups-tagsynctask-rolearn}
      */
     RoleArn: string;
     /**
@@ -31,6 +46,7 @@ export type ResourceGroupsTagSyncTaskProps = {
      * @minLength 1
      * @maxLength 128
      * @pattern ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-tagsynctask.html#cfn-resourcegroups-tagsynctask-tagkey}
      */
     TagKey: string;
     /**
@@ -38,15 +54,20 @@ export type ResourceGroupsTagSyncTaskProps = {
      * @minLength 0
      * @maxLength 256
      * @pattern ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-tagsynctask.html#cfn-resourcegroups-tagsynctask-tagvalue}
      */
     TagValue: string;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-tagsynctask.html#aws-resource-resourcegroups-tagsynctask-return-values}
+ */
 export type ResourceGroupsTagSyncTaskAttribs = {
     /**
      * The Amazon resource name (ARN) of the application group.
      * @minLength 12
      * @maxLength 1600
      * @pattern arn:aws(-[a-z]+)*:resource-groups(-(test|beta|gamma))?:[a-z]{2}(-[a-z]+)+-\d{1}:[0-9]{12}:group/[a-zA-Z0-9_\.-]{1,150}/[a-z0-9]{26}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-tagsynctask.html#cfn-resourcegroups-tagsynctask-grouparn}
      */
     GroupArn: string;
     /**
@@ -54,6 +75,7 @@ export type ResourceGroupsTagSyncTaskAttribs = {
      * @minLength 1
      * @maxLength 300
      * @pattern [a-zA-Z0-9_\.-]{1,150}/[a-z0-9]{26}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-tagsynctask.html#cfn-resourcegroups-tagsynctask-groupname}
      */
     GroupName: string;
     /**
@@ -63,6 +85,7 @@ export type ResourceGroupsTagSyncTaskAttribs = {
      *
      * - `ACTIVE` - The tag-sync task is actively managing resources in the application by adding or removing the `awsApplication` tag from resources when they are tagged or untagged with the specified tag key-value pair.
      * - `ERROR` - The tag-sync task is not actively managing resources in the application. Review the `ErrorMessage` for more information about resolving the error.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-tagsynctask.html#cfn-resourcegroups-tagsynctask-status}
      */
     Status: "ACTIVE" | "ERROR";
     /**
@@ -70,6 +93,7 @@ export type ResourceGroupsTagSyncTaskAttribs = {
      * @minLength 12
      * @maxLength 1600
      * @pattern arn:aws(-[a-z]+)*:resource-groups(-(test|beta|gamma))?:[a-z]{2}(-[a-z]+)+-\d{1}:[0-9]{12}:group/[a-zA-Z0-9_\.-]{1,150}/[a-z0-9]{26}/tag-sync-task/[a-z0-9]{26}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourcegroups-tagsynctask.html#cfn-resourcegroups-tagsynctask-taskarn}
      */
     TaskArn: string;
 };

package/out/exports/resources.generated/aws-robomaker-fleet.d.ts

@@ -1,4 +1,12 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * > The following resource is now deprecated. This resource can no longer be provisioned via stack create or update operations, and should not be included in your stack templates.
+ * >
+ * > We recommend migrating to AWS IoT Greengrass Version 2. For more information, see [Support Changes: May 2, 2022](https://docs.aws.amazon.com/robomaker/latest/dg/chapter-support-policy.html#software-support-policy-may2022) in the *AWS RoboMaker Developer Guide* .
+ *
+ * The `AWS::RoboMaker::Fleet` resource creates an AWS RoboMaker fleet. Fleets contain robots and can receive deployments.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-fleet.html}
+ */
 export type RoboMakerFleet = ResourceDefinitionWithAttributes<"AWS::RoboMaker::Fleet", RoboMakerFleetProps, RoboMakerFleetAttribs>;
 /**
  * > The following resource is now deprecated. This resource can no longer be provisioned via stack create or update operations, and should not be included in your stack templates.
@@ -6,6 +14,7 @@ export type RoboMakerFleet = ResourceDefinitionWithAttributes<"AWS::RoboMaker::F
  * > We recommend migrating to AWS IoT Greengrass Version 2. For more information, see [Support Changes: May 2, 2022](https://docs.aws.amazon.com/robomaker/latest/dg/chapter-support-policy.html#software-support-policy-may2022) in the *AWS RoboMaker Developer Guide* .
  *
  * The `AWS::RoboMaker::Fleet` resource creates an AWS RoboMaker fleet. Fleets contain robots and can receive deployments.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-fleet.html}
  */
 export type RoboMakerFleetProps = {
     /**
@@ -13,16 +22,22 @@ export type RoboMakerFleetProps = {
      * @minLength 1
      * @maxLength 255
      * @pattern [a-zA-Z0-9_\-]{1,255}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-fleet.html#cfn-robomaker-fleet-name}
      */
     Name?: string | undefined;
     /**
      * The list of all tags added to the fleet.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-fleet.html#cfn-robomaker-fleet-tags}
      */
     Tags?: Record<string, string> | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-fleet.html#aws-resource-robomaker-fleet-return-values}
+ */
 export type RoboMakerFleetAttribs = {
     /**
      * The Amazon Resource Name (ARN) of the fleet, such as `arn:aws:robomaker:us-west-2:123456789012:deployment-fleet/MyFleet/1539894765711` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-robomaker-fleet.html#cfn-robomaker-fleet-arn}
      */
     Arn: string;
 };