Package software.amazon.awscdk.services.apigateway

Interface ResourceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, ResourceOptions

All Known Implementing Classes:

ResourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-17T21:37:25.551Z")
@Stability(Stable)
public interface ResourceProps
extends software.amazon.jsii.JsiiSerializable, ResourceOptions

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;
 ResourceProps resourceProps = ResourceProps.builder()
         .parent(resource)
         .pathPart("pathPart")
         // the properties below are optional
         .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 Classes

Modifier and Type	Interface	Description
static final class	ResourceProps.Builder	A builder for ResourceProps
static final class	ResourceProps.Jsii$Proxy	An implementation for ResourceProps

Method Summary

Modifier and Type	Method	Description
static ResourceProps.Builder	builder()
IResource	getParent()	The parent resource of this resource.
String	getPathPart()	A path name for the resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.apigateway.ResourceOptions

getDefaultCorsPreflightOptions, getDefaultIntegration, getDefaultMethodOptions

Method Details

getParent

@Stability(Stable)
@NotNull
IResource getParent()

The parent resource of this resource.

You can either pass another Resource object or a RestApi object here.

getPathPart

@Stability(Stable)
@NotNull
String getPathPart()

A path name for the resource.

builder

@Stability(Stable)
static ResourceProps.Builder builder()

Returns:

a ResourceProps.Builder of ResourceProps