Package software.amazon.awscdk.services.apigateway

Class ApiKeyOptions.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.ApiKeyOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ApiKeyOptions>

Enclosing interface:

ApiKeyOptions

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

A builder for ApiKeyOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ApiKeyOptions.Builder	apiKeyName(String apiKeyName)	Sets the value of ApiKeyOptions.getApiKeyName()
ApiKeyOptions	build()	Builds the configured instance.
ApiKeyOptions.Builder	defaultCorsPreflightOptions(CorsOptions defaultCorsPreflightOptions)	Sets the value of ResourceOptions.getDefaultCorsPreflightOptions()
ApiKeyOptions.Builder	defaultIntegration(Integration defaultIntegration)	Sets the value of ResourceOptions.getDefaultIntegration()
ApiKeyOptions.Builder	defaultMethodOptions(MethodOptions defaultMethodOptions)	Sets the value of ResourceOptions.getDefaultMethodOptions()
ApiKeyOptions.Builder	description(String description)	Sets the value of ApiKeyOptions.getDescription()
ApiKeyOptions.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

apiKeyName

@Stability(Stable)
public ApiKeyOptions.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 ApiKeyOptions.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 ApiKeyOptions.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(Stable)
public ApiKeyOptions.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(Stable)
public ApiKeyOptions.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(Stable)
public ApiKeyOptions.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(Stable)
public ApiKeyOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ApiKeyOptions

Throws:

NullPointerException - if any required attribute was not provided