Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
830 changes: 805 additions & 25 deletions server/schema/resources.schema.json

Large diffs are not rendered by default.

15 changes: 0 additions & 15 deletions server/schema/resources/aws-amazonmq-broker.json
Original file line number Diff line number Diff line change
Expand Up @@ -77,21 +77,6 @@
},
"AuthenticationStrategy": {
"type": "string",
"anyOf": [
{
"enum": [
"SIMPLE",
"LDAP"
],
"type": "string"
},
{
"pattern": "^[Ss][Ii][Mm][Pp][Ll][Ee]$"
},
{
"pattern": "^[Ll][Dd][Aa][Pp]$"
}
],
"markdownDescription": "\n\n---\n\nRequired: No \nType: String \nUpdate requires: Replacement\n"
},
"LdapServerMetadata": {
Expand Down
2 changes: 1 addition & 1 deletion server/schema/resources/aws-apigateway-account.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"readOnlyProperties": [
"/properties/Id"
],
"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.",
"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. \n When you delete a stack containing this resource, API Gateway can still assume the provided IAM role to write API logs to CloudWatch Logs. To deny API Gateway access to write API logs to CloudWatch logs, update the permissions policies or change the IAM role to deny access.",
"additionalProperties": false,
"primaryIdentifier": [
"/properties/Id"
Expand Down
16 changes: 8 additions & 8 deletions server/schema/resources/aws-apigateway-apikey.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@
"markdownDescription": "\n\n---\n\nRequired: No \nType: Boolean \nUpdate requires: Replacement\n"
},
"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.",
"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, 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\n"
"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\n"
},
"StageKeys": {
"description": "",
Expand Down Expand Up @@ -83,25 +83,25 @@
"additionalProperties": false,
"properties": {
"Key": {
"description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.",
"description": "A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.",
"type": "string",
"minLength": 1,
"maxLength": 128,
"markdownDescription": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.\n\n---\n\nRequired: Yes \nType: String \nMinimum Length: 1 \nMaximum Length: 128 \nUpdate requires: No interruption\n"
"markdownDescription": "A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.\n\n---\n\nRequired: Yes \nType: String \nMinimum Length: 1 \nMaximum Length: 128 \nUpdate requires: No interruption\n"
},
"Value": {
"description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ",
"description": "The value for the specified tag key.",
"type": "string",
"maxLength": 256,
"markdownDescription": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. \n\n---\n\nRequired: Yes \nType: String \nMaximum Length: 256 \nUpdate requires: No interruption\n"
"markdownDescription": "The value for the specified tag key.\n\n---\n\nRequired: Yes \nType: String \nMaximum Length: 256 \nUpdate requires: No interruption\n"
}
},
"required": [
"Value",
"Key"
],
"description": "",
"markdownDescription": "\n\n---\n\nRequired: No \nUpdate requires: No interruption\n"
"description": "An array of key-value pairs to apply to this resource.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).",
"markdownDescription": "An array of key-value pairs to apply to this resource.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).\n\n---\n\nRequired: No \nUpdate requires: No interruption\n"
}
},
"tagging": {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"typeName": "AWS::ApiGateway::BasePathMapping",
"description": "The ``AWS::ApiGateway::BasePathMapping`` resource creates a base path that clients who call your API must use in the invocation URL.",
"description": "The ``AWS::ApiGateway::BasePathMapping`` resource creates a base path that clients who call your API must use in the invocation URL. Supported only for public custom domain names.",
"sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway",
"additionalProperties": false,
"properties": {
Expand Down
10 changes: 6 additions & 4 deletions server/schema/resources/aws-apigateway-clientcertificate.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,21 @@
"properties": {
"Key": {
"type": "string",
"markdownDescription": "\n\n---\n\nRequired: Yes \nType: String \nUpdate requires: No interruption\n"
"description": "A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.",
"markdownDescription": "A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.\n\n---\n\nRequired: Yes \nType: String \nUpdate requires: No interruption\n"
},
"Value": {
"type": "string",
"markdownDescription": "\n\n---\n\nRequired: Yes \nType: String \nUpdate requires: No interruption\n"
"description": "The value for the specified tag key.",
"markdownDescription": "The value for the specified tag key.\n\n---\n\nRequired: Yes \nType: String \nUpdate requires: No interruption\n"
}
},
"required": [
"Value",
"Key"
],
"description": "",
"markdownDescription": "\n\n---\n\nRequired: No \nUpdate requires: No interruption\n"
"description": "An array of key-value pairs to apply to this resource.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).",
"markdownDescription": "An array of key-value pairs to apply to this resource.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).\n\n---\n\nRequired: No \nUpdate requires: No interruption\n"
}
},
"tagging": {
Expand Down
16 changes: 8 additions & 8 deletions server/schema/resources/aws-apigateway-deployment.json
Original file line number Diff line number Diff line change
Expand Up @@ -279,26 +279,26 @@
"markdownDescription": "The ``CanarySetting`` property type specifies settings for the canary deployment in this stage.\n ``CanarySetting`` is a property of the [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type.\n\n---\n\nRequired: No \nUpdate requires: No interruption\n"
},
"Tag": {
"description": "",
"description": "An array of key-value pairs to apply to this resource.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).",
"additionalProperties": false,
"type": "object",
"properties": {
"Value": {
"description": "The value for the tag",
"description": "The value for the specified tag key.",
"type": "string",
"markdownDescription": "The value for the tag\n\n---\n\nRequired: Yes \nType: String \nUpdate requires: No interruption\n"
"markdownDescription": "The value for the specified tag key.\n\n---\n\nRequired: Yes \nType: String \nUpdate requires: No interruption\n"
},
"Key": {
"description": "The key name of the tag",
"description": "A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.",
"type": "string",
"markdownDescription": "The key name of the tag\n\n---\n\nRequired: Yes \nType: String \nUpdate requires: No interruption\n"
"markdownDescription": "A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.\n\n---\n\nRequired: Yes \nType: String \nUpdate requires: No interruption\n"
}
},
"required": [
"Value",
"Key"
],
"markdownDescription": "\n\n---\n\nRequired: No \nUpdate requires: No interruption\n"
"markdownDescription": "An array of key-value pairs to apply to this resource.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).\n\n---\n\nRequired: No \nUpdate requires: No interruption\n"
},
"DeploymentCanarySettings": {
"description": "The ``DeploymentCanarySettings`` property type specifies settings for the canary deployment.",
Expand Down Expand Up @@ -331,7 +331,7 @@
"markdownDescription": "The ``DeploymentCanarySettings`` property type specifies settings for the canary deployment.\n\n---\n\nRequired: No \nUpdate requires: No interruption\n"
},
"AccessLogSetting": {
"description": "The ``AccessLogSetting`` property type specifies settings for logging access in this stage.\n ``AccessLogSetting`` is a property of the [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type.",
"description": "The ``AccessLogSetting`` property type specifies settings for logging access in this stage.\n ``AccessLogSetting`` is a property of the [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type.",
"additionalProperties": false,
"type": "object",
"properties": {
Expand All @@ -346,7 +346,7 @@
"markdownDescription": "\n\n---\n\nRequired: No \nType: String \nUpdate requires: No interruption\n"
}
},
"markdownDescription": "The ``AccessLogSetting`` property type specifies settings for logging access in this stage.\n ``AccessLogSetting`` is a property of the [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type.\n\n---\n\nRequired: No \nUpdate requires: No interruption\n"
"markdownDescription": "The ``AccessLogSetting`` property type specifies settings for logging access in this stage.\n ``AccessLogSetting`` is a property of the [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type.\n\n---\n\nRequired: No \nUpdate requires: No interruption\n"
}
},
"properties": {
Expand Down
4 changes: 2 additions & 2 deletions server/schema/resources/aws-apigateway-documentationpart.json
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,8 @@
"markdownDescription": "\n\n---\n\nRequired: No \nType: String \nAllowed Values: API | AUTHORIZER | MODEL | RESOURCE | METHOD | PATH_PARAMETER | QUERY_PARAMETER | REQUEST_HEADER | REQUEST_BODY | RESPONSE | RESPONSE_HEADER | RESPONSE_BODY \nUpdate requires: No interruption\n"
}
},
"description": "The ``Location`` property specifies the location of the Amazon API Gateway API entity that the documentation applies to. ``Location`` is a property of the [AWS::ApiGateway::DocumentationPart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html) resource.\n For more information about each property, including constraints and valid values, see [DocumentationPart](https://docs.aws.amazon.com/apigateway/latest/api/API_DocumentationPartLocation.html) in the *Amazon API Gateway REST API Reference*.",
"markdownDescription": "The ``Location`` property specifies the location of the Amazon API Gateway API entity that the documentation applies to. ``Location`` is a property of the [AWS::ApiGateway::DocumentationPart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html) resource.\n For more information about each property, including constraints and valid values, see [DocumentationPart](https://docs.aws.amazon.com/apigateway/latest/api/API_DocumentationPartLocation.html) in the *Amazon API Gateway REST API Reference*.\n\n---\n\nRequired: No \nUpdate requires: No interruption\n"
"description": "The ``Location`` property specifies the location of the Amazon API Gateway API entity that the documentation applies to. ``Location`` is a property of the [AWS::ApiGateway::DocumentationPart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html) resource.\n For more information about each property, including constraints and valid values, see [DocumentationPart](https://docs.aws.amazon.com/apigateway/latest/api/API_DocumentationPartLocation.html) in the *Amazon API Gateway REST API Reference*.",
"markdownDescription": "The ``Location`` property specifies the location of the Amazon API Gateway API entity that the documentation applies to. ``Location`` is a property of the [AWS::ApiGateway::DocumentationPart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html) resource.\n For more information about each property, including constraints and valid values, see [DocumentationPart](https://docs.aws.amazon.com/apigateway/latest/api/API_DocumentationPartLocation.html) in the *Amazon API Gateway REST API Reference*.\n\n---\n\nRequired: No \nUpdate requires: No interruption\n"
}
},
"required": [
Expand Down
Loading
Loading