software.amazon.awscdk.services.apigateway

Class RateLimitedApiKeyProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.RateLimitedApiKeyProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<RateLimitedApiKeyProps>

Enclosing interface:

RateLimitedApiKeyProps

@Stability(value=Experimental)
public static final class RateLimitedApiKeyProps.Builder
extends Object
implements software.amazon.jsii.Builder<RateLimitedApiKeyProps>

A builder for RateLimitedApiKeyProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
RateLimitedApiKeyProps.Builder	apiKeyName(String apiKeyName) Sets the value of ApiKeyOptions.getApiKeyName()
RateLimitedApiKeyProps.Builder	apiStages(List<? extends UsagePlanPerApiStage> apiStages) Sets the value of RateLimitedApiKeyProps.getApiStages()
RateLimitedApiKeyProps	build() Builds the configured instance.
RateLimitedApiKeyProps.Builder	customerId(String customerId) Sets the value of ApiKeyProps.getCustomerId()
RateLimitedApiKeyProps.Builder	defaultCorsPreflightOptions(CorsOptions defaultCorsPreflightOptions) Sets the value of ResourceOptions.getDefaultCorsPreflightOptions()
RateLimitedApiKeyProps.Builder	defaultIntegration(Integration defaultIntegration) Sets the value of ResourceOptions.getDefaultIntegration()
RateLimitedApiKeyProps.Builder	defaultMethodOptions(MethodOptions defaultMethodOptions) Sets the value of ResourceOptions.getDefaultMethodOptions()
RateLimitedApiKeyProps.Builder	description(String description) Sets the value of ApiKeyProps.getDescription()
RateLimitedApiKeyProps.Builder	enabled(Boolean enabled) Sets the value of ApiKeyProps.getEnabled()
RateLimitedApiKeyProps.Builder	generateDistinctId(Boolean generateDistinctId) Sets the value of ApiKeyProps.getGenerateDistinctId()
RateLimitedApiKeyProps.Builder	quota(QuotaSettings quota) Sets the value of RateLimitedApiKeyProps.getQuota()
RateLimitedApiKeyProps.Builder	resources(List<? extends IRestApi> resources) Sets the value of ApiKeyProps.getResources()
RateLimitedApiKeyProps.Builder	throttle(ThrottleSettings throttle) Sets the value of RateLimitedApiKeyProps.getThrottle()
RateLimitedApiKeyProps.Builder	value(String value) Sets the value of ApiKeyOptions.getValue()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

apiStages

@Stability(value=Experimental)
public RateLimitedApiKeyProps.Builder apiStages(List<? extends UsagePlanPerApiStage> apiStages)

Sets the value of RateLimitedApiKeyProps.getApiStages()

Parameters:

apiStages - API Stages to be associated with the RateLimitedApiKey.

Returns:

this

quota

@Stability(value=Experimental)
public RateLimitedApiKeyProps.Builder quota(QuotaSettings quota)

Sets the value of RateLimitedApiKeyProps.getQuota()

Parameters:

quota - Number of requests clients can make in a given time period.

Returns:

this

throttle

@Stability(value=Experimental)
public RateLimitedApiKeyProps.Builder throttle(ThrottleSettings throttle)

Sets the value of RateLimitedApiKeyProps.getThrottle()

Parameters:

throttle - Overall throttle settings for the API.

Returns:

this

customerId

@Stability(value=Experimental)
public RateLimitedApiKeyProps.Builder customerId(String customerId)

Sets the value of ApiKeyProps.getCustomerId()

Parameters:

customerId - An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.

Returns:

this

description

@Stability(value=Experimental)
public RateLimitedApiKeyProps.Builder description(String description)

Sets the value of ApiKeyProps.getDescription()

Parameters:

description - A description of the purpose of the API key.

Returns:

this

enabled

@Stability(value=Experimental)
public RateLimitedApiKeyProps.Builder enabled(Boolean enabled)

Sets the value of ApiKeyProps.getEnabled()

Parameters:

enabled - Indicates whether the API key can be used by clients.

Returns:

this

generateDistinctId

@Stability(value=Experimental)
public RateLimitedApiKeyProps.Builder generateDistinctId(Boolean generateDistinctId)

Sets the value of ApiKeyProps.getGenerateDistinctId()

Parameters:

generateDistinctId - Specifies whether the key identifier is distinct from the created API key value.

Returns:

this

resources

@Stability(value=Experimental)
public RateLimitedApiKeyProps.Builder resources(List<? extends IRestApi> resources)

Sets the value of ApiKeyProps.getResources()

Parameters:

resources - A list of resources this api key is associated with.

Returns:

this

apiKeyName

@Stability(value=Experimental)
public RateLimitedApiKeyProps.Builder apiKeyName(String apiKeyName)

Sets the value of ApiKeyOptions.getApiKeyName()

Parameters:

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

Returns:

this

value

@Stability(value=Experimental)
public RateLimitedApiKeyProps.Builder value(String value)

Sets the value of ApiKeyOptions.getValue()

Parameters:

value - The value of the API key. Must be at least 20 characters long.

Returns:

this

defaultCorsPreflightOptions

@Stability(value=Experimental)
public RateLimitedApiKeyProps.Builder defaultCorsPreflightOptions(CorsOptions defaultCorsPreflightOptions)

Sets the value of ResourceOptions.getDefaultCorsPreflightOptions()

Parameters:

defaultCorsPreflightOptions - Adds a CORS preflight OPTIONS method to this resource and all child resources. You can add CORS at the resource-level using addCorsPreflight.

Returns:

this

defaultIntegration

@Stability(value=Experimental)
public RateLimitedApiKeyProps.Builder defaultIntegration(Integration defaultIntegration)

Sets the value of ResourceOptions.getDefaultIntegration()

Parameters:

defaultIntegration - An integration to use as a default for all methods created within this API unless an integration is specified.

Returns:

this

defaultMethodOptions

@Stability(value=Experimental)
public RateLimitedApiKeyProps.Builder defaultMethodOptions(MethodOptions defaultMethodOptions)

Sets the value of ResourceOptions.getDefaultMethodOptions()

Parameters:

defaultMethodOptions - Method options to use as a default for all methods created within this API unless custom options are specified.

Returns:

this

build

@Stability(value=Experimental)
public RateLimitedApiKeyProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<RateLimitedApiKeyProps>

Returns:

a new instance of RateLimitedApiKeyProps

Throws:

NullPointerException - if any required attribute was not provided