class CfnUsagePlanPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.ApiGateway.Mixins.CfnUsagePlanPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsapigateway/mixins#CfnUsagePlanPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.apigateway.mixins.CfnUsagePlanPropsMixin
Python	aws_cdk.mixins_preview.aws_apigateway.mixins.CfnUsagePlanPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_apigateway » mixins » CfnUsagePlanPropsMixin

Implements IMixin

Extends Mixin

The AWS::ApiGateway::UsagePlan resource creates a usage plan for deployed APIs.

A usage plan sets a target for the throttling and quota limits on individual client API keys. For more information, see Creating and Using API Usage Plans in Amazon API Gateway in the API Gateway Developer Guide .

In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using AWS Budgets to monitor costs and AWS WAF to manage API requests.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as apigateway_mixins } from '@aws-cdk/mixins-preview/aws-apigateway';
const cfnUsagePlanPropsMixin = new apigateway_mixins.CfnUsagePlanPropsMixin({
  apiStages: [{
    apiId: 'apiId',
    stage: 'stage',
    throttle: {
      throttleKey: {
        burstLimit: 123,
        rateLimit: 123,
      },
    },
  }],
  description: 'description',
  quota: {
    limit: 123,
    offset: 123,
    period: 'period',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  throttle: {
    burstLimit: 123,
    rateLimit: 123,
  },
  usagePlanName: 'usagePlanName',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnUsagePlanPropsMixin(props: CfnUsagePlanMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnUsagePlanMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::ApiGateway::UsagePlan.

Properties

Name	Type	Description
props	CfnUsagePlanMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnUsagePlanMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.