Class Resource

Provides an API Gateway Resource.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var myDemoAPI = new Aws.ApiGateway.RestApi("myDemoAPI", new Aws.ApiGateway.RestApiArgs
    {
        Description = "This is my API for demonstration purposes",
    });
    var myDemoResource = new Aws.ApiGateway.Resource("myDemoResource", new Aws.ApiGateway.ResourceArgs
    {
        ParentId = myDemoAPI.RootResourceId,
        PathPart = "mydemoresource",
        RestApi = myDemoAPI.Id,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Resource

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.ApiGateway

Assembly: Pulumi.Aws.dll

Syntax

public class Resource : CustomResource

Constructors

Resource(String, ResourceArgs, CustomResourceOptions)

Create a Resource resource with the given unique name, arguments, and options.

Declaration

public Resource(string name, ResourceArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ResourceArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

ParentId

The ID of the parent API resource

Declaration

public Output<string> ParentId { get; }

Property Value

Type	Description
Output<System.String>

Path

The complete path for this API resource, including all parent paths.

Declaration

public Output<string> Path { get; }

Property Value

Type	Description
Output<System.String>

PathPart

The last path segment of this API resource.

Declaration

public Output<string> PathPart { get; }

Property Value

Type	Description
Output<System.String>

RestApi

The ID of the associated REST API

Declaration

public Output<string> RestApi { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, ResourceState, CustomResourceOptions)

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

Declaration

public static Resource Get(string name, Input<string> id, ResourceState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ResourceState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Resource