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

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

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 CreateUsagePlanRequest data as a hash:

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

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

The associated API stages of the usage plan.

Returns:



1501
1502
1503
1504
1505
1506
1507
1508
1509
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1501

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

#descriptionString

The description of the usage plan.

Returns:

  • (String)


1501
1502
1503
1504
1505
1506
1507
1508
1509
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1501

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

#nameString

[Required] The name of the usage plan.

Returns:

  • (String)


1501
1502
1503
1504
1505
1506
1507
1508
1509
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1501

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

#quotaTypes::QuotaSettings

The quota of the usage plan.



1501
1502
1503
1504
1505
1506
1507
1508
1509
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1501

class CreateUsagePlanRequest < Struct.new(
  :name,
  :description,
  :api_stages,
  :throttle,
  :quota,
  :tags)
  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>)


1501
1502
1503
1504
1505
1506
1507
1508
1509
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1501

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

#throttleTypes::ThrottleSettings

The throttling limits of the usage plan.



1501
1502
1503
1504
1505
1506
1507
1508
1509
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1501

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