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: {
        "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.

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:



1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
 
# File 'lib/aws-sdk-apigateway/types.rb', line 1566

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) 


1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
 
# File 'lib/aws-sdk-apigateway/types.rb', line 1566

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

#name ⇒ String

[Required] The name of the usage plan.

Returns:

  • (String) 


1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
 
# File 'lib/aws-sdk-apigateway/types.rb', line 1566

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:



1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
 
# File 'lib/aws-sdk-apigateway/types.rb', line 1566

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


1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
 
# File 'lib/aws-sdk-apigateway/types.rb', line 1566

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:



1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
 
# File 'lib/aws-sdk-apigateway/types.rb', line 1566

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