software.amazon.awscdk.services.apigateway

Class MethodOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigateway.MethodOptions.Jsii$Proxy

All Implemented Interfaces:

MethodOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

MethodOptions

@Stability(value=Experimental)
 @Internal
public static final class MethodOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements MethodOptions

An implementation for MethodOptions

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.MethodOptions

MethodOptions.Builder, MethodOptions.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(Boolean apiKeyRequired, List<String> authorizationScopes, AuthorizationType authorizationType, IAuthorizer authorizer, List<? extends MethodResponse> methodResponses, String operationName, Map<String,? extends IModel> requestModels, Map<String,? extends Boolean> requestParameters, IRequestValidator requestValidator, RequestValidatorOptions requestValidatorOptions) Constructor that initializes the object based on literal property values passed by the MethodOptions.Builder.
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(Object o)
Boolean	getApiKeyRequired() (experimental) Indicates whether the method requires clients to submit a valid API key.
List<String>	getAuthorizationScopes() (experimental) A list of authorization scopes configured on the method.
AuthorizationType	getAuthorizationType() (experimental) Method authorization.
IAuthorizer	getAuthorizer() (experimental) If `authorizationType` is `Custom`, this specifies the ID of the method authorizer resource.
List<MethodResponse>	getMethodResponses() (experimental) The responses that can be sent to the client who calls the method.
String	getOperationName() (experimental) A friendly operation name for the method.
Map<String,IModel>	getRequestModels() (experimental) The models which describe data structure of request payload.
Map<String,Boolean>	getRequestParameters() (experimental) The request parameters that API Gateway accepts.
IRequestValidator	getRequestValidator() (experimental) The ID of the associated request validator.
RequestValidatorOptions	getRequestValidatorOptions() (experimental) Request validator options to create new validator Only one of `requestValidator` or `requestValidatorOptions` must be specified.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

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

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.

Jsii$Proxy

protected Jsii$Proxy(Boolean apiKeyRequired,
                     List<String> authorizationScopes,
                     AuthorizationType authorizationType,
                     IAuthorizer authorizer,
                     List<? extends MethodResponse> methodResponses,
                     String operationName,
                     Map<String,? extends IModel> requestModels,
                     Map<String,? extends Boolean> requestParameters,
                     IRequestValidator requestValidator,
                     RequestValidatorOptions requestValidatorOptions)

Constructor that initializes the object based on literal property values passed by the MethodOptions.Builder.

Method Detail

getApiKeyRequired

public final Boolean getApiKeyRequired()

Description copied from interface: MethodOptions

(experimental) Indicates whether the method requires clients to submit a valid API key.

Default: false

Specified by:

getApiKeyRequired in interface MethodOptions

getAuthorizationScopes

public final List<String> getAuthorizationScopes()

Description copied from interface: MethodOptions

(experimental) A list of authorization scopes configured on the method.

The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation.

Default: - no authorization scopes

Specified by:

getAuthorizationScopes in interface MethodOptions

See Also:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes

getAuthorizationType

public final AuthorizationType getAuthorizationType()

Description copied from interface: MethodOptions

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

Default: - open access unless `authorizer` is specified

Specified by:

getAuthorizationType in interface MethodOptions

getAuthorizer

public final IAuthorizer getAuthorizer()

Description copied from interface: MethodOptions

(experimental) If `authorizationType` is `Custom`, this specifies the ID of the method authorizer resource.

If specified, the value of authorizationType must be set to Custom

Specified by:

getAuthorizer in interface MethodOptions

getMethodResponses

public final List<MethodResponse> getMethodResponses()

Description copied from interface: MethodOptions

(experimental) The responses that can be sent to the client who calls the method.

Default: None This property is not required, but if these are not supplied for a Lambda proxy integration, the Lambda function must return a value of the correct format, for the integration response to be correctly mapped to a response to the client.

Specified by:

getMethodResponses in interface MethodOptions

See Also:

https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-settings-method-response.html

getOperationName

public final String getOperationName()

Description copied from interface: MethodOptions

(experimental) A friendly operation name for the method.

For example, you can assign the OperationName of ListPets for the GET /pets method.

Specified by:

getOperationName in interface MethodOptions

getRequestModels

public final Map<String,IModel> getRequestModels()

Description copied from interface: MethodOptions

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

Example:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 Object userModel = api.addModel("UserModel", Map.of(
         "schema", Map.of(
                 "type", apigateway.JsonSchemaType.getOBJECT(),
                 "properties", Map.of(
                         "userId", Map.of(
                                 "type", apigateway.JsonSchema.getSTRING()),
                         "name", Map.of(
                                 "type", apigateway.JsonSchema.getSTRING())),
                 "required", asList("userId"))));
 api.root.addResource('user').addMethod("POST",
 new LambdaIntegration(userLambda), Map.of(
         "requestModels", Map.of(
                 "application/json", userModel)));

Specified by:

getRequestModels in interface MethodOptions

See Also:

https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-settings-method-request.html#setup-method-request-model

getRequestParameters

public final Map<String,Boolean> getRequestParameters()

Description copied from interface: MethodOptions

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

Default: None

Specified by:

getRequestParameters in interface MethodOptions

getRequestValidator

public final IRequestValidator getRequestValidator()

Description copied from interface: MethodOptions

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

Default: - No default validator

Specified by:

getRequestValidator in interface MethodOptions

getRequestValidatorOptions

public final RequestValidatorOptions getRequestValidatorOptions()

Description copied from interface: MethodOptions

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

Default: - No default validator

Specified by:

getRequestValidatorOptions in interface MethodOptions

$jsii$toJson

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

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object