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.

"

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#idString

The Id of a usage plan key.

Returns:

  • (String)


8188
8189
8190
8191
8192
8193
8194
8195
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 8188

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

#nameString

The name of a usage plan key.

Returns:

  • (String)


8188
8189
8190
8191
8192
8193
8194
8195
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 8188

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

#typeString

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

Returns:

  • (String)


8188
8189
8190
8191
8192
8193
8194
8195
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 8188

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

#valueString

The value of a usage plan key.

Returns:

  • (String)


8188
8189
8190
8191
8192
8193
8194
8195
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 8188

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