Class: Aws::APIGateway::Types::CreateUsagePlanRequest

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

Overview

Note:

When making an API call, you may pass CreateUsagePlanRequest data as a hash:

{
  name: "String", # required
  description: "String",
  api_stages: [
    {
      api_id: "String",
      stage: "String",
    },
  ],
  throttle: {
    burst_limit: 1,
    rate_limit: 1.0,
  },
  quota: {
    limit: 1,
    offset: 1,
    period: "DAY", # accepts DAY, WEEK, MONTH
  },
}

The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.

Instance Attribute Summary collapse

Instance Attribute Details

#api_stages ⇒ Array<Types::ApiStage>

The associated API stages of the usage plan.

Returns:


1370
1371
1372
1373
1374
1375
1376
1377
 
# File 'lib/aws-sdk-apigateway/types.rb', line 1370

class CreateUsagePlanRequest < Struct.new(
  :name,
  :description,
  :api_stages,
  :throttle,
  :quota)
  include Aws::Structure
end

#description ⇒ String

The description of the usage plan.

Returns:

  • (String) 

1370
1371
1372
1373
1374
1375
1376
1377
 
# File 'lib/aws-sdk-apigateway/types.rb', line 1370

class CreateUsagePlanRequest < Struct.new(
  :name,
  :description,
  :api_stages,
  :throttle,
  :quota)
  include Aws::Structure
end

#name ⇒ String

The name of the usage plan.

Returns:

  • (String) 

1370
1371
1372
1373
1374
1375
1376
1377
 
# File 'lib/aws-sdk-apigateway/types.rb', line 1370

class CreateUsagePlanRequest < Struct.new(
  :name,
  :description,
  :api_stages,
  :throttle,
  :quota)
  include Aws::Structure
end

#quota ⇒ Types::QuotaSettings

The quota of the usage plan.

Returns:


1370
1371
1372
1373
1374
1375
1376
1377
 
# File 'lib/aws-sdk-apigateway/types.rb', line 1370

class CreateUsagePlanRequest < Struct.new(
  :name,
  :description,
  :api_stages,
  :throttle,
  :quota)
  include Aws::Structure
end

#throttle ⇒ Types::ThrottleSettings

The throttling limits of the usage plan.

Returns:


1370
1371
1372
1373
1374
1375
1376
1377
 
# File 'lib/aws-sdk-apigateway/types.rb', line 1370

class CreateUsagePlanRequest < Struct.new(
  :name,
  :description,
  :api_stages,
  :throttle,
  :quota)
  include Aws::Structure
end