Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Purrl
  3. API Docs
  4. Purrl
purrl v0.6.2 published on Monday, Feb 10, 2025 by Pulumiverse
pulumiverse/pulumi-purrl

purrl.Purrl

Explore with Pulumi AI

purrl logo
purrl v0.6.2 published on Monday, Feb 10, 2025 by Pulumiverse
pulumiverse/pulumi-purrl

    A Pulumi provider for making API calls

    Create Purrl Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Purrl(name: string, args: PurrlArgs, opts?: CustomResourceOptions);
    @overload
def Purrl(resource_name: str,
          args: PurrlArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Purrl(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          method: Optional[str] = None,
          url: Optional[str] = None,
          response_codes: Optional[Sequence[str]] = None,
          name: Optional[str] = None,
          delete_key: Optional[str] = None,
          delete_url: Optional[str] = None,
          delete_headers: Optional[Mapping[str, str]] = None,
          delete_insecure_skip_tls_verify: Optional[bool] = None,
          body: Optional[str] = None,
          delete_method: Optional[str] = None,
          delete_response_codes: Optional[Sequence[str]] = None,
          delete_cert: Optional[str] = None,
          headers: Optional[Mapping[str, str]] = None,
          insecure_skip_tls_verify: Optional[bool] = None,
          key: Optional[str] = None,
          delete_ca_cert: Optional[str] = None,
          delete_body: Optional[str] = None,
          cert: Optional[str] = None,
          ca_cert: Optional[str] = None)
    func NewPurrl(ctx *Context, name string, args PurrlArgs, opts ...ResourceOption) (*Purrl, error)
    public Purrl(string name, PurrlArgs args, CustomResourceOptions? opts = null)
    public Purrl(String name, PurrlArgs args)
public Purrl(String name, PurrlArgs args, CustomResourceOptions options)

    type: purrl:Purrl
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 PurrlArgs
    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 PurrlArgs
    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 PurrlArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PurrlArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PurrlArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var purrlResource = new Purrl.Purrl("purrlResource", new()
{
    Method = "string",
    Url = "string",
    ResponseCodes = new[]
    {
        "string",
    },
    Name = "string",
    DeleteKey = "string",
    DeleteUrl = "string",
    DeleteHeaders = 
    {
        { "string", "string" },
    },
    DeleteInsecureSkipTLSVerify = false,
    Body = "string",
    DeleteMethod = "string",
    DeleteResponseCodes = new[]
    {
        "string",
    },
    DeleteCert = "string",
    Headers = 
    {
        { "string", "string" },
    },
    InsecureSkipTLSVerify = false,
    Key = "string",
    DeleteCaCert = "string",
    DeleteBody = "string",
    Cert = "string",
    CaCert = "string",
});

    example, err := purrl.NewPurrl(ctx, "purrlResource", &purrl.PurrlArgs{
	Method: pulumi.String("string"),
	Url:    pulumi.String("string"),
	ResponseCodes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:      pulumi.String("string"),
	DeleteKey: pulumi.String("string"),
	DeleteUrl: pulumi.String("string"),
	DeleteHeaders: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DeleteInsecureSkipTLSVerify: pulumi.Bool(false),
	Body:                        pulumi.String("string"),
	DeleteMethod:                pulumi.String("string"),
	DeleteResponseCodes: pulumi.StringArray{
		pulumi.String("string"),
	},
	DeleteCert: pulumi.String("string"),
	Headers: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	InsecureSkipTLSVerify: pulumi.Bool(false),
	Key:                   pulumi.String("string"),
	DeleteCaCert:          pulumi.String("string"),
	DeleteBody:            pulumi.String("string"),
	Cert:                  pulumi.String("string"),
	CaCert:                pulumi.String("string"),
})

    var purrlResource = new Purrl("purrlResource", PurrlArgs.builder()
    .method("string")
    .url("string")
    .responseCodes("string")
    .name("string")
    .deleteKey("string")
    .deleteUrl("string")
    .deleteHeaders(Map.of("string", "string"))
    .deleteInsecureSkipTLSVerify(false)
    .body("string")
    .deleteMethod("string")
    .deleteResponseCodes("string")
    .deleteCert("string")
    .headers(Map.of("string", "string"))
    .insecureSkipTLSVerify(false)
    .key("string")
    .deleteCaCert("string")
    .deleteBody("string")
    .cert("string")
    .caCert("string")
    .build());

    purrl_resource = purrl.Purrl("purrlResource",
    method="string",
    url="string",
    response_codes=["string"],
    name="string",
    delete_key="string",
    delete_url="string",
    delete_headers={
        "string": "string",
    },
    delete_insecure_skip_tls_verify=False,
    body="string",
    delete_method="string",
    delete_response_codes=["string"],
    delete_cert="string",
    headers={
        "string": "string",
    },
    insecure_skip_tls_verify=False,
    key="string",
    delete_ca_cert="string",
    delete_body="string",
    cert="string",
    ca_cert="string")

    const purrlResource = new purrl.Purrl("purrlResource", {
    method: "string",
    url: "string",
    responseCodes: ["string"],
    name: "string",
    deleteKey: "string",
    deleteUrl: "string",
    deleteHeaders: {
        string: "string",
    },
    deleteInsecureSkipTLSVerify: false,
    body: "string",
    deleteMethod: "string",
    deleteResponseCodes: ["string"],
    deleteCert: "string",
    headers: {
        string: "string",
    },
    insecureSkipTLSVerify: false,
    key: "string",
    deleteCaCert: "string",
    deleteBody: "string",
    cert: "string",
    caCert: "string",
});

    type: purrl:Purrl
properties:
    body: string
    caCert: string
    cert: string
    deleteBody: string
    deleteCaCert: string
    deleteCert: string
    deleteHeaders:
        string: string
    deleteInsecureSkipTLSVerify: false
    deleteKey: string
    deleteMethod: string
    deleteResponseCodes:
        - string
    deleteUrl: string
    headers:
        string: string
    insecureSkipTLSVerify: false
    key: string
    method: string
    name: string
    responseCodes:
        - string
    url: string

    Purrl 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 Purrl resource accepts the following input properties:

    Method string
    The HTTP method to use.
    Name string
    The name for this API call.
    ResponseCodes List<string>
    The expected response code.
    Url string
    The API endpoint to call.
    Body string
    The body of the request.
    CaCert string
    The CA certificate if server cert is not signed by a trusted CA.
    Cert string
    The client certificate to use for TLS verification.
    DeleteBody string
    The body of the request.
    DeleteCaCert string
    The CA certificate if server cert is not signed by a trusted CA.
    DeleteCert string
    The client certificate to use for TLS verification.
    DeleteHeaders Dictionary<string, string>
    The headers to send with the request.
    DeleteInsecureSkipTLSVerify bool
    Skip TLS verification.
    DeleteKey string
    The client key to use for TLS verification.
    DeleteMethod string
    The HTTP method to use.
    DeleteResponseCodes List<string>
    The expected response code.
    DeleteUrl string
    The API endpoint to call.
    Headers Dictionary<string, string>
    The headers to send with the request.
    InsecureSkipTLSVerify bool
    Skip TLS verification.
    Key string
    The client key to use for TLS verification.
    Method string
    The HTTP method to use.
    Name string
    The name for this API call.
    ResponseCodes []string
    The expected response code.
    Url string
    The API endpoint to call.
    Body string
    The body of the request.
    CaCert string
    The CA certificate if server cert is not signed by a trusted CA.
    Cert string
    The client certificate to use for TLS verification.
    DeleteBody string
    The body of the request.
    DeleteCaCert string
    The CA certificate if server cert is not signed by a trusted CA.
    DeleteCert string
    The client certificate to use for TLS verification.
    DeleteHeaders map[string]string
    The headers to send with the request.
    DeleteInsecureSkipTLSVerify bool
    Skip TLS verification.
    DeleteKey string
    The client key to use for TLS verification.
    DeleteMethod string
    The HTTP method to use.
    DeleteResponseCodes []string
    The expected response code.
    DeleteUrl string
    The API endpoint to call.
    Headers map[string]string
    The headers to send with the request.
    InsecureSkipTLSVerify bool
    Skip TLS verification.
    Key string
    The client key to use for TLS verification.
    method String
    The HTTP method to use.
    name String
    The name for this API call.
    responseCodes List<String>
    The expected response code.
    url String
    The API endpoint to call.
    body String
    The body of the request.
    caCert String
    The CA certificate if server cert is not signed by a trusted CA.
    cert String
    The client certificate to use for TLS verification.
    deleteBody String
    The body of the request.
    deleteCaCert String
    The CA certificate if server cert is not signed by a trusted CA.
    deleteCert String
    The client certificate to use for TLS verification.
    deleteHeaders Map<String,String>
    The headers to send with the request.
    deleteInsecureSkipTLSVerify Boolean
    Skip TLS verification.
    deleteKey String
    The client key to use for TLS verification.
    deleteMethod String
    The HTTP method to use.
    deleteResponseCodes List<String>
    The expected response code.
    deleteUrl String
    The API endpoint to call.
    headers Map<String,String>
    The headers to send with the request.
    insecureSkipTLSVerify Boolean
    Skip TLS verification.
    key String
    The client key to use for TLS verification.
    method string
    The HTTP method to use.
    name string
    The name for this API call.
    responseCodes string[]
    The expected response code.
    url string
    The API endpoint to call.
    body string
    The body of the request.
    caCert string
    The CA certificate if server cert is not signed by a trusted CA.
    cert string
    The client certificate to use for TLS verification.
    deleteBody string
    The body of the request.
    deleteCaCert string
    The CA certificate if server cert is not signed by a trusted CA.
    deleteCert string
    The client certificate to use for TLS verification.
    deleteHeaders {[key: string]: string}
    The headers to send with the request.
    deleteInsecureSkipTLSVerify boolean
    Skip TLS verification.
    deleteKey string
    The client key to use for TLS verification.
    deleteMethod string
    The HTTP method to use.
    deleteResponseCodes string[]
    The expected response code.
    deleteUrl string
    The API endpoint to call.
    headers {[key: string]: string}
    The headers to send with the request.
    insecureSkipTLSVerify boolean
    Skip TLS verification.
    key string
    The client key to use for TLS verification.
    method str
    The HTTP method to use.
    name str
    The name for this API call.
    response_codes Sequence[str]
    The expected response code.
    url str
    The API endpoint to call.
    body str
    The body of the request.
    ca_cert str
    The CA certificate if server cert is not signed by a trusted CA.
    cert str
    The client certificate to use for TLS verification.
    delete_body str
    The body of the request.
    delete_ca_cert str
    The CA certificate if server cert is not signed by a trusted CA.
    delete_cert str
    The client certificate to use for TLS verification.
    delete_headers Mapping[str, str]
    The headers to send with the request.
    delete_insecure_skip_tls_verify bool
    Skip TLS verification.
    delete_key str
    The client key to use for TLS verification.
    delete_method str
    The HTTP method to use.
    delete_response_codes Sequence[str]
    The expected response code.
    delete_url str
    The API endpoint to call.
    headers Mapping[str, str]
    The headers to send with the request.
    insecure_skip_tls_verify bool
    Skip TLS verification.
    key str
    The client key to use for TLS verification.
    method String
    The HTTP method to use.
    name String
    The name for this API call.
    responseCodes List<String>
    The expected response code.
    url String
    The API endpoint to call.
    body String
    The body of the request.
    caCert String
    The CA certificate if server cert is not signed by a trusted CA.
    cert String
    The client certificate to use for TLS verification.
    deleteBody String
    The body of the request.
    deleteCaCert String
    The CA certificate if server cert is not signed by a trusted CA.
    deleteCert String
    The client certificate to use for TLS verification.
    deleteHeaders Map<String>
    The headers to send with the request.
    deleteInsecureSkipTLSVerify Boolean
    Skip TLS verification.
    deleteKey String
    The client key to use for TLS verification.
    deleteMethod String
    The HTTP method to use.
    deleteResponseCodes List<String>
    The expected response code.
    deleteUrl String
    The API endpoint to call.
    headers Map<String>
    The headers to send with the request.
    insecureSkipTLSVerify Boolean
    Skip TLS verification.
    key String
    The client key to use for TLS verification.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Purrl resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Response string
    The response from the API call.
    ResponseCode int
    DeleteResponse string
    The response from the API call.
    Id string
    The provider-assigned unique ID for this managed resource.
    Response string
    The response from the API call.
    ResponseCode int
    DeleteResponse string
    The response from the API call.
    id String
    The provider-assigned unique ID for this managed resource.
    response String
    The response from the API call.
    responseCode Integer
    deleteResponse String
    The response from the API call.
    id string
    The provider-assigned unique ID for this managed resource.
    response string
    The response from the API call.
    responseCode number
    deleteResponse string
    The response from the API call.
    id str
    The provider-assigned unique ID for this managed resource.
    response str
    The response from the API call.
    response_code int
    delete_response str
    The response from the API call.
    id String
    The provider-assigned unique ID for this managed resource.
    response String
    The response from the API call.
    responseCode Number
    deleteResponse String
    The response from the API call.

    Package Details

    Repository
    purrl pulumiverse/pulumi-purrl
    License
    Apache-2.0
    purrl logo
    purrl v0.6.2 published on Monday, Feb 10, 2025 by Pulumiverse
    pulumiverse/pulumi-purrl