Docs
Packages
Provider functions
A provider may make functions available in its SDK as well as resource types. These “provider functions” are often for calling a platform API to get a value that is not part of a resource. For example, the AWS provider includes the function aws.apigateway.getDomainName:
using Pulumi;
using Aws = Pulumi.Aws;
class MyStack : Stack
{
public MyStack()
{
var example = Output.Create(Aws.ApiGateway.GetDomainName.InvokeAsync(new Aws.ApiGateway.GetDomainNameArgs
{
DomainName = "api.example.com",
}));
}
}
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apigateway.LookupDomainName(ctx, &apigateway.LookupDomainNameArgs{
DomainName: "api.example.com",
}, nil)
if err != nil {
return err
}
return nil
})
}
package generated_program;
import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = Output.of(ApigatewayFunctions.getDomainName(GetDomainNameArgs.builder()
.domainName("api.example.com")
.build()));
}
}
import pulumi
import pulumi_aws as aws
example = aws.apigateway.get_domain_name(domain_name="api.example.com")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = pulumi.output(aws.apigateway.getDomainName({
domainName: "api.example.com",
}));
variables:
example:
Fn::Invoke:
Function: aws:apigateway:getDomainName
Arguments:
domainName: api.example.com
Provider functions are exposed in each language as regular functions, in two variations:
- a function that accepts plain arguments (strings and so on) and returns a Promise, or blocks until the result is available; and,
- a function that accepts
Inputvalues and returns an Output.
The documentation for a provider function will tell you the name and signature for each of the variations.
Invoke options
Each function and method also accepts “invoke options”, either as an object or as varargs depending on the host language. The options are as follows:
| Option | Explanation |
|---|---|
| parent | Supply a parent resource, which will be used to determine default providers |
| provider | Supply the provider to use explicitly. |
| version | Use exactly this version of the provider plugin. |
| pluginDownloadURL | Download the provider plugin from this URL. The download URL is otherwise inferred from the provider package. |
| async | This option is deprecated and will be removed in a future release |
The parent option has a similar purpose to the parent option used when creating a resource. The parent is consulted when determining the provider to use.
The provider option gives an explicit provider to use when running the invoked function. This is useful, for example, if you want to invoke a function in each of a set of AWS regions.
The version option specifies an exact version for the provider plugin. This can be used when you need to pin to a specific version to avoid a backward-incompatible change.
The pluginDownloadURL option gives a URL for fetching the provider plugin. It may be necessary to supply this for third-party packages (those not hosted at https://get.pulumi.com).
Provider methods
Provider SDKs may also include methods attached to a resource type. For example, in the EKS SDK, the Cluster resource has a method .GetKubeconfig:
getKubeconfig(args?: Cluster.GetKubeconfigArgs): Output<Cluster.GetKubeconfigResult>
public Output<string> GetKubeconfig(Cluster.GetKubeconfigArgs? args)
func (r *Cluster) GetKubeconfig(ctx *Context, args *ClusterGetKubeconfigArgs) (pulumi.StringOutput, error)
def get_kubeconfig(self,
profile_name: Optional[pulumi.Input[str]] = None,
role_arn: Optional[pulumi.Input[str]] = None) -> Output[str]
(no example available for Java)
(no example available for YAML)
Unlike provider functions, methods always take Input arguments, and return an Output. Methods do not have invoke options.
