You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::APIGateway::Types::UsagePlanKey

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Represents a usage plan key to identify a plan customer.

To associate an API stage with a selected API key in a usage plan, you must create a UsagePlanKey resource to represent the selected ApiKey.

"
Create and Use Usage Plans

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#id ⇒ String

The Id of a usage plan key.

Returns:

  • (String) —

    The Id of a usage plan key.

#name ⇒ String

The name of a usage plan key.

Returns:

  • (String) —

    The name of a usage plan key.

#type ⇒ String

The type of a usage plan key. Currently, the valid key type is API_KEY.

Returns:

  • (String) —

    The type of a usage plan key.

#value ⇒ String

The value of a usage plan key.

Returns:

  • (String) —

    The value of a usage plan key.