public static final class RateLimitedApiKeyProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements RateLimitedApiKeyProps
RateLimitedApiKeyProps
RateLimitedApiKeyProps.Builder, RateLimitedApiKeyProps.Jsii$Proxy
Modifier | Constructor and Description |
---|---|
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
Modifier and Type | Method and Description |
---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(java.lang.Object o) |
java.lang.String |
getApiKeyName()
A name for the API key.
|
java.util.List<UsagePlanPerApiStage> |
getApiStages()
API Stages to be associated with the RateLimitedApiKey.
|
java.lang.String |
getCustomerId()
An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.
|
CorsOptions |
getDefaultCorsPreflightOptions()
Adds a CORS preflight OPTIONS method to this resource and all child resources.
|
Integration |
getDefaultIntegration()
An integration to use as a default for all methods created within this API unless an integration is specified.
|
MethodOptions |
getDefaultMethodOptions()
Method options to use as a default for all methods created within this API unless custom options are specified.
|
java.lang.String |
getDescription()
A description of the purpose of the API key.
|
java.lang.Boolean |
getEnabled()
Indicates whether the API key can be used by clients.
|
java.lang.Boolean |
getGenerateDistinctId()
Specifies whether the key identifier is distinct from the created API key value.
|
QuotaSettings |
getQuota()
Number of requests clients can make in a given time period.
|
java.util.List<IRestApi> |
getResources()
A list of resources this api key is associated with.
|
ThrottleSettings |
getThrottle()
Overall throttle settings for the API.
|
java.lang.String |
getValue()
The value of the API key.
|
int |
hashCode() |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
builder
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef
- Reference to the JSII managed object.public final java.util.List<UsagePlanPerApiStage> getApiStages()
RateLimitedApiKeyProps
Default: none
getApiStages
in interface RateLimitedApiKeyProps
public final QuotaSettings getQuota()
RateLimitedApiKeyProps
Default: none
getQuota
in interface RateLimitedApiKeyProps
public final ThrottleSettings getThrottle()
RateLimitedApiKeyProps
Default: none
getThrottle
in interface RateLimitedApiKeyProps
public final java.lang.String getCustomerId()
ApiKeyProps
Default: none
getCustomerId
in interface ApiKeyProps
public final java.lang.Boolean getEnabled()
ApiKeyProps
Default: true
getEnabled
in interface ApiKeyProps
public final java.lang.Boolean getGenerateDistinctId()
ApiKeyProps
Default: false
getGenerateDistinctId
in interface ApiKeyProps
public final java.util.List<IRestApi> getResources()
ApiKeyProps
Default: none
getResources
in interface ApiKeyProps
public final java.lang.String getApiKeyName()
ApiKeyOptions
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
getApiKeyName
in interface ApiKeyOptions
public final java.lang.String getDescription()
ApiKeyOptions
Default: none
getDescription
in interface ApiKeyOptions
public final java.lang.String getValue()
ApiKeyOptions
Must be at least 20 characters long.
Default: none
getValue
in interface ApiKeyOptions
public final CorsOptions getDefaultCorsPreflightOptions()
ResourceOptions
You can add CORS at the resource-level using addCorsPreflight
.
Default: - CORS is disabled
getDefaultCorsPreflightOptions
in interface ResourceOptions
public final Integration getDefaultIntegration()
ResourceOptions
Default: - Inherited from parent.
getDefaultIntegration
in interface ResourceOptions
public final MethodOptions getDefaultMethodOptions()
ResourceOptions
Default: - Inherited from parent.
getDefaultMethodOptions
in interface ResourceOptions
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
public final boolean equals(java.lang.Object o)
public final int hashCode()