Package software.amazon.awscdk.services.apigateway

Interface IUsagePlan.Jsii$Default

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IResource, IResource.Jsii$Default, IUsagePlan, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IUsagePlan.Jsii$Proxy
Enclosing interface:
IUsagePlan
@Internal public static interface IUsagePlan.Jsii$Default extends IUsagePlan, IResource.Jsii$Default
Internal default implementation for IUsagePlan.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface software.constructs.IConstruct

    software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.constructs.IDependable

    software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

    IResource.Jsii$Default, IResource.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.IUsagePlan

    IUsagePlan.Jsii$Default, IUsagePlan.Jsii$Proxy

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    addApiKey(IApiKey apiKey, AddApiKeyOptions options)
    Adds an ApiKey.
    default void
    applyRemovalPolicy(RemovalPolicy policy)
    Apply the given removal policy to this resource.
    default ResourceEnvironment
    getEnv()
    The environment this resource belongs to.
    default software.constructs.Node
    getNode()
    The tree node.
    default Stack
    getStack()
    The stack in which this resource is defined.
    default String
    getUsagePlanId()
    Id of the usage plan.

    Methods inherited from interface software.amazon.awscdk.services.apigateway.IUsagePlan

    addApiKey

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getNode

      @Stability(Stable) @NotNull default software.constructs.Node getNode()
      The tree node.
      Specified by:
      getNode in interface software.constructs.IConstruct
      Specified by:
      getNode in interface software.constructs.IConstruct.Jsii$Default
      Specified by:
      getNode in interface IResource.Jsii$Default

    • getEnv

      @Stability(Stable) @NotNull default ResourceEnvironment getEnv()
      The environment this resource belongs to.

      For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

      Specified by:
      getEnv in interface IResource
      Specified by:
      getEnv in interface IResource.Jsii$Default

    • getStack

      @Stability(Stable) @NotNull default Stack getStack()
      The stack in which this resource is defined.
      Specified by:
      getStack in interface IResource
      Specified by:
      getStack in interface IResource.Jsii$Default

    • getUsagePlanId

      @Stability(Stable) @NotNull default String getUsagePlanId()
      Id of the usage plan.
      Specified by:
      getUsagePlanId in interface IUsagePlan

    • applyRemovalPolicy

      @Stability(Stable) default void applyRemovalPolicy(@NotNull RemovalPolicy policy)
      Apply the given removal policy to this resource.

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

      Specified by:
      applyRemovalPolicy in interface IResource
      Specified by:
      applyRemovalPolicy in interface IResource.Jsii$Default
      Parameters:
      policy - This parameter is required.

    • addApiKey

      @Stability(Stable) default void addApiKey(@NotNull IApiKey apiKey, @Nullable AddApiKeyOptions options)
      Adds an ApiKey.

      Specified by:
      addApiKey in interface IUsagePlan
      Parameters:
      apiKey - the api key to associate with this usage plan. This parameter is required.
      options - options that control the behaviour of this method.