1. Packages
  2. AWS
  3. API Docs
  4. apigateway
  5. getResource
AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi

aws.apigateway.getResource

Explore with Pulumi AI

AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi

Use this data source to get the id of a Resource in API Gateway. To fetch the Resource, you must provide the REST API id as well as the full path.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const myRestApi = aws.apigateway.getRestApi({
    name: "my-rest-api",
});
const myResource = myRestApi.then(myRestApi => aws.apigateway.getResource({
    restApiId: myRestApi.id,
    path: "/endpoint/path",
}));
Copy
import pulumi
import pulumi_aws as aws

my_rest_api = aws.apigateway.get_rest_api(name="my-rest-api")
my_resource = aws.apigateway.get_resource(rest_api_id=my_rest_api.id,
    path="/endpoint/path")
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/apigateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		myRestApi, err := apigateway.LookupRestApi(ctx, &apigateway.LookupRestApiArgs{
			Name: "my-rest-api",
		}, nil)
		if err != nil {
			return err
		}
		_, err = apigateway.LookupResource(ctx, &apigateway.LookupResourceArgs{
			RestApiId: myRestApi.Id,
			Path:      "/endpoint/path",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var myRestApi = Aws.ApiGateway.GetRestApi.Invoke(new()
    {
        Name = "my-rest-api",
    });

    var myResource = Aws.ApiGateway.GetResource.Invoke(new()
    {
        RestApiId = myRestApi.Apply(getRestApiResult => getRestApiResult.Id),
        Path = "/endpoint/path",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigateway.ApigatewayFunctions;
import com.pulumi.aws.apigateway.inputs.GetRestApiArgs;
import com.pulumi.aws.apigateway.inputs.GetResourceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var myRestApi = ApigatewayFunctions.getRestApi(GetRestApiArgs.builder()
            .name("my-rest-api")
            .build());

        final var myResource = ApigatewayFunctions.getResource(GetResourceArgs.builder()
            .restApiId(myRestApi.applyValue(getRestApiResult -> getRestApiResult.id()))
            .path("/endpoint/path")
            .build());

    }
}
Copy
variables:
  myRestApi:
    fn::invoke:
      function: aws:apigateway:getRestApi
      arguments:
        name: my-rest-api
  myResource:
    fn::invoke:
      function: aws:apigateway:getResource
      arguments:
        restApiId: ${myRestApi.id}
        path: /endpoint/path
Copy

Using getResource

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getResource(args: GetResourceArgs, opts?: InvokeOptions): Promise<GetResourceResult>
function getResourceOutput(args: GetResourceOutputArgs, opts?: InvokeOptions): Output<GetResourceResult>
Copy
def get_resource(path: Optional[str] = None,
                 rest_api_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetResourceResult
def get_resource_output(path: Optional[pulumi.Input[str]] = None,
                 rest_api_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetResourceResult]
Copy
func LookupResource(ctx *Context, args *LookupResourceArgs, opts ...InvokeOption) (*LookupResourceResult, error)
func LookupResourceOutput(ctx *Context, args *LookupResourceOutputArgs, opts ...InvokeOption) LookupResourceResultOutput
Copy

> Note: This function is named LookupResource in the Go SDK.

public static class GetResource 
{
    public static Task<GetResourceResult> InvokeAsync(GetResourceArgs args, InvokeOptions? opts = null)
    public static Output<GetResourceResult> Invoke(GetResourceInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetResourceResult> getResource(GetResourceArgs args, InvokeOptions options)
public static Output<GetResourceResult> getResource(GetResourceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws:apigateway/getResource:getResource
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Path This property is required. string
Full path of the resource. If no path is found, an error will be returned.
RestApiId This property is required. string
REST API id that owns the resource. If no REST API is found, an error will be returned.
Path This property is required. string
Full path of the resource. If no path is found, an error will be returned.
RestApiId This property is required. string
REST API id that owns the resource. If no REST API is found, an error will be returned.
path This property is required. String
Full path of the resource. If no path is found, an error will be returned.
restApiId This property is required. String
REST API id that owns the resource. If no REST API is found, an error will be returned.
path This property is required. string
Full path of the resource. If no path is found, an error will be returned.
restApiId This property is required. string
REST API id that owns the resource. If no REST API is found, an error will be returned.
path This property is required. str
Full path of the resource. If no path is found, an error will be returned.
rest_api_id This property is required. str
REST API id that owns the resource. If no REST API is found, an error will be returned.
path This property is required. String
Full path of the resource. If no path is found, an error will be returned.
restApiId This property is required. String
REST API id that owns the resource. If no REST API is found, an error will be returned.

getResource Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
ParentId string
Set to the ID of the parent Resource.
Path string
PathPart string
Set to the path relative to the parent Resource.
RestApiId string
Id string
The provider-assigned unique ID for this managed resource.
ParentId string
Set to the ID of the parent Resource.
Path string
PathPart string
Set to the path relative to the parent Resource.
RestApiId string
id String
The provider-assigned unique ID for this managed resource.
parentId String
Set to the ID of the parent Resource.
path String
pathPart String
Set to the path relative to the parent Resource.
restApiId String
id string
The provider-assigned unique ID for this managed resource.
parentId string
Set to the ID of the parent Resource.
path string
pathPart string
Set to the path relative to the parent Resource.
restApiId string
id str
The provider-assigned unique ID for this managed resource.
parent_id str
Set to the ID of the parent Resource.
path str
path_part str
Set to the path relative to the parent Resource.
rest_api_id str
id String
The provider-assigned unique ID for this managed resource.
parentId String
Set to the ID of the parent Resource.
path String
pathPart String
Set to the path relative to the parent Resource.
restApiId String

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi