{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-apigateway-apikey.json",
  "title": "AWSApiGatewayApiKeyProperties",
  "description": "Resource Type definition for AWS::ApiGateway::ApiKey. Source:- <https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway>",
  "x-lintel": {
    "source": "https://raw.githubusercontent.com/lalcebo/json-schema/master/serverless/resources/cloudformation-modified/aws-apigateway-apikey.json",
    "sourceSha256": "8f0fa45456dda60a57b9ed156d6d405dc13d799a1348f32fb2bfb5a08e63414f"
  },
  "type": "object",
  "properties": {
    "CustomerId": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "$ref": "https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--cf.functions.json#/Aws_CF_FunctionString"
        }
      ],
      "description": "An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace."
    },
    "Description": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "$ref": "https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--cf.functions.json#/Aws_CF_FunctionString"
        }
      ],
      "description": "A description of the purpose of the API key."
    },
    "Enabled": {
      "description": "Indicates whether the API key can be used by clients.",
      "default": false,
      "type": "boolean"
    },
    "GenerateDistinctId": {
      "description": "Specifies whether the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.",
      "type": "boolean"
    },
    "Name": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "$ref": "https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--cf.functions.json#/Aws_CF_FunctionString"
        }
      ],
      "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."
    },
    "StageKeys": {
      "description": "A list of stages to associate with this API key.",
      "type": "array",
      "uniqueItems": true,
      "items": {
        "$ref": "#/$defs/StageKey"
      }
    },
    "Tags": {
      "description": "An array of arbitrary tags (key-value pairs) to associate with the API key.",
      "type": "array",
      "uniqueItems": false,
      "items": {
        "$ref": "#/$defs/Tag"
      }
    },
    "Value": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "$ref": "https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--cf.functions.json#/Aws_CF_FunctionString"
        }
      ],
      "description": "The value of the API key. Must be at least 20 characters long."
    }
  },
  "typeName": "AWS::ApiGateway::ApiKey",
  "readOnlyProperties": [
    "/properties/APIKeyId"
  ],
  "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway",
  "$defs": {
    "StageKey": {
      "type": "object",
      "title": "AWSApiGatewayApiKeyStageKeyDefinition",
      "properties": {
        "RestApiId": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "$ref": "https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--cf.functions.json#/Aws_CF_FunctionString"
            }
          ],
          "description": "The ID of a RestApi resource that includes the stage with which you want to associate the API key."
        },
        "StageName": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "$ref": "https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--cf.functions.json#/Aws_CF_FunctionString"
            }
          ],
          "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. "
        }
      },
      "additionalProperties": false
    },
    "Tag": {
      "type": "object",
      "title": "AWSApiGatewayApiKeyTagDefinition",
      "properties": {
        "Key": {
          "oneOf": [
            {
              "type": "string",
              "minLength": 1,
              "maxLength": 128
            },
            {
              "$ref": "https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--cf.functions.json#/Aws_CF_FunctionString"
            }
          ],
          "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 -."
        },
        "Value": {
          "oneOf": [
            {
              "type": "string",
              "maxLength": 256
            },
            {
              "$ref": "https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--cf.functions.json#/Aws_CF_FunctionString"
            }
          ],
          "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 -. "
        }
      },
      "required": [
        "Value",
        "Key"
      ],
      "additionalProperties": false
    }
  },
  "primaryIdentifier": [
    "/properties/APIKeyId"
  ],
  "additionalProperties": false,
  "createOnlyProperties": [
    "/properties/GenerateDistinctId",
    "/properties/Name",
    "/properties/Value"
  ],
  "writeOnlyProperties": [
    "/properties/GenerateDistinctId"
  ]
}