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

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::UsagePlanKey

Includes:

Structure

Defined in:

lib/aws-sdk-apigateway/types.rb

Overview

Represents a usage plan key to identify a plan customer.

<div class=“remarks” markdown=“1”> 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.

</div>

“ <div class=”seeAlso“ markdown=”1“>

Create and Use Usage Plans][1

</div>

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #id ⇒ String

  The Id of a usage plan key.

• #name ⇒ String

  The name of a usage plan key.

• #type ⇒ String

  The type of a usage plan key.

• #value ⇒ String

  The value of a usage plan key.

Instance Attribute Details

#id ⇒ String

The Id of a usage plan key.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 8195

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

#name ⇒ String

The name of a usage plan key.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 8195

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

#type ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 8195

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

#value ⇒ String

The value of a usage plan key.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 8195

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