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

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

Overview

Note:

When making an API call, you may pass CreateUsagePlanKeyRequest data as a 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_idString

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

Returns:

  • (String)


1436
1437
1438
1439
1440
1441
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1436

class CreateUsagePlanKeyRequest < Struct.new(
  :usage_plan_id,
  :key_id,
  :key_type)
  include Aws::Structure
end

#key_typeString

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

Returns:

  • (String)


1436
1437
1438
1439
1440
1441
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1436

class CreateUsagePlanKeyRequest < Struct.new(
  :usage_plan_id,
  :key_id,
  :key_type)
  include Aws::Structure
end

#usage_plan_idString

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

Returns:

  • (String)


1436
1437
1438
1439
1440
1441
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1436

class CreateUsagePlanKeyRequest < Struct.new(
  :usage_plan_id,
  :key_id,
  :key_type)
  include Aws::Structure
end