latest--aws-apigateway-apikey
shared| Type | object |
|---|---|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-apigateway-apikey.json |
| Parent schema | serverless-framework-configuration |
Resource Type definition for AWS::ApiGateway::ApiKey. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway
Properties
An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.
A description of the purpose of the API key.
Indicates whether the API key can be used by clients.
Specifies whether the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.
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.
An array of arbitrary tags (key-value pairs) to associate with the API key.
The value of the API key. Must be at least 20 characters long.
Definitions
The ID of a RestApi resource that includes the stage with which you want to associate the API key.
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.
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 -.
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 -.