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
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.RateLimitedApiKeyProps
RateLimitedApiKeyProps.Builder, RateLimitedApiKeyProps.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
Jsii$Proxy
(RateLimitedApiKeyProps.Builder builder) Constructor that initializes the object based on literal property values passed by theRateLimitedApiKeyProps.Builder
.protected
Jsii$Proxy
(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final String
A name for the API key.final List<UsagePlanPerApiStage>
API Stages to be associated with the RateLimitedApiKey.final String
An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.final CorsOptions
Adds a CORS preflight OPTIONS method to this resource and all child resources.final Integration
An integration to use as a default for all methods created within this API unless an integration is specified.final MethodOptions
Method options to use as a default for all methods created within this API unless custom options are specified.final String
A description of the purpose of the API key.final Boolean
Indicates whether the API key can be used by clients.final Boolean
Specifies whether the key identifier is distinct from the created API key value.final QuotaSettings
getQuota()
Number of requests clients can make in a given time period.(deprecated) A list of resources this api key is associated with.A list of Stages this api key is associated with.final ThrottleSettings
Overall throttle settings for the API.final String
getValue()
The value of the API key.final int
hashCode()
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
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
Constructor that initializes the object based on literal property values passed by theRateLimitedApiKeyProps.Builder
.
-
-
Method Details
-
getApiStages
Description copied from interface:RateLimitedApiKeyProps
API Stages to be associated with the RateLimitedApiKey.Default: none
- Specified by:
getApiStages
in interfaceRateLimitedApiKeyProps
-
getQuota
Description copied from interface:RateLimitedApiKeyProps
Number of requests clients can make in a given time period.Default: none
- Specified by:
getQuota
in interfaceRateLimitedApiKeyProps
-
getThrottle
Description copied from interface:RateLimitedApiKeyProps
Overall throttle settings for the API.Default: none
- Specified by:
getThrottle
in interfaceRateLimitedApiKeyProps
-
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 interfaceApiKeyProps
-
getEnabled
Description copied from interface:ApiKeyProps
Indicates whether the API key can be used by clients.Default: true
- Specified by:
getEnabled
in interfaceApiKeyProps
-
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 interfaceApiKeyProps
-
getResources
Description copied from interface:ApiKeyProps
(deprecated) A list of resources this api key is associated with.Default: none
- Specified by:
getResources
in interfaceApiKeyProps
-
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 interfaceApiKeyProps
-
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 interfaceApiKeyOptions
-
getDescription
Description copied from interface:ApiKeyOptions
A description of the purpose of the API key.Default: none
- Specified by:
getDescription
in interfaceApiKeyOptions
-
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 interfaceApiKeyOptions
-
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 interfaceResourceOptions
-
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 interfaceResourceOptions
-
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 interfaceResourceOptions
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-