Docs Home
We recommend new projects start with resources from the AWS provider.
aws-native.apigateway.Resource
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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
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:
- parent_
id str - The parent resource's identifier.
- path_
part str - The last path segment for this resource.
- rest_
api_ strid - 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.
- Resource
Id 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.
- resource
Id 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 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.
- resource
Id 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.