1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. apigateway
  5. getResource

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.38.0 published on Wednesday, Nov 5, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.apigateway.getResource

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.38.0 published on Wednesday, Nov 5, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    The AWS::ApiGateway::Resource resource creates a resource in an API.

    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>
    def get_resource(resource_id: Optional[str] = None,
                 rest_api_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetResourceResult
def get_resource_output(resource_id: Optional[pulumi.Input[str]] = None,
                 rest_api_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetResourceResult]
    func LookupResource(ctx *Context, args *LookupResourceArgs, opts ...InvokeOption) (*LookupResourceResult, error)
func LookupResourceOutput(ctx *Context, args *LookupResourceOutputArgs, opts ...InvokeOption) LookupResourceResultOutput

    > 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)
}
    public static CompletableFuture<GetResourceResult> getResource(GetResourceArgs args, InvokeOptions options)
public static Output<GetResourceResult> getResource(GetResourceArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:apigateway:getResource
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ResourceId string
    The ID for the resource. For example: abc123 .
    RestApiId string
    The string identifier of the associated RestApi.
    ResourceId string
    The ID for the resource. For example: abc123 .
    RestApiId string
    The string identifier of the associated RestApi.
    resourceId String
    The ID for the resource. For example: abc123 .
    restApiId String
    The string identifier of the associated RestApi.
    resourceId string
    The ID for the resource. For example: abc123 .
    restApiId string
    The string identifier of the associated RestApi.
    resource_id str
    The ID for the resource. For example: abc123 .
    rest_api_id str
    The string identifier of the associated RestApi.
    resourceId String
    The ID for the resource. For example: abc123 .
    restApiId String
    The string identifier of the associated RestApi.

    getResource Result

    The following output properties are available:

    ResourceId string
    The ID for the resource. For example: abc123 .
    ResourceId string
    The ID for the resource. For example: abc123 .
    resourceId String
    The ID for the resource. For example: abc123 .
    resourceId string
    The ID for the resource. For example: abc123 .
    resource_id str
    The ID for the resource. For example: abc123 .
    resourceId String
    The ID for the resource. For example: abc123 .

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.38.0 published on Wednesday, Nov 5, 2025 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native
      Meet Neo: Your AI Platform Teammate