GetResource
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
using Pulumi;
using Aws = Pulumi.Aws;
class MyStack : Stack
{
public MyStack()
{
var myRestApi = Output.Create(Aws.ApiGateway.GetRestApi.InvokeAsync(new Aws.ApiGateway.GetRestApiArgs
{
Name = "my-rest-api",
}));
var myResource = myRestApi.Apply(myRestApi => Output.Create(Aws.ApiGateway.GetResource.InvokeAsync(new Aws.ApiGateway.GetResourceArgs
{
Path = "/endpoint/path",
RestApiId = myRestApi.Id,
})));
}
}
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v2/go/aws/apigateway"
"github.com/pulumi/pulumi/sdk/v2/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{
Path: "/endpoint/path",
RestApiId: myRestApi.Id,
}, nil)
if err != nil {
return err
}
return nil
})
}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(path="/endpoint/path",
rest_api_id=my_rest_api.id)import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const myRestApi = pulumi.output(aws.apigateway.getRestApi({
name: "my-rest-api",
}, { async: true }));
const myResource = myRestApi.apply(myRestApi => aws.apigateway.getResource({
path: "/endpoint/path",
restApiId: myRestApi.id,
}, { async: true }));Using GetResource
function getResource(args: GetResourceArgs, opts?: InvokeOptions): Promise<GetResourceResult>function get_resource(path=None, rest_api_id=None, opts=None)func LookupResource(ctx *Context, args *LookupResourceArgs, opts ...InvokeOption) (*LookupResourceResult, error)Note: This function is named
LookupResourcein the Go SDK.
public static class GetResource {
public static Task<GetResourceResult> InvokeAsync(GetResourceArgs args, InvokeOptions? opts = null)
}The following arguments are supported:
- path str
The full path of the resource. If no path is found, an error will be returned.
- rest_
api_ strid The 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:
Package Details
- Repository
- https://github.com/pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.