Interface IResource

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IDependable, IResource, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IResource.Jsii$Default
All Known Implementing Classes:
IResource.Jsii$Proxy, ProxyResource, Resource, ResourceBase

@Generated(value="jsii-pacmak/1.99.0 (build 8f757e4)", date="2024-06-13T18:49:13.709Z") @Stability(Stable) public interface IResource extends software.amazon.jsii.JsiiSerializable, IResource
  • Method Details

    • getApi

      @Stability(Stable) @NotNull IRestApi getApi()
      The rest API that this resource is part of.

      The reason we need the RestApi object itself and not just the ID is because the model is being tracked by the top-level RestApi object for the purpose of calculating it's hash to determine the ID of the deployment. This allows us to automatically update the deployment when the model of the REST API changes.

    • getPath

      @Stability(Stable) @NotNull String getPath()
      The full path of this resource.
    • getResourceId

      @Stability(Stable) @NotNull String getResourceId()
      The ID of the resource.
    • getDefaultCorsPreflightOptions

      @Stability(Stable) @Nullable default CorsOptions getDefaultCorsPreflightOptions()
      Default options for CORS preflight OPTIONS method.
    • 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.
    • 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.
    • getParentResource

      @Stability(Stable) @Nullable default IResource getParentResource()
      The parent of this resource or undefined for the root resource.
    • addCorsPreflight

      @Stability(Stable) @NotNull Method addCorsPreflight(@NotNull CorsOptions options)
      Adds an OPTIONS method to this resource which responds to Cross-Origin Resource Sharing (CORS) preflight requests.

      Cross-Origin Resource Sharing (CORS) is a mechanism that uses additional HTTP headers to tell browsers to give a web application running at one origin, access to selected resources from a different origin. A web application executes a cross-origin HTTP request when it requests a resource that has a different origin (domain, protocol, or port) from its own.

      Parameters:
      options - CORS options. This parameter is required.
      Returns:
      a Method object
      See Also:
    • addMethod

      @Stability(Stable) @NotNull Method addMethod(@NotNull String httpMethod, @Nullable Integration target, @Nullable MethodOptions options)
      Defines a new method for this resource.

      Parameters:
      httpMethod - The HTTP method. This parameter is required.
      target - The target backend integration for this method.
      options - Method options, such as authentication.
      Returns:
      The newly created Method object.
    • addMethod

      @Stability(Stable) @NotNull Method addMethod(@NotNull String httpMethod, @Nullable Integration target)
      Defines a new method for this resource.

      Parameters:
      httpMethod - The HTTP method. This parameter is required.
      target - The target backend integration for this method.
      Returns:
      The newly created Method object.
    • addMethod

      @Stability(Stable) @NotNull Method addMethod(@NotNull String httpMethod)
      Defines a new method for this resource.

      Parameters:
      httpMethod - The HTTP method. This parameter is required.
      Returns:
      The newly created Method object.
    • addProxy

      @Stability(Stable) @NotNull ProxyResource addProxy(@Nullable ProxyResourceOptions options)
      Adds a greedy proxy resource ("{proxy+}") and an ANY method to this route.

      Parameters:
      options - Default integration and method options.
    • addProxy

      @Stability(Stable) @NotNull ProxyResource addProxy()
      Adds a greedy proxy resource ("{proxy+}") and an ANY method to this route.
    • addResource

      @Stability(Stable) @NotNull Resource addResource(@NotNull String pathPart, @Nullable ResourceOptions options)
      Defines a new child resource where this resource is the parent.

      Parameters:
      pathPart - The path part for the child resource. This parameter is required.
      options - Resource options.
      Returns:
      A Resource object
    • addResource

      @Stability(Stable) @NotNull Resource addResource(@NotNull String pathPart)
      Defines a new child resource where this resource is the parent.

      Parameters:
      pathPart - The path part for the child resource. This parameter is required.
      Returns:
      A Resource object
    • getResource

      @Stability(Stable) @Nullable IResource getResource(@NotNull String pathPart)
      Retrieves a child resource by path part.

      Parameters:
      pathPart - The path part of the child resource. This parameter is required.
      Returns:
      the child resource or undefined if not found
    • resourceForPath

      @Stability(Stable) @NotNull Resource resourceForPath(@NotNull String path)
      Gets or create all resources leading up to the specified path.

      • Path may only start with "/" if this method is called on the root resource.
      • All resources are created using default options.

      Parameters:
      path - The relative path. This parameter is required.
      Returns:
      a new or existing resource.