Class GetRestApi

Inheritance
System.Object
GetRestApi
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.Aws.ApiGateway
Assembly: Pulumi.Aws.dll
Syntax
public static class GetRestApi

Methods

View Source

InvokeAsync(GetRestApiArgs, InvokeOptions)

Use this data source to get the id and root_resource_id of a REST API in API Gateway. To fetch the REST API you must provide a name to match against. As there is no unique name constraint on REST APIs this data source will error if there is more than one match.

{{% examples %}}

Example Usage

{{% example %}}

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",
    }));
}

}

{{% /example %}} {{% /examples %}}

Declaration
public static Task<GetRestApiResult> InvokeAsync(GetRestApiArgs args, InvokeOptions options = null)
Parameters
Type Name Description
GetRestApiArgs args
InvokeOptions options
Returns
Type Description
System.Threading.Tasks.Task<GetRestApiResult>