Package software.amazon.awscdk.services.apigatewayv2

Class RateLimitedApiKeyProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.RateLimitedApiKeyProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<RateLimitedApiKeyProps>

Enclosing interface:

RateLimitedApiKeyProps

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

A builder for RateLimitedApiKeyProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	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	description(String description)	Sets the value of ApiKeyOptions.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	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 Details

Builder

public Builder()

Method Details

apiStages

@Stability(Stable)
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(Stable)
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(Stable)
public RateLimitedApiKeyProps.Builder throttle(ThrottleSettings throttle)

Sets the value of RateLimitedApiKeyProps.getThrottle()

Parameters:

throttle - Overall throttle settings for the API.

Returns:

this

customerId

@Stability(Stable)
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

enabled

@Stability(Stable)
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(Stable)
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

apiKeyName

@Stability(Stable)
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

description

@Stability(Stable)
public RateLimitedApiKeyProps.Builder description(String description)

Sets the value of ApiKeyOptions.getDescription()

Parameters:

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

Returns:

this

value

@Stability(Stable)
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

build

@Stability(Stable)
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