Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. apigateway
  5. Resource

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.apigateway.Resource

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    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.

    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

    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.
    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.
    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 .

    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 Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native