CloudFormation Template Schema upgrade (#345)

https://github.com/aws-cloudformation/cloudformation-template-schema/tree/main Co-authored-by: kddejong <[email protected]>
aws-cloudformation · Nov 2, 2023 · b1d7c8e · b1d7c8e
1 parent 655b77c
commit b1d7c8e
Show file tree

Hide file tree

Showing 116 changed files with 13,787 additions and 10,443 deletions.
diff --git a/server/schema/resources.schema.json b/server/schema/resources.schema.json
diff --git a/server/schema/resources/aws-amplify-branch.json b/server/schema/resources/aws-amplify-branch.json
@@ -1,6 +1,7 @@
 {
   "typeName": "AWS::Amplify::Branch",
   "description": "The AWS::Amplify::Branch resource creates a new branch within an app.",
+  "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-amplify",
   "additionalProperties": false,
   "properties": {
     "AppId": {
@@ -12,6 +13,9 @@
     "BasicAuthConfig": {
       "$ref": "#/definitions/BasicAuthConfig"
     },
+    "Backend": {
+      "$ref": "#/definitions/Backend"
+    },
     "BranchName": {
       "type": "string",
       "minLength": 1,
@@ -80,6 +84,19 @@
     }
   },
   "definitions": {
+    "Backend": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "StackArn": {
+          "type": "string",
+          "minLength": 20,
+          "maxLength": 2048,
+          "markdownDescription": "\n\n---\n\nRequired: No  \nType: String  \nMinimum Length: 20  \nMaximum Length: 2048  \nUpdate requires: No interruption"
+        }
+      },
+      "markdownDescription": "\n\n---\n\nRequired: No  \nUpdate requires: No interruption"
+    },
     "EnvironmentVariable": {
       "type": "object",
       "additionalProperties": false,
@@ -199,6 +216,16 @@
       ]
     },
     "list": {
+      "handlerSchema": {
+        "properties": {
+          "AppId": {
+            "$ref": "resource-schema.json#/properties/AppId"
+          }
+        },
+        "required": [
+          "AppId"
+        ]
+      },
       "permissions": [
         "amplify:GetBranch",
         "amplify:ListBranches",

diff --git a/server/schema/resources/aws-apigateway-account.json b/server/schema/resources/aws-apigateway-account.json
@@ -1,13 +1,13 @@
 {
   "typeName": "AWS::ApiGateway::Account",
-  "description": "Resource Type definition for AWS::ApiGateway::Account",
+  "description": "The ``AWS::ApiGateway::Account`` resource specifies the IAM role that Amazon API Gateway uses to write API logs to Amazon CloudWatch Logs. To avoid overwriting other roles, you should only have one ``AWS::ApiGateway::Account`` resource per region per account.",
   "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway",
   "additionalProperties": false,
   "properties": {
     "CloudWatchRoleArn": {
-      "description": "The Amazon Resource Name (ARN) of an IAM role that has write access to CloudWatch Logs in your account.",
+      "description": "The ARN of an Amazon CloudWatch role for the current Account.",
       "type": "string",
-      "markdownDescription": "The Amazon Resource Name (ARN) of an IAM role that has write access to CloudWatch Logs in your account.\n\n---\n\nRequired: No  \nType: String  \nUpdate requires: No interruption"
+      "markdownDescription": "The ARN of an Amazon CloudWatch role for the current Account.\n\n---\n\nRequired: No  \nType: String  \nUpdate requires: No interruption"
     }
   },
   "primaryIdentifier": [

diff --git a/server/schema/resources/aws-apigateway-apikey.json b/server/schema/resources/aws-apigateway-apikey.json
@@ -1,57 +1,57 @@
 {
   "typeName": "AWS::ApiGateway::ApiKey",
-  "description": "Resource Type definition for AWS::ApiGateway::ApiKey",
+  "description": "The ``AWS::ApiGateway::ApiKey`` resource creates a unique key that you can distribute to clients who are executing API Gateway ``Method`` resources that require an API key. To specify which API key clients must use, map the API key with the ``RestApi`` and ``Stage`` resources that include the methods that require a key.",
   "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway",
   "additionalProperties": false,
   "properties": {
     "CustomerId": {
-      "description": "An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.",
+      "description": "An MKT customer identifier, when integrating with the AWS SaaS Marketplace.",
       "type": "string",
-      "markdownDescription": "An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.\n\n---\n\nRequired: No  \nType: String  \nUpdate requires: No interruption"
+      "markdownDescription": "An MKT customer identifier, when integrating with the AWS SaaS Marketplace.\n\n---\n\nRequired: No  \nType: String  \nUpdate requires: No interruption"
     },
     "Description": {
-      "description": "A description of the purpose of the API key.",
+      "description": "The description of the ApiKey.",
       "type": "string",
-      "markdownDescription": "A description of the purpose of the API key.\n\n---\n\nRequired: No  \nType: String  \nUpdate requires: No interruption"
+      "markdownDescription": "The description of the ApiKey.\n\n---\n\nRequired: No  \nType: String  \nUpdate requires: No interruption"
     },
     "Enabled": {
-      "description": "Indicates whether the API key can be used by clients.",
+      "description": "Specifies whether the ApiKey can be used by callers.",
       "default": false,
       "type": "boolean",
-      "markdownDescription": "Indicates whether the API key can be used by clients.\n\n---\n\nRequired: No  \nType: Boolean  \nUpdate requires: No interruption"
+      "markdownDescription": "Specifies whether the ApiKey can be used by callers.\n\n---\n\nRequired: No  \nType: Boolean  \nUpdate requires: No interruption"
     },
     "GenerateDistinctId": {
-      "description": "Specifies whether the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.",
+      "description": "Specifies whether (``true``) or not (``false``) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.",
       "type": "boolean",
-      "markdownDescription": "Specifies whether the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.\n\n---\n\nRequired: No  \nType: Boolean  \nUpdate requires: Replacement"
+      "markdownDescription": "Specifies whether (``true``) or not (``false``) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.\n\n---\n\nRequired: No  \nType: Boolean  \nUpdate requires: Replacement"
     },
     "Name": {
-      "description": "A name for the API key. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name.",
+      "description": "A name for the API key. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the API key name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.",
       "type": "string",
-      "markdownDescription": "A name for the API key. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name.\n\n---\n\nRequired: No  \nType: String  \nUpdate requires: Replacement"
+      "markdownDescription": "A name for the API key. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the API key name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.\n\n---\n\nRequired: No  \nType: String  \nUpdate requires: Replacement"
     },
     "StageKeys": {
-      "description": "A list of stages to associate with this API key.",
+      "description": "DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.",
       "type": "array",
       "uniqueItems": true,
       "items": {
         "$ref": "#/definitions/StageKey"
       },
-      "markdownDescription": "A list of stages to associate with this API key.\n\n---\n\nRequired: No  \nType: Array  \nUpdate requires: No interruption"
+      "markdownDescription": "DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.\n\n---\n\nRequired: No  \nType: Array  \nUpdate requires: No interruption"
     },
     "Tags": {
-      "description": "An array of arbitrary tags (key-value pairs) to associate with the API key.",
+      "description": "The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters.",
       "type": "array",
       "uniqueItems": false,
       "items": {
         "$ref": "#/definitions/Tag"
       },
-      "markdownDescription": "An array of arbitrary tags (key-value pairs) to associate with the API key.\n\n---\n\nRequired: No  \nType: Array  \nUpdate requires: No interruption"
+      "markdownDescription": "The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters.\n\n---\n\nRequired: No  \nType: Array  \nUpdate requires: No interruption"
     },
     "Value": {
-      "description": "The value of the API key. Must be at least 20 characters long.",
+      "description": "Specifies a value of the API key.",
       "type": "string",
-      "markdownDescription": "The value of the API key. Must be at least 20 characters long.\n\n---\n\nRequired: No  \nType: String  \nUpdate requires: Replacement"
+      "markdownDescription": "Specifies a value of the API key.\n\n---\n\nRequired: No  \nType: String  \nUpdate requires: Replacement"
     }
   },
   "definitions": {
@@ -60,17 +60,18 @@
       "additionalProperties": false,
       "properties": {
         "RestApiId": {
-          "description": "The ID of a RestApi resource that includes the stage with which you want to associate the API key.",
+          "description": "The string identifier of the associated RestApi.",
           "type": "string",
-          "markdownDescription": "The ID of a RestApi resource that includes the stage with which you want to associate the API key.\n\n---\n\nRequired: No  \nType: String  \nUpdate requires: No interruption"
+          "markdownDescription": "The string identifier of the associated RestApi.\n\n---\n\nRequired: No  \nType: String  \nUpdate requires: No interruption"
         },
         "StageName": {
-          "description": "The name of the stage with which to associate the API key. The stage must be included in the RestApi resource that you specified in the RestApiId property. ",
+          "description": "The stage name associated with the stage key.",
           "type": "string",
-          "markdownDescription": "The name of the stage with which to associate the API key. The stage must be included in the RestApi resource that you specified in the RestApiId property. \n\n---\n\nRequired: No  \nType: String  \nUpdate requires: No interruption"
+          "markdownDescription": "The stage name associated with the stage key.\n\n---\n\nRequired: No  \nType: String  \nUpdate requires: No interruption"
         }
       },
-      "markdownDescription": "\n\n---\n\nRequired: No  \nUpdate requires: No interruption"
+      "description": "``StageKey`` is a property of the [AWS::ApiGateway::ApiKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html) resource that specifies the stage to associate with the API key. This association allows only clients with the key to make requests to methods in that stage.",
+      "markdownDescription": "``StageKey`` is a property of the [AWS::ApiGateway::ApiKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html) resource that specifies the stage to associate with the API key. This association allows only clients with the key to make requests to methods in that stage.\n\n---\n\nRequired: No  \nUpdate requires: No interruption"
     },
     "Tag": {
       "type": "object",
@@ -115,7 +116,8 @@
     "create": {
       "permissions": [
         "apigateway:POST",
-        "apigateway:GET"
+        "apigateway:GET",
+        "apigateway:PUT"
       ]
     },
     "read": {
@@ -133,7 +135,8 @@
     },
     "delete": {
       "permissions": [
-        "apigateway:DELETE"
+        "apigateway:DELETE",
+        "apigateway:GET"
       ]
     },
     "list": {