CfnUsagePlan

class aws_cdk.aws_apigateway.CfnUsagePlan(scope, id, *, api_stages=None, description=None, quota=None, tags=None, throttle=None, usage_plan_name=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::ApiGateway::UsagePlan.

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.

CloudformationResource

AWS::ApiGateway::UsagePlan

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apigateway as apigateway

cfn_usage_plan = apigateway.CfnUsagePlan(self, "MyCfnUsagePlan",
    api_stages=[apigateway.CfnUsagePlan.ApiStageProperty(
        api_id="apiId",
        stage="stage",
        throttle={
            "throttle_key": apigateway.CfnUsagePlan.ThrottleSettingsProperty(
                burst_limit=123,
                rate_limit=123
            )
        }
    )],
    description="description",
    quota=apigateway.CfnUsagePlan.QuotaSettingsProperty(
        limit=123,
        offset=123,
        period="period"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    throttle=apigateway.CfnUsagePlan.ThrottleSettingsProperty(
        burst_limit=123,
        rate_limit=123
    ),
    usage_plan_name="usagePlanName"
)

Create a new AWS::ApiGateway::UsagePlan.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • api_stages (Union[IResolvable, Sequence[Union[IResolvable, ApiStageProperty]], None]) – The API stages to associate with this usage plan.

  • description (Optional[str]) – A description of the usage plan.

  • quota (Union[IResolvable, QuotaSettingsProperty, None]) – Configures the number of requests that users can make within a given interval.

  • tags (Optional[Sequence[CfnTag]]) – An array of arbitrary tags (key-value pairs) to associate with the usage plan.

  • throttle (Union[IResolvable, ThrottleSettingsProperty, None]) – Configures the overall request rate (average requests per second) and burst capacity.

  • usage_plan_name (Optional[str]) – A name for the usage plan.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::ApiGateway::UsagePlan'
api_stages

The API stages to associate with this usage plan.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-apistages

Return type

Union[IResolvable, List[Union[IResolvable, ApiStageProperty]], None]

attr_id

The ID for the usage plan.

For example: abc123 .

CloudformationAttribute

Id

Return type

str

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

description

A description of the usage plan.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-description

Return type

Optional[str]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

quota

Configures the number of requests that users can make within a given interval.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-quota

Return type

Union[IResolvable, QuotaSettingsProperty, None]

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

tags

An array of arbitrary tags (key-value pairs) to associate with the usage plan.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-tags

Return type

TagManager

throttle

Configures the overall request rate (average requests per second) and burst capacity.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-throttle

Return type

Union[IResolvable, ThrottleSettingsProperty, None]

usage_plan_name

A name for the usage plan.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-usageplanname

Return type

Optional[str]

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

ApiStageProperty

class CfnUsagePlan.ApiStageProperty(*, api_id=None, stage=None, throttle=None)

Bases: object

ApiStage is a property of the AWS::ApiGateway::UsagePlan resource that specifies which stages and APIs to associate with a usage plan.

Parameters
  • api_id (Optional[str]) – The ID of an API that is in the specified Stage property that you want to associate with the usage plan.

  • stage (Optional[str]) – The name of the stage to associate with the usage plan.

  • throttle (Union[IResolvable, Mapping[str, Union[IResolvable, ThrottleSettingsProperty]], None]) – Map containing method-level throttling information for an API stage in a usage plan. The key for the map is the path and method for which to configure custom throttling, for example, “/pets/GET”. Duplicates are not allowed.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apigateway as apigateway

api_stage_property = apigateway.CfnUsagePlan.ApiStageProperty(
    api_id="apiId",
    stage="stage",
    throttle={
        "throttle_key": apigateway.CfnUsagePlan.ThrottleSettingsProperty(
            burst_limit=123,
            rate_limit=123
        )
    }
)

Attributes

api_id

The ID of an API that is in the specified Stage property that you want to associate with the usage plan.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html#cfn-apigateway-usageplan-apistage-apiid

Return type

Optional[str]

stage

The name of the stage to associate with the usage plan.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html#cfn-apigateway-usageplan-apistage-stage

Return type

Optional[str]

throttle

Map containing method-level throttling information for an API stage in a usage plan.

The key for the map is the path and method for which to configure custom throttling, for example, “/pets/GET”.

Duplicates are not allowed.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html#cfn-apigateway-usageplan-apistage-throttle

Return type

Union[IResolvable, Mapping[str, Union[IResolvable, ThrottleSettingsProperty]], None]

QuotaSettingsProperty

class CfnUsagePlan.QuotaSettingsProperty(*, limit=None, offset=None, period=None)

Bases: object

QuotaSettings is a property of the AWS::ApiGateway::UsagePlan resource that specifies a target for the maximum number of requests users can make to your REST APIs.

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.

Parameters
  • limit (Union[int, float, None]) – The target maximum number of requests that can be made in a given time period.

  • offset (Union[int, float, None]) – The day that a time period starts. For example, with a time period of WEEK , an offset of 0 starts on Sunday, and an offset of 1 starts on Monday.

  • period (Optional[str]) – The time period for which the target maximum limit of requests applies, such as DAY or WEEK . For valid values, see the period property for the UsagePlan resource in the Amazon API Gateway REST API Reference .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apigateway as apigateway

quota_settings_property = apigateway.CfnUsagePlan.QuotaSettingsProperty(
    limit=123,
    offset=123,
    period="period"
)

Attributes

limit

The target maximum number of requests that can be made in a given time period.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html#cfn-apigateway-usageplan-quotasettings-limit

Return type

Union[int, float, None]

offset

The day that a time period starts.

For example, with a time period of WEEK , an offset of 0 starts on Sunday, and an offset of 1 starts on Monday.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html#cfn-apigateway-usageplan-quotasettings-offset

Return type

Union[int, float, None]

period

The time period for which the target maximum limit of requests applies, such as DAY or WEEK .

For valid values, see the period property for the UsagePlan resource in the Amazon API Gateway REST API Reference .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html#cfn-apigateway-usageplan-quotasettings-period

Return type

Optional[str]

ThrottleSettingsProperty

class CfnUsagePlan.ThrottleSettingsProperty(*, burst_limit=None, rate_limit=None)

Bases: object

ThrottleSettings is a property of the AWS::ApiGateway::UsagePlan resource that specifies the overall request rate (average requests per second) and burst capacity when users call your REST APIs.

Parameters
  • burst_limit (Union[int, float, None]) – The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information about request throttling, see Manage API Request Throttling in the API Gateway Developer Guide .

  • rate_limit (Union[int, float, None]) –

    The API target request steady-state rate limit. For more information about request throttling, see Manage API Request Throttling in the API Gateway Developer Guide .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apigateway as apigateway

throttle_settings_property = apigateway.CfnUsagePlan.ThrottleSettingsProperty(
    burst_limit=123,
    rate_limit=123
)

Attributes

burst_limit

The API target request burst rate limit.

This allows more requests through for a period of time than the target rate limit. For more information about request throttling, see Manage API Request Throttling in the API Gateway Developer Guide .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html#cfn-apigateway-usageplan-throttlesettings-burstlimit

Return type

Union[int, float, None]

rate_limit

The API target request steady-state rate limit.

For more information about request throttling, see Manage API Request Throttling in the API Gateway Developer Guide .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html#cfn-apigateway-usageplan-throttlesettings-ratelimit

Return type

Union[int, float, None]