documentDBInstance.go

// Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***

package scaleway

import (
	"context"
	"reflect"

	"errors"
	"github.com/dirien/pulumi-scaleway/sdk/v2/go/scaleway/internal"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

// Creates and manages Scaleway Database Instances.
// For more information, see [the documentation](https://www.scaleway.com/en/developers/api/document_db/).
//
// ## Examples
//
// ### Example Basic
//
// ```go
// package main
//
// import (
//
//	"github.com/dirien/pulumi-scaleway/sdk/v2/go/scaleway"
//	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
//
// )
//
//	func main() {
//		pulumi.Run(func(ctx *pulumi.Context) error {
//			_, err := scaleway.NewDocumentDBInstance(ctx, "main", &scaleway.DocumentDBInstanceArgs{
//				Engine:   pulumi.String("FerretDB-1"),
//				NodeType: pulumi.String("docdb-play2-pico"),
//				Password: pulumi.String("thiZ_is_v&ry_s3cret"),
//				Tags: pulumi.StringArray{
//					pulumi.String("terraform-test"),
//					pulumi.String("scaleway_documentdb_instance"),
//					pulumi.String("minimal"),
//				},
//				UserName:       pulumi.String("my_initial_user"),
//				VolumeSizeInGb: pulumi.Int(20),
//			})
//			if err != nil {
//				return err
//			}
//			return nil
//		})
//	}
//
// ```
//
// ## Import
//
// Database Instance can be imported using the `{region}/{id}`, e.g. bash
//
// ```sh
//
//	$ pulumi import scaleway:index/documentDBInstance:DocumentDBInstance db fr-par/11111111-1111-1111-1111-111111111111
//
// ```
type DocumentDBInstance struct {
	pulumi.CustomResourceState

	// Database Instance's engine version (e.g. `FerretDB-1`).
	//
	// > **Important:** Updates to `engine` will recreate the Database Instance.
	Engine pulumi.StringOutput `pulumi:"engine"`
	// Enable or disable high availability for the database instance.
	IsHaCluster pulumi.BoolPtrOutput `pulumi:"isHaCluster"`
	// The name of the Database Instance.
	Name pulumi.StringOutput `pulumi:"name"`
	// The type of database instance you want to create (e.g. `docdb-play2-pico`).
	//
	// > **Important:** Updates to `nodeType` will upgrade the Database Instance to the desired `nodeType` without any
	// interruption. Keep in mind that you cannot downgrade a Database Instance.
	NodeType pulumi.StringOutput `pulumi:"nodeType"`
	// Password for the first user of the database instance.
	Password pulumi.StringPtrOutput `pulumi:"password"`
	// `projectId`) The ID of the project the Database
	// Instance is associated with.
	ProjectId pulumi.StringOutput `pulumi:"projectId"`
	// `region`) The region
	// in which the Database Instance should be created.
	Region pulumi.StringOutput `pulumi:"region"`
	// The tags associated with the Database Instance.
	Tags pulumi.StringArrayOutput `pulumi:"tags"`
	// Enable telemetry to collects basic anonymous usage data and sends them to FerretDB telemetry service. More about the telemetry [here](https://docs.ferretdb.io/telemetry/#configure-telemetry).
	//
	// > **Important:** Updates to `isHaCluster` will recreate the Database Instance.
	TelemetryEnabled pulumi.BoolPtrOutput `pulumi:"telemetryEnabled"`
	// Identifier for the first user of the database instance.
	//
	// > **Important:** Updates to `userName` will recreate the Database Instance.
	UserName pulumi.StringPtrOutput `pulumi:"userName"`
	// Volume size (in GB) when `volumeType` is set to `bssd`.
	VolumeSizeInGb pulumi.IntOutput `pulumi:"volumeSizeInGb"`
	// Type of volume where data are stored (`bssd` or `lssd`).
	VolumeType pulumi.StringPtrOutput `pulumi:"volumeType"`
}

// NewDocumentDBInstance registers a new resource with the given unique name, arguments, and options.
func NewDocumentDBInstance(ctx *pulumi.Context,
	name string, args *DocumentDBInstanceArgs, opts ...pulumi.ResourceOption) (*DocumentDBInstance, error) {
	if args == nil {
		return nil, errors.New("missing one or more required arguments")
	}

	if args.Engine == nil {
		return nil, errors.New("invalid value for required argument 'Engine'")
	}
	if args.NodeType == nil {
		return nil, errors.New("invalid value for required argument 'NodeType'")
	}
	if args.Password != nil {
		args.Password = pulumi.ToSecret(args.Password).(pulumi.StringPtrInput)
	}
	secrets := pulumi.AdditionalSecretOutputs([]string{
		"password",
	})
	opts = append(opts, secrets)
	opts = internal.PkgResourceDefaultOpts(opts)
	var resource DocumentDBInstance
	err := ctx.RegisterResource("scaleway:index/documentDBInstance:DocumentDBInstance", name, args, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// GetDocumentDBInstance gets an existing DocumentDBInstance resource's state with the given name, ID, and optional
// state properties that are used to uniquely qualify the lookup (nil if not required).
func GetDocumentDBInstance(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DocumentDBInstanceState, opts ...pulumi.ResourceOption) (*DocumentDBInstance, error) {
	var resource DocumentDBInstance
	err := ctx.ReadResource("scaleway:index/documentDBInstance:DocumentDBInstance", name, id, state, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// Input properties used for looking up and filtering DocumentDBInstance resources.
type documentDBInstanceState struct {
	// Database Instance's engine version (e.g. `FerretDB-1`).
	//
	// > **Important:** Updates to `engine` will recreate the Database Instance.
	Engine *string `pulumi:"engine"`
	// Enable or disable high availability for the database instance.
	IsHaCluster *bool `pulumi:"isHaCluster"`
	// The name of the Database Instance.
	Name *string `pulumi:"name"`
	// The type of database instance you want to create (e.g. `docdb-play2-pico`).
	//
	// > **Important:** Updates to `nodeType` will upgrade the Database Instance to the desired `nodeType` without any
	// interruption. Keep in mind that you cannot downgrade a Database Instance.
	NodeType *string `pulumi:"nodeType"`
	// Password for the first user of the database instance.
	Password *string `pulumi:"password"`
	// `projectId`) The ID of the project the Database
	// Instance is associated with.
	ProjectId *string `pulumi:"projectId"`
	// `region`) The region
	// in which the Database Instance should be created.
	Region *string `pulumi:"region"`
	// The tags associated with the Database Instance.
	Tags []string `pulumi:"tags"`
	// Enable telemetry to collects basic anonymous usage data and sends them to FerretDB telemetry service. More about the telemetry [here](https://docs.ferretdb.io/telemetry/#configure-telemetry).
	//
	// > **Important:** Updates to `isHaCluster` will recreate the Database Instance.
	TelemetryEnabled *bool `pulumi:"telemetryEnabled"`
	// Identifier for the first user of the database instance.
	//
	// > **Important:** Updates to `userName` will recreate the Database Instance.
	UserName *string `pulumi:"userName"`
	// Volume size (in GB) when `volumeType` is set to `bssd`.
	VolumeSizeInGb *int `pulumi:"volumeSizeInGb"`
	// Type of volume where data are stored (`bssd` or `lssd`).
	VolumeType *string `pulumi:"volumeType"`
}

type DocumentDBInstanceState struct {
	// Database Instance's engine version (e.g. `FerretDB-1`).
	//
	// > **Important:** Updates to `engine` will recreate the Database Instance.
	Engine pulumi.StringPtrInput
	// Enable or disable high availability for the database instance.
	IsHaCluster pulumi.BoolPtrInput
	// The name of the Database Instance.
	Name pulumi.StringPtrInput
	// The type of database instance you want to create (e.g. `docdb-play2-pico`).
	//
	// > **Important:** Updates to `nodeType` will upgrade the Database Instance to the desired `nodeType` without any
	// interruption. Keep in mind that you cannot downgrade a Database Instance.
	NodeType pulumi.StringPtrInput
	// Password for the first user of the database instance.
	Password pulumi.StringPtrInput
	// `projectId`) The ID of the project the Database
	// Instance is associated with.
	ProjectId pulumi.StringPtrInput
	// `region`) The region
	// in which the Database Instance should be created.
	Region pulumi.StringPtrInput
	// The tags associated with the Database Instance.
	Tags pulumi.StringArrayInput
	// Enable telemetry to collects basic anonymous usage data and sends them to FerretDB telemetry service. More about the telemetry [here](https://docs.ferretdb.io/telemetry/#configure-telemetry).
	//
	// > **Important:** Updates to `isHaCluster` will recreate the Database Instance.
	TelemetryEnabled pulumi.BoolPtrInput
	// Identifier for the first user of the database instance.
	//
	// > **Important:** Updates to `userName` will recreate the Database Instance.
	UserName pulumi.StringPtrInput
	// Volume size (in GB) when `volumeType` is set to `bssd`.
	VolumeSizeInGb pulumi.IntPtrInput
	// Type of volume where data are stored (`bssd` or `lssd`).
	VolumeType pulumi.StringPtrInput
}

func (DocumentDBInstanceState) ElementType() reflect.Type {
	return reflect.TypeOf((*documentDBInstanceState)(nil)).Elem()
}

type documentDBInstanceArgs struct {
	// Database Instance's engine version (e.g. `FerretDB-1`).
	//
	// > **Important:** Updates to `engine` will recreate the Database Instance.
	Engine string `pulumi:"engine"`
	// Enable or disable high availability for the database instance.
	IsHaCluster *bool `pulumi:"isHaCluster"`
	// The name of the Database Instance.
	Name *string `pulumi:"name"`
	// The type of database instance you want to create (e.g. `docdb-play2-pico`).
	//
	// > **Important:** Updates to `nodeType` will upgrade the Database Instance to the desired `nodeType` without any
	// interruption. Keep in mind that you cannot downgrade a Database Instance.
	NodeType string `pulumi:"nodeType"`
	// Password for the first user of the database instance.
	Password *string `pulumi:"password"`
	// `projectId`) The ID of the project the Database
	// Instance is associated with.
	ProjectId *string `pulumi:"projectId"`
	// `region`) The region
	// in which the Database Instance should be created.
	Region *string `pulumi:"region"`
	// The tags associated with the Database Instance.
	Tags []string `pulumi:"tags"`
	// Enable telemetry to collects basic anonymous usage data and sends them to FerretDB telemetry service. More about the telemetry [here](https://docs.ferretdb.io/telemetry/#configure-telemetry).
	//
	// > **Important:** Updates to `isHaCluster` will recreate the Database Instance.
	TelemetryEnabled *bool `pulumi:"telemetryEnabled"`
	// Identifier for the first user of the database instance.
	//
	// > **Important:** Updates to `userName` will recreate the Database Instance.
	UserName *string `pulumi:"userName"`
	// Volume size (in GB) when `volumeType` is set to `bssd`.
	VolumeSizeInGb *int `pulumi:"volumeSizeInGb"`
	// Type of volume where data are stored (`bssd` or `lssd`).
	VolumeType *string `pulumi:"volumeType"`
}

// The set of arguments for constructing a DocumentDBInstance resource.
type DocumentDBInstanceArgs struct {
	// Database Instance's engine version (e.g. `FerretDB-1`).
	//
	// > **Important:** Updates to `engine` will recreate the Database Instance.
	Engine pulumi.StringInput
	// Enable or disable high availability for the database instance.
	IsHaCluster pulumi.BoolPtrInput
	// The name of the Database Instance.
	Name pulumi.StringPtrInput
	// The type of database instance you want to create (e.g. `docdb-play2-pico`).
	//
	// > **Important:** Updates to `nodeType` will upgrade the Database Instance to the desired `nodeType` without any
	// interruption. Keep in mind that you cannot downgrade a Database Instance.
	NodeType pulumi.StringInput
	// Password for the first user of the database instance.
	Password pulumi.StringPtrInput
	// `projectId`) The ID of the project the Database
	// Instance is associated with.
	ProjectId pulumi.StringPtrInput
	// `region`) The region
	// in which the Database Instance should be created.
	Region pulumi.StringPtrInput
	// The tags associated with the Database Instance.
	Tags pulumi.StringArrayInput
	// Enable telemetry to collects basic anonymous usage data and sends them to FerretDB telemetry service. More about the telemetry [here](https://docs.ferretdb.io/telemetry/#configure-telemetry).
	//
	// > **Important:** Updates to `isHaCluster` will recreate the Database Instance.
	TelemetryEnabled pulumi.BoolPtrInput
	// Identifier for the first user of the database instance.
	//
	// > **Important:** Updates to `userName` will recreate the Database Instance.
	UserName pulumi.StringPtrInput
	// Volume size (in GB) when `volumeType` is set to `bssd`.
	VolumeSizeInGb pulumi.IntPtrInput
	// Type of volume where data are stored (`bssd` or `lssd`).
	VolumeType pulumi.StringPtrInput
}

func (DocumentDBInstanceArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*documentDBInstanceArgs)(nil)).Elem()
}

type DocumentDBInstanceInput interface {
	pulumi.Input

	ToDocumentDBInstanceOutput() DocumentDBInstanceOutput
	ToDocumentDBInstanceOutputWithContext(ctx context.Context) DocumentDBInstanceOutput
}

func (*DocumentDBInstance) ElementType() reflect.Type {
	return reflect.TypeOf((**DocumentDBInstance)(nil)).Elem()
}

func (i *DocumentDBInstance) ToDocumentDBInstanceOutput() DocumentDBInstanceOutput {
	return i.ToDocumentDBInstanceOutputWithContext(context.Background())
}

func (i *DocumentDBInstance) ToDocumentDBInstanceOutputWithContext(ctx context.Context) DocumentDBInstanceOutput {
	return pulumi.ToOutputWithContext(ctx, i).(DocumentDBInstanceOutput)
}

// DocumentDBInstanceArrayInput is an input type that accepts DocumentDBInstanceArray and DocumentDBInstanceArrayOutput values.
// You can construct a concrete instance of `DocumentDBInstanceArrayInput` via:
//
//	DocumentDBInstanceArray{ DocumentDBInstanceArgs{...} }
type DocumentDBInstanceArrayInput interface {
	pulumi.Input

	ToDocumentDBInstanceArrayOutput() DocumentDBInstanceArrayOutput
	ToDocumentDBInstanceArrayOutputWithContext(context.Context) DocumentDBInstanceArrayOutput
}

type DocumentDBInstanceArray []DocumentDBInstanceInput

func (DocumentDBInstanceArray) ElementType() reflect.Type {
	return reflect.TypeOf((*[]*DocumentDBInstance)(nil)).Elem()
}

func (i DocumentDBInstanceArray) ToDocumentDBInstanceArrayOutput() DocumentDBInstanceArrayOutput {
	return i.ToDocumentDBInstanceArrayOutputWithContext(context.Background())
}

func (i DocumentDBInstanceArray) ToDocumentDBInstanceArrayOutputWithContext(ctx context.Context) DocumentDBInstanceArrayOutput {
	return pulumi.ToOutputWithContext(ctx, i).(DocumentDBInstanceArrayOutput)
}

// DocumentDBInstanceMapInput is an input type that accepts DocumentDBInstanceMap and DocumentDBInstanceMapOutput values.
// You can construct a concrete instance of `DocumentDBInstanceMapInput` via:
//
//	DocumentDBInstanceMap{ "key": DocumentDBInstanceArgs{...} }
type DocumentDBInstanceMapInput interface {
	pulumi.Input

	ToDocumentDBInstanceMapOutput() DocumentDBInstanceMapOutput
	ToDocumentDBInstanceMapOutputWithContext(context.Context) DocumentDBInstanceMapOutput
}

type DocumentDBInstanceMap map[string]DocumentDBInstanceInput

func (DocumentDBInstanceMap) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]*DocumentDBInstance)(nil)).Elem()
}

func (i DocumentDBInstanceMap) ToDocumentDBInstanceMapOutput() DocumentDBInstanceMapOutput {
	return i.ToDocumentDBInstanceMapOutputWithContext(context.Background())
}

func (i DocumentDBInstanceMap) ToDocumentDBInstanceMapOutputWithContext(ctx context.Context) DocumentDBInstanceMapOutput {
	return pulumi.ToOutputWithContext(ctx, i).(DocumentDBInstanceMapOutput)
}

type DocumentDBInstanceOutput struct{ *pulumi.OutputState }

func (DocumentDBInstanceOutput) ElementType() reflect.Type {
	return reflect.TypeOf((**DocumentDBInstance)(nil)).Elem()
}

func (o DocumentDBInstanceOutput) ToDocumentDBInstanceOutput() DocumentDBInstanceOutput {
	return o
}

func (o DocumentDBInstanceOutput) ToDocumentDBInstanceOutputWithContext(ctx context.Context) DocumentDBInstanceOutput {
	return o
}

// Database Instance's engine version (e.g. `FerretDB-1`).
//
// > **Important:** Updates to `engine` will recreate the Database Instance.
func (o DocumentDBInstanceOutput) Engine() pulumi.StringOutput {
	return o.ApplyT(func(v *DocumentDBInstance) pulumi.StringOutput { return v.Engine }).(pulumi.StringOutput)
}

// Enable or disable high availability for the database instance.
func (o DocumentDBInstanceOutput) IsHaCluster() pulumi.BoolPtrOutput {
	return o.ApplyT(func(v *DocumentDBInstance) pulumi.BoolPtrOutput { return v.IsHaCluster }).(pulumi.BoolPtrOutput)
}

// The name of the Database Instance.
func (o DocumentDBInstanceOutput) Name() pulumi.StringOutput {
	return o.ApplyT(func(v *DocumentDBInstance) pulumi.StringOutput { return v.Name }).(pulumi.StringOutput)
}

// The type of database instance you want to create (e.g. `docdb-play2-pico`).
//
// > **Important:** Updates to `nodeType` will upgrade the Database Instance to the desired `nodeType` without any
// interruption. Keep in mind that you cannot downgrade a Database Instance.
func (o DocumentDBInstanceOutput) NodeType() pulumi.StringOutput {
	return o.ApplyT(func(v *DocumentDBInstance) pulumi.StringOutput { return v.NodeType }).(pulumi.StringOutput)
}

// Password for the first user of the database instance.
func (o DocumentDBInstanceOutput) Password() pulumi.StringPtrOutput {
	return o.ApplyT(func(v *DocumentDBInstance) pulumi.StringPtrOutput { return v.Password }).(pulumi.StringPtrOutput)
}

// `projectId`) The ID of the project the Database
// Instance is associated with.
func (o DocumentDBInstanceOutput) ProjectId() pulumi.StringOutput {
	return o.ApplyT(func(v *DocumentDBInstance) pulumi.StringOutput { return v.ProjectId }).(pulumi.StringOutput)
}

// `region`) The region
// in which the Database Instance should be created.
func (o DocumentDBInstanceOutput) Region() pulumi.StringOutput {
	return o.ApplyT(func(v *DocumentDBInstance) pulumi.StringOutput { return v.Region }).(pulumi.StringOutput)
}

// The tags associated with the Database Instance.
func (o DocumentDBInstanceOutput) Tags() pulumi.StringArrayOutput {
	return o.ApplyT(func(v *DocumentDBInstance) pulumi.StringArrayOutput { return v.Tags }).(pulumi.StringArrayOutput)
}

// Enable telemetry to collects basic anonymous usage data and sends them to FerretDB telemetry service. More about the telemetry [here](https://docs.ferretdb.io/telemetry/#configure-telemetry).
//
// > **Important:** Updates to `isHaCluster` will recreate the Database Instance.
func (o DocumentDBInstanceOutput) TelemetryEnabled() pulumi.BoolPtrOutput {
	return o.ApplyT(func(v *DocumentDBInstance) pulumi.BoolPtrOutput { return v.TelemetryEnabled }).(pulumi.BoolPtrOutput)
}

// Identifier for the first user of the database instance.
//
// > **Important:** Updates to `userName` will recreate the Database Instance.
func (o DocumentDBInstanceOutput) UserName() pulumi.StringPtrOutput {
	return o.ApplyT(func(v *DocumentDBInstance) pulumi.StringPtrOutput { return v.UserName }).(pulumi.StringPtrOutput)
}

// Volume size (in GB) when `volumeType` is set to `bssd`.
func (o DocumentDBInstanceOutput) VolumeSizeInGb() pulumi.IntOutput {
	return o.ApplyT(func(v *DocumentDBInstance) pulumi.IntOutput { return v.VolumeSizeInGb }).(pulumi.IntOutput)
}

// Type of volume where data are stored (`bssd` or `lssd`).
func (o DocumentDBInstanceOutput) VolumeType() pulumi.StringPtrOutput {
	return o.ApplyT(func(v *DocumentDBInstance) pulumi.StringPtrOutput { return v.VolumeType }).(pulumi.StringPtrOutput)
}

type DocumentDBInstanceArrayOutput struct{ *pulumi.OutputState }

func (DocumentDBInstanceArrayOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*[]*DocumentDBInstance)(nil)).Elem()
}

func (o DocumentDBInstanceArrayOutput) ToDocumentDBInstanceArrayOutput() DocumentDBInstanceArrayOutput {
	return o
}

func (o DocumentDBInstanceArrayOutput) ToDocumentDBInstanceArrayOutputWithContext(ctx context.Context) DocumentDBInstanceArrayOutput {
	return o
}

func (o DocumentDBInstanceArrayOutput) Index(i pulumi.IntInput) DocumentDBInstanceOutput {
	return pulumi.All(o, i).ApplyT(func(vs []interface{}) *DocumentDBInstance {
		return vs[0].([]*DocumentDBInstance)[vs[1].(int)]
	}).(DocumentDBInstanceOutput)
}

type DocumentDBInstanceMapOutput struct{ *pulumi.OutputState }

func (DocumentDBInstanceMapOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]*DocumentDBInstance)(nil)).Elem()
}

func (o DocumentDBInstanceMapOutput) ToDocumentDBInstanceMapOutput() DocumentDBInstanceMapOutput {
	return o
}

func (o DocumentDBInstanceMapOutput) ToDocumentDBInstanceMapOutputWithContext(ctx context.Context) DocumentDBInstanceMapOutput {
	return o
}

func (o DocumentDBInstanceMapOutput) MapIndex(k pulumi.StringInput) DocumentDBInstanceOutput {
	return pulumi.All(o, k).ApplyT(func(vs []interface{}) *DocumentDBInstance {
		return vs[0].(map[string]*DocumentDBInstance)[vs[1].(string)]
	}).(DocumentDBInstanceOutput)
}

func init() {
	pulumi.RegisterInputType(reflect.TypeOf((*DocumentDBInstanceInput)(nil)).Elem(), &DocumentDBInstance{})
	pulumi.RegisterInputType(reflect.TypeOf((*DocumentDBInstanceArrayInput)(nil)).Elem(), DocumentDBInstanceArray{})
	pulumi.RegisterInputType(reflect.TypeOf((*DocumentDBInstanceMapInput)(nil)).Elem(), DocumentDBInstanceMap{})
	pulumi.RegisterOutputType(DocumentDBInstanceOutput{})
	pulumi.RegisterOutputType(DocumentDBInstanceArrayOutput{})
	pulumi.RegisterOutputType(DocumentDBInstanceMapOutput{})
}