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

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

The identifier of a UsagePlanKey resource for a plan customer.

Returns:

  • (String)


1087
1088
1089
1090
1091
1092
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1087

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

#key_typeString

The type of a UsagePlanKey resource for a plan customer.

Returns:

  • (String)


1087
1088
1089
1090
1091
1092
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1087

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

#usage_plan_idString

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

Returns:

  • (String)


1087
1088
1089
1090
1091
1092
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1087

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