Viewing docs for purrl v0.6.2
published on Monday, Feb 10, 2025 by Pulumiverse
published on Monday, Feb 10, 2025 by Pulumiverse
Purrl
I want to use the Pulumi purrl package (purrl) in my project.
## Provider details
- Package: purrl
- Version: v0.6.2
- Publisher: Pulumiverse
- Source: pulumi
- Repository: https://github.com/pulumiverse/pulumi-purrl
## Documentation
The Pulumi Cloud Registry API serves canonical, up-to-date docs for this package — including private packages and every published version. Send the "Accept: text/markdown" header for clean readable content, or "application/json" for structured data.
Start at the navigation tree, which cross-links to the readme, installation guide, and per-resource docs URL template:
- https://api.pulumi.com/api/registry/packages/pulumi/pulumiverse/purrl/versions/latest/nav
Returns a summary by default. The full tree can be hundreds of kB for large providers, so prefer targeted search: append "?q=<query>&depth=full" to filter by resource/function title or token (for example "?q=bucket&depth=full"). Only request the full nav without a query if you actually need to enumerate every resource.
Other endpoints:
- Overview and getting started: https://api.pulumi.com/api/registry/packages/pulumi/pulumiverse/purrl/versions/latest/readme
- Installation and configuration: https://api.pulumi.com/api/registry/packages/pulumi/pulumiverse/purrl/versions/latest/installation
- Per-resource/function docs: https://api.pulumi.com/api/registry/packages/pulumi/pulumiverse/purrl/versions/latest/docs/{token}?lang={lang}
Replace {token} with the percent-encoded token from the nav response (for example aws:s3/bucket:Bucket).
Replace {lang} with typescript, python, go, csharp, java, or yaml.
Fetch the installation endpoint above for the correct setup steps — install instructions vary between native providers, bridged Terraform providers, and component packages.
Help me get started using this provider. Show me a complete Pulumi program that provisions a common resource, including all necessary configuration and imports.
Viewing docs for purrl v0.6.2
published on Monday, Feb 10, 2025 by Pulumiverse
published on Monday, Feb 10, 2025 by Pulumiverse
This provider is designed to be a flexible extension of your Pulumi code to make API calls to your target endpoint. Purrl is useful when a provider does not have a resource or data source that you require, so Purrl can be used to make substitute API calls.
Example
import * as purrl from "@pulumiverse/purrl";
let purrlCommand = new purrl.Purrl("purrl", {
name: "httpbin",
url: "https://httpbin.org/get",
method: "GET",
headers: {
"test": "test",
},
responseCodes: [
"200"
],
deleteMethod: "DELETE",
deleteUrl: "https://httpbin.org/delete",
deleteResponseCodes: [
"200"
],
});
export const url = purrlCommand.response
import pulumiverse_purrl as purrl
import pulumi
purrl_command = purrl.Purrl("purrl-python", name="purrl-python",
method="GET",
headers={
"test": "test"
},
url="https://httpbin.org/get",
response_codes=[
"200"],
delete_method="DELETE",
delete_url="https://httpbin.org/delete",
delete_response_codes=["200"]
)
pulumi.export("response", purrl_command.response)
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-purrl/sdk/go/purrl"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
purrl, err := purrl.NewPurrl(ctx, "purrl", &purrl.PurrlArgs{
Url: pulumi.String("https://httpbin.org/get"),
Name: pulumi.String("httpbin"),
ResponseCodes: pulumi.StringArray{
pulumi.String("200"),
},
Method: pulumi.String("GET"),
Headers: pulumi.StringMap{
"test": pulumi.String("test"),
},
DeleteMethod: pulumi.String("DELETE"),
DeleteUrl: pulumi.String("https://httpbin.org/delete"),
DeleteResponseCodes: pulumi.StringArray{
pulumi.String("200"),
},
})
if err != nil {
return err
}
ctx.Export("response", purrl.Response)
return nil
})
}
using System.Collections.Generic;
using Pulumi;
using Pulumiverse.Purrl;
return await Deployment.RunAsync(() =>
{
var purrl =new Purrl("purrl", new PurrlArgs
{
Name = "httpbin",
Url = "https://httpbin.org/get",
ResponseCodes = new List<string> { "200" },
Method = "GET",
Headers = new Dictionary<string, string> { { "test", "test" } },
DeleteMethod = "DELETE",
DeleteUrl = "https://httpbin.org/delete",
DeleteResponseCodes = new List<string> { "200" },
});
// Export outputs here
return new Dictionary<string, object?>
{
["response"] =purrl.Response
};
});
Viewing docs for purrl v0.6.2
published on Monday, Feb 10, 2025 by Pulumiverse
published on Monday, Feb 10, 2025 by Pulumiverse