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_stagesArray<Types::ApiStage>

The associated API stages of the usage plan.

Returns:



1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1161

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

#descriptionString

The description of the usage plan.

Returns:

  • (String)


1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1161

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

#nameString

The name of the usage plan.

Returns:

  • (String)


1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1161

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

#quotaTypes::QuotaSettings

The quota of the usage plan.



1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1161

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

#tagsHash<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>)


1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1161

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

#throttleTypes::ThrottleSettings

The throttling limits of the usage plan.



1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1161

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