awscc.apigateway_apikey

Filters

  • event

  • reduce

  • value

Actions

delete

Parent base class for filters and actions.

properties:
  type:
    enum:
    - delete
required:
- type

Permissions - apigateway:DELETE

update

Parent base class for filters and actions.

definitions:
  StageKey:
    additionalProperties: false
    properties:
      RestApiId:
        description: The ID of a RestApi resource that includes the stage with which
          you want to associate the API key.
        type: string
      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. '
        type: string
    type: object
  Tag:
    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 -.'
        maxLength: 128
        minLength: 1
        type: string
      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 -. '
        maxLength: 256
        type: string
    required:
    - Value
    - Key
    type: object
properties:
  CustomerId:
    description: An AWS Marketplace customer identifier to use when integrating with
      the AWS SaaS Marketplace.
    type: string
  Description:
    description: A description of the purpose of the API key.
    type: string
  Enabled:
    default: false
    description: Indicates whether the API key can be used by clients.
    type: boolean
  StageKeys:
    description: A list of stages to associate with this API key.
    items:
      additionalProperties: false
      properties:
        RestApiId:
          description: The ID of a RestApi resource that includes the stage with which
            you want to associate the API key.
          type: string
        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. '
          type: string
      type: object
    type: array
    uniqueItems: true
  Tags:
    description: An array of arbitrary tags (key-value pairs) to associate with the
      API key.
    items:
      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 -.'
          maxLength: 128
          minLength: 1
          type: string
        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 -. '
          maxLength: 256
          type: string
      required:
      - Value
      - Key
      type: object
    type: array
    uniqueItems: false
  type:
    enum:
    - update

Permissions - apigateway:GET, apigateway:PATCH, apigateway:PUT, apigateway:DELETE