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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb

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.

"

Instance Attribute Summary collapse

Instance Attribute Details

#idString

The Id of a usage plan key.

Returns:

  • (String)


7404
7405
7406
7407
7408
7409
7410
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 7404

class UsagePlanKey < Struct.new(
  :id,
  :type,
  :value,
  :name)
  include Aws::Structure
end

#nameString

The name of a usage plan key.

Returns:

  • (String)


7404
7405
7406
7407
7408
7409
7410
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 7404

class UsagePlanKey < Struct.new(
  :id,
  :type,
  :value,
  :name)
  include Aws::Structure
end

#typeString

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

Returns:

  • (String)


7404
7405
7406
7407
7408
7409
7410
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 7404

class UsagePlanKey < Struct.new(
  :id,
  :type,
  :value,
  :name)
  include Aws::Structure
end

#valueString

The value of a usage plan key.

Returns:

  • (String)


7404
7405
7406
7407
7408
7409
7410
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 7404

class UsagePlanKey < Struct.new(
  :id,
  :type,
  :value,
  :name)
  include Aws::Structure
end