Package software.amazon.awscdk.services.apigateway

Class RateLimitedApiKeyProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.apigateway.RateLimitedApiKeyProps.Jsii$Proxy
All Implemented Interfaces:
ApiKeyOptions, ApiKeyProps, RateLimitedApiKeyProps, ResourceOptions, software.amazon.jsii.JsiiSerializable
Enclosing interface:
RateLimitedApiKeyProps
@Stability(Stable) @Internal public static final class RateLimitedApiKeyProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements RateLimitedApiKeyProps
An implementation for RateLimitedApiKeyProps

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(RateLimitedApiKeyProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the RateLimitedApiKeyProps.Builder.

  • Method Details

    • getApiStages

      public final List<UsagePlanPerApiStage> getApiStages()
      Description copied from interface: RateLimitedApiKeyProps
      API Stages to be associated with the RateLimitedApiKey.

      If you already prepared UsagePlan resource explicitly, you should use stages property. If you prefer to prepare UsagePlan resource implicitly via RateLimitedApiKey, or you should specify throttle settings at each stage individually, you should use apiStages property.

      Default: none

      Specified by:
      getApiStages in interface RateLimitedApiKeyProps

    • getQuota

      public final QuotaSettings getQuota()
      Description copied from interface: RateLimitedApiKeyProps
      Number of requests clients can make in a given time period.

      Default: none

      Specified by:
      getQuota in interface RateLimitedApiKeyProps

    • getThrottle

      public final ThrottleSettings getThrottle()
      Description copied from interface: RateLimitedApiKeyProps
      Overall throttle settings for the API.

      Default: none

      Specified by:
      getThrottle in interface RateLimitedApiKeyProps

    • getCustomerId

      public final String getCustomerId()
      Description copied from interface: ApiKeyProps
      An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.

      Default: none

      Specified by:
      getCustomerId in interface ApiKeyProps

    • getEnabled

      public final Boolean getEnabled()
      Description copied from interface: ApiKeyProps
      Indicates whether the API key can be used by clients.

      Default: true

      Specified by:
      getEnabled in interface ApiKeyProps

    • getGenerateDistinctId

      public final Boolean getGenerateDistinctId()
      Description copied from interface: ApiKeyProps
      Specifies whether the key identifier is distinct from the created API key value.

      Default: false

      Specified by:
      getGenerateDistinctId in interface ApiKeyProps

    • getResources

      public final List<IRestApi> getResources()
      Description copied from interface: ApiKeyProps
      (deprecated) A list of resources this api key is associated with.

      Default: none

      Specified by:
      getResources in interface ApiKeyProps

    • getStages

      public final List<IStage> getStages()
      Description copied from interface: ApiKeyProps
      A list of Stages this api key is associated with.

      Default: - the api key is not associated with any stages

      Specified by:
      getStages in interface ApiKeyProps

    • getApiKeyName

      public final String getApiKeyName()
      Description copied from interface: ApiKeyOptions
      A name for the API key.

      If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name.

      Default: automically generated name

      Specified by:
      getApiKeyName in interface ApiKeyOptions

    • getDescription

      public final String getDescription()
      Description copied from interface: ApiKeyOptions
      A description of the purpose of the API key.

      Default: none

      Specified by:
      getDescription in interface ApiKeyOptions

    • getValue

      public final String getValue()
      Description copied from interface: ApiKeyOptions
      The value of the API key.

      Must be at least 20 characters long.

      Default: none

      Specified by:
      getValue in interface ApiKeyOptions

    • getDefaultCorsPreflightOptions

      public final CorsOptions getDefaultCorsPreflightOptions()
      Description copied from interface: ResourceOptions
      Adds a CORS preflight OPTIONS method to this resource and all child resources.

      You can add CORS at the resource-level using addCorsPreflight.

      Default: - CORS is disabled

      Specified by:
      getDefaultCorsPreflightOptions in interface ResourceOptions

    • getDefaultIntegration

      public final Integration getDefaultIntegration()
      Description copied from interface: ResourceOptions
      An integration to use as a default for all methods created within this API unless an integration is specified.

      Default: - Inherited from parent.

      Specified by:
      getDefaultIntegration in interface ResourceOptions

    • getDefaultMethodOptions

      public final MethodOptions getDefaultMethodOptions()
      Description copied from interface: ResourceOptions
      Method options to use as a default for all methods created within this API unless custom options are specified.

      Default: - Inherited from parent.

      Specified by:
      getDefaultMethodOptions in interface ResourceOptions

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object