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

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

Overview

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.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#api_stages ⇒ Array<Types::ApiStage>

The associated API stages of the usage plan.

Returns:



1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1213

class CreateUsagePlanRequest < Struct.new(
  :name,
  :description,
  :api_stages,
  :throttle,
  :quota,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the usage plan.

Returns:

  • (String) 


1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1213

class CreateUsagePlanRequest < Struct.new(
  :name,
  :description,
  :api_stages,
  :throttle,
  :quota,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the usage plan.

Returns:

  • (String) 


1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1213

class CreateUsagePlanRequest < Struct.new(
  :name,
  :description,
  :api_stages,
  :throttle,
  :quota,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#quota ⇒ Types::QuotaSettings

The quota of the usage plan.

Returns:



1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1213

class CreateUsagePlanRequest < Struct.new(
  :name,
  :description,
  :api_stages,
  :throttle,
  :quota,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Returns:

  • (Hash<String,String>) 


1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1213

class CreateUsagePlanRequest < Struct.new(
  :name,
  :description,
  :api_stages,
  :throttle,
  :quota,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#throttle ⇒ Types::ThrottleSettings

The throttling limits of the usage plan.

Returns:



1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1213

class CreateUsagePlanRequest < Struct.new(
  :name,
  :description,
  :api_stages,
  :throttle,
  :quota,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end