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

Enclosing interface:

RateLimitedApiKeyProps

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 interface software.amazon.awscdk.services.apigateway.RateLimitedApiKeyProps

RateLimitedApiKeyProps.Builder, RateLimitedApiKeyProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

builder

Constructor Detail

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.

Method Detail

getApiStages

public final java.util.List<UsagePlanPerApiStage> getApiStages()

Description copied from interface: RateLimitedApiKeyProps

API Stages to be associated with the RateLimitedApiKey.

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 java.lang.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 java.lang.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 java.lang.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 java.util.List<IRestApi> getResources()

Description copied from interface: ApiKeyProps

A list of resources this api key is associated with.

Default: none

Specified by:

getResources in interface ApiKeyProps

getApiKeyName

public final java.lang.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 java.lang.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 java.lang.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

public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

equals

public final boolean equals(java.lang.Object o)

hashCode

public final int hashCode()