1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. apigateway
  6. Resource

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

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

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

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi

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

    Create Resource Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Resource(name: string, args: ResourceArgs, opts?: CustomResourceOptions);
    @overload
    def Resource(resource_name: str,
                 args: ResourceArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Resource(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 parent_id: Optional[str] = None,
                 path_part: Optional[str] = None,
                 rest_api_id: Optional[str] = None)
    func NewResource(ctx *Context, name string, args ResourceArgs, opts ...ResourceOption) (*Resource, error)
    public Resource(string name, ResourceArgs args, CustomResourceOptions? opts = null)
    public Resource(String name, ResourceArgs args)
    public Resource(String name, ResourceArgs args, CustomResourceOptions options)
    
    type: aws-native:apigateway:Resource
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_apigateway_resource" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args ResourceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ResourceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ResourceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ResourceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ResourceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Resource Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Resource resource accepts the following input properties:

    ParentId string
    The parent resource's identifier.
    PathPart string
    The last path segment for this resource.
    RestApiId string
    The string identifier of the associated RestApi.
    ParentId string
    The parent resource's identifier.
    PathPart string
    The last path segment for this resource.
    RestApiId string
    The string identifier of the associated RestApi.
    parent_id string
    The parent resource's identifier.
    path_part string
    The last path segment for this resource.
    rest_api_id string
    The string identifier of the associated RestApi.
    parentId String
    The parent resource's identifier.
    pathPart String
    The last path segment for this resource.
    restApiId String
    The string identifier of the associated RestApi.
    parentId string
    The parent resource's identifier.
    pathPart string
    The last path segment for this resource.
    restApiId string
    The string identifier of the associated RestApi.
    parent_id str
    The parent resource's identifier.
    path_part str
    The last path segment for this resource.
    rest_api_id str
    The string identifier of the associated RestApi.
    parentId String
    The parent resource's identifier.
    pathPart String
    The last path segment for this resource.
    restApiId String
    The string identifier of the associated RestApi.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Resource resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceId string
    The ID for the resource. For example: abc123 .
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceId string
    The ID for the resource. For example: abc123 .
    id string
    The provider-assigned unique ID for this managed resource.
    resource_id string
    The ID for the resource. For example: abc123 .
    id String
    The provider-assigned unique ID for this managed resource.
    resourceId String
    The ID for the resource. For example: abc123 .
    id string
    The provider-assigned unique ID for this managed resource.
    resourceId string
    The ID for the resource. For example: abc123 .
    id str
    The provider-assigned unique ID for this managed resource.
    resource_id str
    The ID for the resource. For example: abc123 .
    id String
    The provider-assigned unique ID for this managed resource.
    resourceId String
    The ID for the resource. For example: abc123 .

    Look up Existing Resource Resource

    Get an existing Resource resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): Resource
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None) -> Resource
    func GetResource(ctx *Context, name string, id IDInput, state *ResourceState, opts ...ResourceOption) (*Resource, error)
    public static Resource Get(string name, Input<string> id, CustomResourceOptions? opts = null)
    public static Resource get(String name, Output<String> id, CustomResourceOptions options)
    resources:  existingResource:    type: aws-native:apigateway:Resource    get:      id: ${id}
    import {
      to = aws-native_apigateway_resource.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state ResourceState
    Pass nil. This resource has no state arguments.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Package Details

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

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

    Viewing docs for AWS Cloud Control v1.86.0
    published on Wednesday, Nov 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial