How to create a Dynamic Resource Provider for Opensearch

Question

Pulumi · Accepted Answer

Pulumi does not have a built-in provider specifically for OpenSearch Service. However, Pulumi does provide a way to manage resources that do not have first-class providers via dynamic providers.

A Dynamic Resource Provider is defined by implementing the methods of the `pulumi.dynamic.ResourceProvider` interface. Those methods are:

`check`: This method takes the proposed set of resource inputs and returns the inputs after they've been validated and potentially defaulted. This is an optional method.

`diff`: This method is called when a resource update is being performed. This is an optional method.

`create`: This method is called upon resource creation.

`read`: This method is called to read the state of a resource.

`update`: This method is called to update an existing resource.

`delete`: This method is called when a resource is deleted.

Here's a basic example of a dynamic provider for OpenSearch. This doesn't do anything practical, but serves as a sample to the structure.

```typescript
import * as pulumi from "@pulumi/pulumi";
import * as dynamic from "@pulumi/pulumi/dynamic";

class MyDynamicProvider implements dynamic.ResourceProvider {
    async create(inputs: any): Promise<dynamic.CreateResult> {
        // Code here to create an OpenSearch instance
        // Let's pretend the create operation returns an `id` and `outValue`
        const id = "some-id";
        const outValue = "some output value";
        
        return { id: id, outs: { output1: outValue } };
    }
}

const provider = new MyDynamicProvider();
const myResource = new dynamic.Resource("myResource", {}, provider);
```

In this case, you'd replace the comments in the `create` method with code that actually creates an OpenSearch instance, possibly using an SDK provided by your cloud provider. The `id` and `outValue` variables are stand-ins for any output values returned when creating your resource.

Notice this doesn't do anything to manage changes to the resource (i.e. `diff` and `update`), check inputs, or clean up the resource when it's unneeded (i.e. `delete`). Expansion on these items would depend on the OpenSearch service and SDK you're using.

It's extremely important to ensure any sensitive data (like credentials) are marked as such so they are appropriately encrypted. When returning these in `outs` from `create` or `update`, use the `pulumi.secret()` function.

For complete management of OpenSearch via Pulumi, writing a new Pulumi provider would be more suitable, but is much more involved and goes beyond this introductory view.