software.amazon.awscdk.services.apigateway

Class MethodOptions.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.MethodOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<MethodOptions>

Enclosing interface:

MethodOptions

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

A builder for MethodOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
MethodOptions.Builder	apiKeyRequired(Boolean apiKeyRequired) Sets the value of MethodOptions.getApiKeyRequired()
MethodOptions.Builder	authorizationScopes(List<String> authorizationScopes) Sets the value of MethodOptions.getAuthorizationScopes()
MethodOptions.Builder	authorizationType(AuthorizationType authorizationType) Sets the value of MethodOptions.getAuthorizationType()
MethodOptions.Builder	authorizer(IAuthorizer authorizer) Sets the value of MethodOptions.getAuthorizer()
MethodOptions	build() Builds the configured instance.
MethodOptions.Builder	methodResponses(List<? extends MethodResponse> methodResponses) Sets the value of MethodOptions.getMethodResponses()
MethodOptions.Builder	operationName(String operationName) Sets the value of MethodOptions.getOperationName()
MethodOptions.Builder	requestModels(Map<String,? extends IModel> requestModels) Sets the value of MethodOptions.getRequestModels()
MethodOptions.Builder	requestParameters(Map<String,? extends Boolean> requestParameters) Sets the value of MethodOptions.getRequestParameters()
MethodOptions.Builder	requestValidator(IRequestValidator requestValidator) Sets the value of MethodOptions.getRequestValidator()
MethodOptions.Builder	requestValidatorOptions(RequestValidatorOptions requestValidatorOptions) Sets the value of MethodOptions.getRequestValidatorOptions()

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

apiKeyRequired

@Stability(value=Stable)
public MethodOptions.Builder apiKeyRequired(Boolean apiKeyRequired)

Sets the value of MethodOptions.getApiKeyRequired()

Parameters:

apiKeyRequired - Indicates whether the method requires clients to submit a valid API key.

Returns:

this

authorizationScopes

@Stability(value=Stable)
public MethodOptions.Builder authorizationScopes(List<String> authorizationScopes)

Sets the value of MethodOptions.getAuthorizationScopes()

Parameters:

authorizationScopes - A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation.

Returns:

this

authorizationType

@Stability(value=Stable)
public MethodOptions.Builder authorizationType(AuthorizationType authorizationType)

Sets the value of MethodOptions.getAuthorizationType()

Parameters:

authorizationType - Method authorization. If the value is set of `Custom`, an `authorizer` must also be specified. If you're using one of the authorizers that are available via the {@link Authorizer} class, such as {@link Authorizer#token()}, it is recommended that this option not be specified. The authorizer will take care of setting the correct authorization type. However, specifying an authorization type using this property that conflicts with what is expected by the {@link Authorizer} will result in an error.

Returns:

this

authorizer

@Stability(value=Stable)
public MethodOptions.Builder authorizer(IAuthorizer authorizer)

Sets the value of MethodOptions.getAuthorizer()

Parameters:

authorizer - If `authorizationType` is `Custom`, this specifies the ID of the method authorizer resource. If specified, the value of authorizationType must be set to Custom

Returns:

this

methodResponses

@Stability(value=Stable)
public MethodOptions.Builder methodResponses(List<? extends MethodResponse> methodResponses)

Sets the value of MethodOptions.getMethodResponses()

Parameters:

methodResponses - The responses that can be sent to the client who calls the method.

Returns:

this

operationName

@Stability(value=Stable)
public MethodOptions.Builder operationName(String operationName)

Sets the value of MethodOptions.getOperationName()

Parameters:

operationName - A friendly operation name for the method. For example, you can assign the OperationName of ListPets for the GET /pets method.

Returns:

this

requestModels

@Stability(value=Stable)
public MethodOptions.Builder requestModels(Map<String,? extends IModel> requestModels)

Sets the value of MethodOptions.getRequestModels()

Parameters:

requestModels - The models which describe data structure of request payload. When combined with requestValidator or requestValidatorOptions, the service will validate the API request payload before it reaches the API's Integration (including proxies). Specify requestModels as key-value pairs, with a content type (e.g. 'application/json') as the key and an API Gateway Model as the value.

Returns:

this

requestParameters

@Stability(value=Stable)
public MethodOptions.Builder requestParameters(Map<String,? extends Boolean> requestParameters)

Sets the value of MethodOptions.getRequestParameters()

Parameters:

requestParameters - The request parameters that API Gateway accepts. Specify request parameters as key-value pairs (string-to-Boolean mapping), with a source as the key and a Boolean as the value. The Boolean specifies whether a parameter is required. A source must match the format method.request.location.name, where the location is querystring, path, or header, and name is a valid, unique parameter name.

Returns:

this

requestValidator

@Stability(value=Stable)
public MethodOptions.Builder requestValidator(IRequestValidator requestValidator)

Sets the value of MethodOptions.getRequestValidator()

Parameters:

requestValidator - The ID of the associated request validator. Only one of requestValidator or requestValidatorOptions must be specified. Works together with requestModels or requestParameters to validate the request before it reaches integration like Lambda Proxy Integration.

Returns:

this

requestValidatorOptions

@Stability(value=Stable)
public MethodOptions.Builder requestValidatorOptions(RequestValidatorOptions requestValidatorOptions)

Sets the value of MethodOptions.getRequestValidatorOptions()

Parameters:

requestValidatorOptions - Request validator options to create new validator Only one of `requestValidator` or `requestValidatorOptions` must be specified. Works together with requestModels or requestParameters to validate the request before it reaches integration like Lambda Proxy Integration.

Returns:

this

build

@Stability(value=Stable)
public MethodOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of MethodOptions

Throws:

NullPointerException - if any required attribute was not provided