/* eslint-disable */
/**
 * This file was automatically generated by json-schema-to-typescript.
 * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
 * and run json-schema-to-typescript to regenerate this file.
 */

/**
 * Resource Type definition for AWS::ApiGateway::ApiKey
 */
export interface AwsApigatewayApikey {
  /**
   * A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs
   */
  APIKeyId?: string;
  /**
   * An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.
   */
  CustomerId?: string;
  /**
   * A description of the purpose of the API key.
   */
  Description?: string;
  /**
   * Indicates whether the API key can be used by clients.
   */
  Enabled?: boolean;
  /**
   * Specifies whether the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.
   */
  GenerateDistinctId?: boolean;
  /**
   * 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.
   */
  Name?: string;
  /**
   * A list of stages to associate with this API key.
   */
  StageKeys?: StageKey[];
  /**
   * An array of arbitrary tags (key-value pairs) to associate with the API key.
   */
  Tags?: Tag[];
  /**
   * The value of the API key. Must be at least 20 characters long.
   */
  Value?: string;
}
export interface StageKey {
  /**
   * The ID of a RestApi resource that includes the stage with which you want to associate the API key.
   */
  RestApiId?: string;
  /**
   * 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.
   */
  StageName?: string;
}
export interface Tag {
  /**
   * 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 -.
   */
  Key: string;
  /**
   * 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 -.
   */
  Value: string;
}