Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. AWS
  4. API Docs
  5. apigateway
  6. UsagePlan
Viewing docs for AWS v7.42.0
published on Thursday, Aug 13, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.apigateway.UsagePlan

aws logo aws logo
Viewing docs for AWS v7.42.0
published on Thursday, Aug 13, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Provides an API Gateway Usage Plan.

    Create UsagePlan Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new UsagePlan(name: string, args?: UsagePlanArgs, opts?: CustomResourceOptions);
    @overload
def UsagePlan(resource_name: str,
              args: Optional[UsagePlanArgs] = None,
              opts: Optional[ResourceOptions] = None)

@overload
def UsagePlan(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              api_stages: Optional[Sequence[UsagePlanApiStageArgs]] = None,
              description: Optional[str] = None,
              name: Optional[str] = None,
              product_code: Optional[str] = None,
              quota_settings: Optional[UsagePlanQuotaSettingsArgs] = None,
              region: Optional[str] = None,
              tags: Optional[Mapping[str, str]] = None,
              throttle_settings: Optional[UsagePlanThrottleSettingsArgs] = None)
    func NewUsagePlan(ctx *Context, name string, args *UsagePlanArgs, opts ...ResourceOption) (*UsagePlan, error)
    public UsagePlan(string name, UsagePlanArgs? args = null, CustomResourceOptions? opts = null)
    public UsagePlan(String name, UsagePlanArgs args)
public UsagePlan(String name, UsagePlanArgs args, CustomResourceOptions options)

    type: aws:apigateway:UsagePlan
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "aws_apigateway_usage_plan" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args UsagePlanArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args UsagePlanArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args UsagePlanArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UsagePlanArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UsagePlanArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var usagePlanResource = new Aws.ApiGateway.UsagePlan("usagePlanResource", new()
{
    ApiStages = new[]
    {
        new Aws.ApiGateway.Inputs.UsagePlanApiStageArgs
        {
            ApiId = "string",
            Stage = "string",
            Throttles = new[]
            {
                new Aws.ApiGateway.Inputs.UsagePlanApiStageThrottleArgs
                {
                    Path = "string",
                    BurstLimit = 0,
                    RateLimit = 0,
                },
            },
        },
    },
    Description = "string",
    Name = "string",
    ProductCode = "string",
    QuotaSettings = new Aws.ApiGateway.Inputs.UsagePlanQuotaSettingsArgs
    {
        Limit = 0,
        Period = "string",
        Offset = 0,
    },
    Region = "string",
    Tags = 
    {
        { "string", "string" },
    },
    ThrottleSettings = new Aws.ApiGateway.Inputs.UsagePlanThrottleSettingsArgs
    {
        BurstLimit = 0,
        RateLimit = 0,
    },
});

    example, err := apigateway.NewUsagePlan(ctx, "usagePlanResource", &apigateway.UsagePlanArgs{
	ApiStages: apigateway.UsagePlanApiStageArray{
		&apigateway.UsagePlanApiStageArgs{
			ApiId: pulumi.String("string"),
			Stage: pulumi.String("string"),
			Throttles: apigateway.UsagePlanApiStageThrottleArray{
				&apigateway.UsagePlanApiStageThrottleArgs{
					Path:       pulumi.String("string"),
					BurstLimit: pulumi.Int(0),
					RateLimit:  pulumi.Float64(0),
				},
			},
		},
	},
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	ProductCode: pulumi.String("string"),
	QuotaSettings: &apigateway.UsagePlanQuotaSettingsArgs{
		Limit:  pulumi.Int(0),
		Period: pulumi.String("string"),
		Offset: pulumi.Int(0),
	},
	Region: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ThrottleSettings: &apigateway.UsagePlanThrottleSettingsArgs{
		BurstLimit: pulumi.Int(0),
		RateLimit:  pulumi.Float64(0),
	},
})

    resource "aws_apigateway_usage_plan" "usagePlanResource" {
  lifecycle {
    create_before_destroy = true
  }
  api_stages {
    api_id = "string"
    stage  = "string"
    throttles {
      path        = "string"
      burst_limit = 0
      rate_limit  = 0
    }
  }
  description  = "string"
  name         = "string"
  product_code = "string"
  quota_settings = {
    limit  = 0
    period = "string"
    offset = 0
  }
  region = "string"
  tags = {
    "string" = "string"
  }
  throttle_settings = {
    burst_limit = 0
    rate_limit  = 0
  }
}

    var usagePlanResource = new UsagePlan("usagePlanResource", UsagePlanArgs.builder()
    .apiStages(UsagePlanApiStageArgs.builder()
        .apiId("string")
        .stage("string")
        .throttles(UsagePlanApiStageThrottleArgs.builder()
            .path("string")
            .burstLimit(0)
            .rateLimit(0.0)
            .build())
        .build())
    .description("string")
    .name("string")
    .productCode("string")
    .quotaSettings(UsagePlanQuotaSettingsArgs.builder()
        .limit(0)
        .period("string")
        .offset(0)
        .build())
    .region("string")
    .tags(Map.of("string", "string"))
    .throttleSettings(UsagePlanThrottleSettingsArgs.builder()
        .burstLimit(0)
        .rateLimit(0.0)
        .build())
    .build());

    usage_plan_resource = aws.apigateway.UsagePlan("usagePlanResource",
    api_stages=[{
        "api_id": "string",
        "stage": "string",
        "throttles": [{
            "path": "string",
            "burst_limit": 0,
            "rate_limit": float(0),
        }],
    }],
    description="string",
    name="string",
    product_code="string",
    quota_settings={
        "limit": 0,
        "period": "string",
        "offset": 0,
    },
    region="string",
    tags={
        "string": "string",
    },
    throttle_settings={
        "burst_limit": 0,
        "rate_limit": float(0),
    })

    const usagePlanResource = new aws.apigateway.UsagePlan("usagePlanResource", {
    apiStages: [{
        apiId: "string",
        stage: "string",
        throttles: [{
            path: "string",
            burstLimit: 0,
            rateLimit: 0,
        }],
    }],
    description: "string",
    name: "string",
    productCode: "string",
    quotaSettings: {
        limit: 0,
        period: "string",
        offset: 0,
    },
    region: "string",
    tags: {
        string: "string",
    },
    throttleSettings: {
        burstLimit: 0,
        rateLimit: 0,
    },
});

    type: aws:apigateway:UsagePlan
properties:
    apiStages:
        - apiId: string
          stage: string
          throttles:
            - burstLimit: 0
              path: string
              rateLimit: 0
    description: string
    name: string
    productCode: string
    quotaSettings:
        limit: 0
        offset: 0
        period: string
    region: string
    tags:
        string: string
    throttleSettings:
        burstLimit: 0
        rateLimit: 0

    UsagePlan Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The UsagePlan resource accepts the following input properties:

    ApiStages List<UsagePlanApiStage>
    Associated API stages of the usage plan. See apiStages Block below.
    Description string
    Description of a usage plan.
    Name string
    Name of the usage plan.
    ProductCode string
    AWS Marketplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
    QuotaSettings UsagePlanQuotaSettings
    Quota settings of the usage plan. See quotaSettings Block below.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    ThrottleSettings UsagePlanThrottleSettings
    Throttling limits of the usage plan. See throttleSettings Block below.
    ApiStages []UsagePlanApiStageArgs
    Associated API stages of the usage plan. See apiStages Block below.
    Description string
    Description of a usage plan.
    Name string
    Name of the usage plan.
    ProductCode string
    AWS Marketplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
    QuotaSettings UsagePlanQuotaSettingsArgs
    Quota settings of the usage plan. See quotaSettings Block below.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    ThrottleSettings UsagePlanThrottleSettingsArgs
    Throttling limits of the usage plan. See throttleSettings Block below.
    api_stages list(object)
    Associated API stages of the usage plan. See apiStages Block below.
    description string
    Description of a usage plan.
    name string
    Name of the usage plan.
    product_code string
    AWS Marketplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
    quota_settings object
    Quota settings of the usage plan. See quotaSettings Block below.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags map(string)
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    throttle_settings object
    Throttling limits of the usage plan. See throttleSettings Block below.
    apiStages List<UsagePlanApiStage>
    Associated API stages of the usage plan. See apiStages Block below.
    description String
    Description of a usage plan.
    name String
    Name of the usage plan.
    productCode String
    AWS Marketplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
    quotaSettings UsagePlanQuotaSettings
    Quota settings of the usage plan. See quotaSettings Block below.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    throttleSettings UsagePlanThrottleSettings
    Throttling limits of the usage plan. See throttleSettings Block below.
    apiStages UsagePlanApiStage[]
    Associated API stages of the usage plan. See apiStages Block below.
    description string
    Description of a usage plan.
    name string
    Name of the usage plan.
    productCode string
    AWS Marketplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
    quotaSettings UsagePlanQuotaSettings
    Quota settings of the usage plan. See quotaSettings Block below.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    throttleSettings UsagePlanThrottleSettings
    Throttling limits of the usage plan. See throttleSettings Block below.
    api_stages Sequence[UsagePlanApiStageArgs]
    Associated API stages of the usage plan. See apiStages Block below.
    description str
    Description of a usage plan.
    name str
    Name of the usage plan.
    product_code str
    AWS Marketplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
    quota_settings UsagePlanQuotaSettingsArgs
    Quota settings of the usage plan. See quotaSettings Block below.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    throttle_settings UsagePlanThrottleSettingsArgs
    Throttling limits of the usage plan. See throttleSettings Block below.
    apiStages List<Property Map>
    Associated API stages of the usage plan. See apiStages Block below.
    description String
    Description of a usage plan.
    name String
    Name of the usage plan.
    productCode String
    AWS Marketplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
    quotaSettings Property Map
    Quota settings of the usage plan. See quotaSettings Block below.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    throttleSettings Property Map
    Throttling limits of the usage plan. See throttleSettings Block below.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the UsagePlan resource produces the following output properties:

    Arn string
    ARN of the usage plan.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    Arn string
    ARN of the usage plan.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn string
    ARN of the usage plan.
    id string
    The provider-assigned unique ID for this managed resource.
    tags_all map(string)
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn String
    ARN of the usage plan.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn string
    ARN of the usage plan.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn str
    ARN of the usage plan.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn String
    ARN of the usage plan.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.

    Look up Existing UsagePlan Resource

    Get an existing UsagePlan resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: UsagePlanState, opts?: CustomResourceOptions): UsagePlan
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_stages: Optional[Sequence[UsagePlanApiStageArgs]] = None,
        arn: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        product_code: Optional[str] = None,
        quota_settings: Optional[UsagePlanQuotaSettingsArgs] = None,
        region: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        throttle_settings: Optional[UsagePlanThrottleSettingsArgs] = None) -> UsagePlan
    func GetUsagePlan(ctx *Context, name string, id IDInput, state *UsagePlanState, opts ...ResourceOption) (*UsagePlan, error)
    public static UsagePlan Get(string name, Input<string> id, UsagePlanState? state, CustomResourceOptions? opts = null)
    public static UsagePlan get(String name, Output<String> id, UsagePlanState state, CustomResourceOptions options)
    resources:  _:    type: aws:apigateway:UsagePlan    get:      id: ${id}
    import {
  to = aws_apigateway_usage_plan.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApiStages List<UsagePlanApiStage>
    Associated API stages of the usage plan. See apiStages Block below.
    Arn string
    ARN of the usage plan.
    Description string
    Description of a usage plan.
    Name string
    Name of the usage plan.
    ProductCode string
    AWS Marketplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
    QuotaSettings UsagePlanQuotaSettings
    Quota settings of the usage plan. See quotaSettings Block below.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    ThrottleSettings UsagePlanThrottleSettings
    Throttling limits of the usage plan. See throttleSettings Block below.
    ApiStages []UsagePlanApiStageArgs
    Associated API stages of the usage plan. See apiStages Block below.
    Arn string
    ARN of the usage plan.
    Description string
    Description of a usage plan.
    Name string
    Name of the usage plan.
    ProductCode string
    AWS Marketplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
    QuotaSettings UsagePlanQuotaSettingsArgs
    Quota settings of the usage plan. See quotaSettings Block below.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    ThrottleSettings UsagePlanThrottleSettingsArgs
    Throttling limits of the usage plan. See throttleSettings Block below.
    api_stages list(object)
    Associated API stages of the usage plan. See apiStages Block below.
    arn string
    ARN of the usage plan.
    description string
    Description of a usage plan.
    name string
    Name of the usage plan.
    product_code string
    AWS Marketplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
    quota_settings object
    Quota settings of the usage plan. See quotaSettings Block below.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags map(string)
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all map(string)
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    throttle_settings object
    Throttling limits of the usage plan. See throttleSettings Block below.
    apiStages List<UsagePlanApiStage>
    Associated API stages of the usage plan. See apiStages Block below.
    arn String
    ARN of the usage plan.
    description String
    Description of a usage plan.
    name String
    Name of the usage plan.
    productCode String
    AWS Marketplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
    quotaSettings UsagePlanQuotaSettings
    Quota settings of the usage plan. See quotaSettings Block below.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    throttleSettings UsagePlanThrottleSettings
    Throttling limits of the usage plan. See throttleSettings Block below.
    apiStages UsagePlanApiStage[]
    Associated API stages of the usage plan. See apiStages Block below.
    arn string
    ARN of the usage plan.
    description string
    Description of a usage plan.
    name string
    Name of the usage plan.
    productCode string
    AWS Marketplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
    quotaSettings UsagePlanQuotaSettings
    Quota settings of the usage plan. See quotaSettings Block below.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    throttleSettings UsagePlanThrottleSettings
    Throttling limits of the usage plan. See throttleSettings Block below.
    api_stages Sequence[UsagePlanApiStageArgs]
    Associated API stages of the usage plan. See apiStages Block below.
    arn str
    ARN of the usage plan.
    description str
    Description of a usage plan.
    name str
    Name of the usage plan.
    product_code str
    AWS Marketplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
    quota_settings UsagePlanQuotaSettingsArgs
    Quota settings of the usage plan. See quotaSettings Block below.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    throttle_settings UsagePlanThrottleSettingsArgs
    Throttling limits of the usage plan. See throttleSettings Block below.
    apiStages List<Property Map>
    Associated API stages of the usage plan. See apiStages Block below.
    arn String
    ARN of the usage plan.
    description String
    Description of a usage plan.
    name String
    Name of the usage plan.
    productCode String
    AWS Marketplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
    quotaSettings Property Map
    Quota settings of the usage plan. See quotaSettings Block below.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    throttleSettings Property Map
    Throttling limits of the usage plan. See throttleSettings Block below.

    Supporting Types

    UsagePlanApiStage, UsagePlanApiStageArgs

    ApiId string
    API ID of the associated API stage in a usage plan.
    Stage string

    API stage name of the associated API stage in a usage plan.

    The following arguments are optional:

    Throttles List<UsagePlanApiStageThrottle>
    Throttling limits applied to the API stage. See throttle Block below.
    ApiId string
    API ID of the associated API stage in a usage plan.
    Stage string

    API stage name of the associated API stage in a usage plan.

    The following arguments are optional:

    Throttles []UsagePlanApiStageThrottle
    Throttling limits applied to the API stage. See throttle Block below.
    api_id string
    API ID of the associated API stage in a usage plan.
    stage string

    API stage name of the associated API stage in a usage plan.

    The following arguments are optional:

    throttles list(object)
    Throttling limits applied to the API stage. See throttle Block below.
    apiId String
    API ID of the associated API stage in a usage plan.
    stage String

    API stage name of the associated API stage in a usage plan.

    The following arguments are optional:

    throttles List<UsagePlanApiStageThrottle>
    Throttling limits applied to the API stage. See throttle Block below.
    apiId string
    API ID of the associated API stage in a usage plan.
    stage string

    API stage name of the associated API stage in a usage plan.

    The following arguments are optional:

    throttles UsagePlanApiStageThrottle[]
    Throttling limits applied to the API stage. See throttle Block below.
    api_id str
    API ID of the associated API stage in a usage plan.
    stage str

    API stage name of the associated API stage in a usage plan.

    The following arguments are optional:

    throttles Sequence[UsagePlanApiStageThrottle]
    Throttling limits applied to the API stage. See throttle Block below.
    apiId String
    API ID of the associated API stage in a usage plan.
    stage String

    API stage name of the associated API stage in a usage plan.

    The following arguments are optional:

    throttles List<Property Map>
    Throttling limits applied to the API stage. See throttle Block below.

    UsagePlanApiStageThrottle, UsagePlanApiStageThrottleArgs

    Path string

    Method to apply the throttle settings for. Specify the path and method, for example /test/GET.

    The following arguments are optional:

    BurstLimit int
    API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.
    RateLimit double
    API request steady-state rate limit.
    Path string

    Method to apply the throttle settings for. Specify the path and method, for example /test/GET.

    The following arguments are optional:

    BurstLimit int
    API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.
    RateLimit float64
    API request steady-state rate limit.
    path string

    Method to apply the throttle settings for. Specify the path and method, for example /test/GET.

    The following arguments are optional:

    burst_limit number
    API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.
    rate_limit number
    API request steady-state rate limit.
    path String

    Method to apply the throttle settings for. Specify the path and method, for example /test/GET.

    The following arguments are optional:

    burstLimit Integer
    API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.
    rateLimit Double
    API request steady-state rate limit.
    path string

    Method to apply the throttle settings for. Specify the path and method, for example /test/GET.

    The following arguments are optional:

    burstLimit number
    API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.
    rateLimit number
    API request steady-state rate limit.
    path str

    Method to apply the throttle settings for. Specify the path and method, for example /test/GET.

    The following arguments are optional:

    burst_limit int
    API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.
    rate_limit float
    API request steady-state rate limit.
    path String

    Method to apply the throttle settings for. Specify the path and method, for example /test/GET.

    The following arguments are optional:

    burstLimit Number
    API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.
    rateLimit Number
    API request steady-state rate limit.

    UsagePlanQuotaSettings, UsagePlanQuotaSettingsArgs

    Limit int
    Maximum number of requests that can be made in a given time period.
    Period string

    Time period in which the limit applies. Valid values are DAY, WEEK, or MONTH.

    The following arguments are optional:

    Offset int
    Number of requests subtracted from the given limit in the initial time period.
    Limit int
    Maximum number of requests that can be made in a given time period.
    Period string

    Time period in which the limit applies. Valid values are DAY, WEEK, or MONTH.

    The following arguments are optional:

    Offset int
    Number of requests subtracted from the given limit in the initial time period.
    limit number
    Maximum number of requests that can be made in a given time period.
    period string

    Time period in which the limit applies. Valid values are DAY, WEEK, or MONTH.

    The following arguments are optional:

    offset number
    Number of requests subtracted from the given limit in the initial time period.
    limit Integer
    Maximum number of requests that can be made in a given time period.
    period String

    Time period in which the limit applies. Valid values are DAY, WEEK, or MONTH.

    The following arguments are optional:

    offset Integer
    Number of requests subtracted from the given limit in the initial time period.
    limit number
    Maximum number of requests that can be made in a given time period.
    period string

    Time period in which the limit applies. Valid values are DAY, WEEK, or MONTH.

    The following arguments are optional:

    offset number
    Number of requests subtracted from the given limit in the initial time period.
    limit int
    Maximum number of requests that can be made in a given time period.
    period str

    Time period in which the limit applies. Valid values are DAY, WEEK, or MONTH.

    The following arguments are optional:

    offset int
    Number of requests subtracted from the given limit in the initial time period.
    limit Number
    Maximum number of requests that can be made in a given time period.
    period String

    Time period in which the limit applies. Valid values are DAY, WEEK, or MONTH.

    The following arguments are optional:

    offset Number
    Number of requests subtracted from the given limit in the initial time period.

    UsagePlanThrottleSettings, UsagePlanThrottleSettingsArgs

    BurstLimit int
    API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.
    RateLimit double
    API request steady-state rate limit.
    BurstLimit int
    API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.
    RateLimit float64
    API request steady-state rate limit.
    burst_limit number
    API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.
    rate_limit number
    API request steady-state rate limit.
    burstLimit Integer
    API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.
    rateLimit Double
    API request steady-state rate limit.
    burstLimit number
    API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.
    rateLimit number
    API request steady-state rate limit.
    burst_limit int
    API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.
    rate_limit float
    API request steady-state rate limit.
    burstLimit Number
    API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.
    rateLimit Number
    API request steady-state rate limit.

    Import

    Using pulumi import, import AWS API Gateway Usage Plan using the id. For example:

    $ pulumi import aws:apigateway/usagePlan:UsagePlan myusageplan <usage_plan_id>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo aws logo
    Viewing docs for AWS v7.42.0
    published on Thursday, Aug 13, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial