Package software.amazon.awscdk.services.apigateway

Class CfnUsagePlan.Builder

java.lang.Object
software.amazon.awscdk.services.apigateway.CfnUsagePlan.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnUsagePlan>
Enclosing class:
CfnUsagePlan
@Stability(Stable) public static final class CfnUsagePlan.Builder extends Object implements software.amazon.jsii.Builder<CfnUsagePlan>
A fluent builder for CfnUsagePlan.

  • Method Details

    • create

      @Stability(Stable) public static CfnUsagePlan.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnUsagePlan.Builder.

    • apiStages

      @Stability(Stable) public CfnUsagePlan.Builder apiStages(IResolvable apiStages)
      The associated API stages of a usage plan.

      Parameters:
      apiStages - The associated API stages of a usage plan. This parameter is required.
      Returns:
      this

    • apiStages

      @Stability(Stable) public CfnUsagePlan.Builder apiStages(List<? extends Object> apiStages)
      The associated API stages of a usage plan.

      Parameters:
      apiStages - The associated API stages of a usage plan. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public CfnUsagePlan.Builder description(String description)
      The description of a usage plan.

      Parameters:
      description - The description of a usage plan. This parameter is required.
      Returns:
      this

    • quota

      @Stability(Stable) public CfnUsagePlan.Builder quota(IResolvable quota)
      The target maximum number of permitted requests per a given unit time interval.

      Parameters:
      quota - The target maximum number of permitted requests per a given unit time interval. This parameter is required.
      Returns:
      this

    • quota

      @Stability(Stable) public CfnUsagePlan.Builder quota(CfnUsagePlan.QuotaSettingsProperty quota)
      The target maximum number of permitted requests per a given unit time interval.

      Parameters:
      quota - The target maximum number of permitted requests per a given unit time interval. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnUsagePlan.Builder tags(List<? extends CfnTag> tags)
      The collection of tags.

      Each tag element is associated with a given resource.

      Parameters:
      tags - The collection of tags. This parameter is required.
      Returns:
      this

    • throttle

      @Stability(Stable) public CfnUsagePlan.Builder throttle(IResolvable throttle)
      A map containing method level throttling information for API stage in a usage plan.

      Parameters:
      throttle - A map containing method level throttling information for API stage in a usage plan. This parameter is required.
      Returns:
      this

    • throttle

      @Stability(Stable) public CfnUsagePlan.Builder throttle(CfnUsagePlan.ThrottleSettingsProperty throttle)
      A map containing method level throttling information for API stage in a usage plan.

      Parameters:
      throttle - A map containing method level throttling information for API stage in a usage plan. This parameter is required.
      Returns:
      this

    • usagePlanName

      @Stability(Stable) public CfnUsagePlan.Builder usagePlanName(String usagePlanName)
      The name of a usage plan.

      Parameters:
      usagePlanName - The name of a usage plan. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnUsagePlan build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnUsagePlan>
      Returns:
      a newly built instance of CfnUsagePlan.