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

Class: Aws::APIGateway::Types::CreateUsagePlanKeyRequest

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

Overview

Note:

When passing CreateUsagePlanKeyRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  usage_plan_id: "String", # required
  key_id: "String", # required
  key_type: "String", # required
}

The POST request to create a usage plan key for adding an existing API key to a usage plan.

Instance Attribute Summary collapse

Instance Attribute Details

#key_id ⇒ String

[Required] The identifier of a UsagePlanKey resource for a plan customer.

Returns:

  • (String) —

    [Required] The identifier of a UsagePlanKey resource for a plan customer.

#key_type ⇒ String

[Required] The type of a UsagePlanKey resource for a plan customer.

Returns:

  • (String) —

    [Required] The type of a UsagePlanKey resource for a plan customer.

#usage_plan_id ⇒ String

[Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer.

Returns:

  • (String) —

    [Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer.