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

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.apigateway.Resource

Explore with Pulumi AI

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 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 This property is required. string
The unique name of the resource.
args This property is required. ResourceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. ResourceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ResourceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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 This property is required. string
The parent resource's identifier.
PathPart This property is required. string
The last path segment for this resource.
RestApiId This property is required. string
The string identifier of the associated RestApi.
ParentId This property is required. string
The parent resource's identifier.
PathPart This property is required. string
The last path segment for this resource.
RestApiId This property is required. string
The string identifier of the associated RestApi.
parentId This property is required. String
The parent resource's identifier.
pathPart This property is required. String
The last path segment for this resource.
restApiId This property is required. String
The string identifier of the associated RestApi.
parentId This property is required. string
The parent resource's identifier.
pathPart This property is required. string
The last path segment for this resource.
restApiId This property is required. string
The string identifier of the associated RestApi.
parent_id This property is required. str
The parent resource's identifier.
path_part This property is required. str
The last path segment for this resource.
rest_api_id This property is required. str
The string identifier of the associated RestApi.
parentId This property is required. String
The parent resource's identifier.
pathPart This property is required. String
The last path segment for this resource.
restApiId This property is required. 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

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native