Package software.amazon.awscdk.services.apigateway

Interface ResourceOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

ApiKeyOptions, ApiKeyProps, LambdaRestApiProps, ProxyResourceOptions, ProxyResourceProps, RateLimitedApiKeyProps, ResourceProps, RestApiOptions, RestApiProps, StepFunctionsRestApiProps

All Known Implementing Classes:

ApiKeyOptions.Jsii$Proxy, ApiKeyProps.Jsii$Proxy, LambdaRestApiProps.Jsii$Proxy, ProxyResourceOptions.Jsii$Proxy, ProxyResourceProps.Jsii$Proxy, RateLimitedApiKeyProps.Jsii$Proxy, ResourceOptions.Jsii$Proxy, ResourceProps.Jsii$Proxy, RestApiOptions.Jsii$Proxy, RestApiProps.Jsii$Proxy, StepFunctionsRestApiProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:45.065Z")
@Stability(Stable)
public interface ResourceOptions
extends software.amazon.jsii.JsiiSerializable

Example:

 Resource resource;
 Resource subtree = resource.addResource("subtree", ResourceOptions.builder()
         .defaultCorsPreflightOptions(CorsOptions.builder()
                 .allowOrigins(List.of("https://amazon.com"))
                 .build())
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ResourceOptions.Builder	builder()
default CorsOptions	getDefaultCorsPreflightOptions()	Adds a CORS preflight OPTIONS method to this resource and all child resources.
default Integration	getDefaultIntegration()	An integration to use as a default for all methods created within this API unless an integration is specified.
default MethodOptions	getDefaultMethodOptions()	Method options to use as a default for all methods created within this API unless custom options are specified.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDefaultCorsPreflightOptions

@Stability(Stable)
@Nullable
default CorsOptions getDefaultCorsPreflightOptions()

Adds a CORS preflight OPTIONS method to this resource and all child resources.

You can add CORS at the resource-level using addCorsPreflight.

Default: - CORS is disabled

getDefaultIntegration

@Stability(Stable)
@Nullable
default Integration getDefaultIntegration()

An integration to use as a default for all methods created within this API unless an integration is specified.

Default: - Inherited from parent.

getDefaultMethodOptions

@Stability(Stable)
@Nullable
default MethodOptions getDefaultMethodOptions()

Method options to use as a default for all methods created within this API unless custom options are specified.

Default: - Inherited from parent.

builder

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

Returns:

a ResourceOptions.Builder of ResourceOptions