Interface ProxyResourceProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable,ProxyResourceOptions,ResourceOptions
- All Known Implementing Classes:
ProxyResourceProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
date="2025-11-13T16:09:57.884Z")
@Stability(Stable)
public interface ProxyResourceProps
extends software.amazon.jsii.JsiiSerializable, ProxyResourceOptions
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.apigateway.*;
Authorizer authorizer;
Integration integration;
Model model;
RequestValidator requestValidator;
Resource resource;
ProxyResourceProps proxyResourceProps = ProxyResourceProps.builder()
.parent(resource)
// the properties below are optional
.anyMethod(false)
.defaultCorsPreflightOptions(CorsOptions.builder()
.allowOrigins(List.of("allowOrigins"))
// the properties below are optional
.allowCredentials(false)
.allowHeaders(List.of("allowHeaders"))
.allowMethods(List.of("allowMethods"))
.disableCache(false)
.exposeHeaders(List.of("exposeHeaders"))
.maxAge(Duration.minutes(30))
.statusCode(123)
.build())
.defaultIntegration(integration)
.defaultMethodOptions(MethodOptions.builder()
.apiKeyRequired(false)
.authorizationScopes(List.of("authorizationScopes"))
.authorizationType(AuthorizationType.NONE)
.authorizer(authorizer)
.methodResponses(List.of(MethodResponse.builder()
.statusCode("statusCode")
// the properties below are optional
.responseModels(Map.of(
"responseModelsKey", model))
.responseParameters(Map.of(
"responseParametersKey", false))
.build()))
.operationName("operationName")
.requestModels(Map.of(
"requestModelsKey", model))
.requestParameters(Map.of(
"requestParametersKey", false))
.requestValidator(requestValidator)
.requestValidatorOptions(RequestValidatorOptions.builder()
.requestValidatorName("requestValidatorName")
.validateRequestBody(false)
.validateRequestParameters(false)
.build())
.build())
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forProxyResourcePropsstatic final classAn implementation forProxyResourceProps -
Method Summary
Modifier and TypeMethodDescriptionstatic ProxyResourceProps.Builderbuilder()The parent resource of this resource.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJsonMethods inherited from interface software.amazon.awscdk.services.apigateway.ProxyResourceOptions
getAnyMethodMethods inherited from interface software.amazon.awscdk.services.apigateway.ResourceOptions
getDefaultCorsPreflightOptions, getDefaultIntegration, getDefaultMethodOptions
-
Method Details
-
getParent
The parent resource of this resource.You can either pass another
Resourceobject or aRestApiobject here. -
builder
- Returns:
- a
ProxyResourceProps.BuilderofProxyResourceProps
-