documentdb

package
v0.0.0-...-c33e12d Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 13, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Database

type Database struct {
	pulumi.CustomResourceState

	// UUID of the documentdb instance.
	//
	// > **Important:** Updates to `instanceId` will recreate the Database.
	InstanceId pulumi.StringOutput `pulumi:"instanceId"`
	// Whether the database is managed or not.
	Managed pulumi.BoolOutput `pulumi:"managed"`
	// Name of the database (e.g. `my-new-database`).
	Name pulumi.StringOutput `pulumi:"name"`
	// The name of the owner of the database.
	Owner pulumi.StringOutput `pulumi:"owner"`
	// The project_id you want to attach the resource to
	ProjectId pulumi.StringOutput `pulumi:"projectId"`
	// `region`) The region in which the resource exists.
	Region pulumi.StringOutput `pulumi:"region"`
	// Size in gigabytes of the database.
	Size pulumi.StringOutput `pulumi:"size"`
}

Creates and manages Scaleway DocumentDB database. For more information, see [the documentation](https://www.scaleway.com/en/developers/api/document_db).

## Example Usage

### Basic

<!--Start PulumiCodeChooser --> ```go package main

import (

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/raeumlich/pulumi-scaleway/sdk/go/scaleway/documentdb"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := documentdb.NewDatabase(ctx, "main", &documentdb.DatabaseArgs{
			InstanceId: pulumi.String("11111111-1111-1111-1111-111111111111"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

DocumentDB Database can be imported using the `{region}/{id}/{DBNAME}`, e.g.

bash

```sh $ pulumi import scaleway:documentdb/database:Database mydb fr-par/11111111-1111-1111-1111-111111111111/mydb ```

func GetDatabase

func GetDatabase(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DatabaseState, opts ...pulumi.ResourceOption) (*Database, error)

GetDatabase gets an existing Database 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 NewDatabase

func NewDatabase(ctx *pulumi.Context,
	name string, args *DatabaseArgs, opts ...pulumi.ResourceOption) (*Database, error)

NewDatabase registers a new resource with the given unique name, arguments, and options.

func (*Database) ElementType

func (*Database) ElementType() reflect.Type

func (*Database) ToDatabaseOutput

func (i *Database) ToDatabaseOutput() DatabaseOutput

func (*Database) ToDatabaseOutputWithContext

func (i *Database) ToDatabaseOutputWithContext(ctx context.Context) DatabaseOutput

type DatabaseArgs

type DatabaseArgs struct {
	// UUID of the documentdb instance.
	//
	// > **Important:** Updates to `instanceId` will recreate the Database.
	InstanceId pulumi.StringInput
	// Name of the database (e.g. `my-new-database`).
	Name pulumi.StringPtrInput
	// The project_id you want to attach the resource to
	ProjectId pulumi.StringPtrInput
	// `region`) The region in which the resource exists.
	Region pulumi.StringPtrInput
}

The set of arguments for constructing a Database resource.

func (DatabaseArgs) ElementType

func (DatabaseArgs) ElementType() reflect.Type

type DatabaseArray

type DatabaseArray []DatabaseInput

func (DatabaseArray) ElementType

func (DatabaseArray) ElementType() reflect.Type

func (DatabaseArray) ToDatabaseArrayOutput

func (i DatabaseArray) ToDatabaseArrayOutput() DatabaseArrayOutput

func (DatabaseArray) ToDatabaseArrayOutputWithContext

func (i DatabaseArray) ToDatabaseArrayOutputWithContext(ctx context.Context) DatabaseArrayOutput

type DatabaseArrayInput

type DatabaseArrayInput interface {
	pulumi.Input

	ToDatabaseArrayOutput() DatabaseArrayOutput
	ToDatabaseArrayOutputWithContext(context.Context) DatabaseArrayOutput
}

DatabaseArrayInput is an input type that accepts DatabaseArray and DatabaseArrayOutput values. You can construct a concrete instance of `DatabaseArrayInput` via:

DatabaseArray{ DatabaseArgs{...} }

type DatabaseArrayOutput

type DatabaseArrayOutput struct{ *pulumi.OutputState }

func (DatabaseArrayOutput) ElementType

func (DatabaseArrayOutput) ElementType() reflect.Type

func (DatabaseArrayOutput) Index

func (DatabaseArrayOutput) ToDatabaseArrayOutput

func (o DatabaseArrayOutput) ToDatabaseArrayOutput() DatabaseArrayOutput

func (DatabaseArrayOutput) ToDatabaseArrayOutputWithContext

func (o DatabaseArrayOutput) ToDatabaseArrayOutputWithContext(ctx context.Context) DatabaseArrayOutput

type DatabaseInput

type DatabaseInput interface {
	pulumi.Input

	ToDatabaseOutput() DatabaseOutput
	ToDatabaseOutputWithContext(ctx context.Context) DatabaseOutput
}

type DatabaseMap

type DatabaseMap map[string]DatabaseInput

func (DatabaseMap) ElementType

func (DatabaseMap) ElementType() reflect.Type

func (DatabaseMap) ToDatabaseMapOutput

func (i DatabaseMap) ToDatabaseMapOutput() DatabaseMapOutput

func (DatabaseMap) ToDatabaseMapOutputWithContext

func (i DatabaseMap) ToDatabaseMapOutputWithContext(ctx context.Context) DatabaseMapOutput

type DatabaseMapInput

type DatabaseMapInput interface {
	pulumi.Input

	ToDatabaseMapOutput() DatabaseMapOutput
	ToDatabaseMapOutputWithContext(context.Context) DatabaseMapOutput
}

DatabaseMapInput is an input type that accepts DatabaseMap and DatabaseMapOutput values. You can construct a concrete instance of `DatabaseMapInput` via:

DatabaseMap{ "key": DatabaseArgs{...} }

type DatabaseMapOutput

type DatabaseMapOutput struct{ *pulumi.OutputState }

func (DatabaseMapOutput) ElementType

func (DatabaseMapOutput) ElementType() reflect.Type

func (DatabaseMapOutput) MapIndex

func (DatabaseMapOutput) ToDatabaseMapOutput

func (o DatabaseMapOutput) ToDatabaseMapOutput() DatabaseMapOutput

func (DatabaseMapOutput) ToDatabaseMapOutputWithContext

func (o DatabaseMapOutput) ToDatabaseMapOutputWithContext(ctx context.Context) DatabaseMapOutput

type DatabaseOutput

type DatabaseOutput struct{ *pulumi.OutputState }

func (DatabaseOutput) ElementType

func (DatabaseOutput) ElementType() reflect.Type

func (DatabaseOutput) InstanceId

func (o DatabaseOutput) InstanceId() pulumi.StringOutput

UUID of the documentdb instance.

> **Important:** Updates to `instanceId` will recreate the Database.

func (DatabaseOutput) Managed

func (o DatabaseOutput) Managed() pulumi.BoolOutput

Whether the database is managed or not.

func (DatabaseOutput) Name

Name of the database (e.g. `my-new-database`).

func (DatabaseOutput) Owner

The name of the owner of the database.

func (DatabaseOutput) ProjectId

func (o DatabaseOutput) ProjectId() pulumi.StringOutput

The project_id you want to attach the resource to

func (DatabaseOutput) Region

func (o DatabaseOutput) Region() pulumi.StringOutput

`region`) The region in which the resource exists.

func (DatabaseOutput) Size

Size in gigabytes of the database.

func (DatabaseOutput) ToDatabaseOutput

func (o DatabaseOutput) ToDatabaseOutput() DatabaseOutput

func (DatabaseOutput) ToDatabaseOutputWithContext

func (o DatabaseOutput) ToDatabaseOutputWithContext(ctx context.Context) DatabaseOutput

type DatabaseState

type DatabaseState struct {
	// UUID of the documentdb instance.
	//
	// > **Important:** Updates to `instanceId` will recreate the Database.
	InstanceId pulumi.StringPtrInput
	// Whether the database is managed or not.
	Managed pulumi.BoolPtrInput
	// Name of the database (e.g. `my-new-database`).
	Name pulumi.StringPtrInput
	// The name of the owner of the database.
	Owner pulumi.StringPtrInput
	// The project_id you want to attach the resource to
	ProjectId pulumi.StringPtrInput
	// `region`) The region in which the resource exists.
	Region pulumi.StringPtrInput
	// Size in gigabytes of the database.
	Size pulumi.StringPtrInput
}

func (DatabaseState) ElementType

func (DatabaseState) ElementType() reflect.Type

type GetLoadBalancerEndpointArgs

type GetLoadBalancerEndpointArgs struct {
	// The DocumentDB Instance on which the endpoint is attached. Only one of `instanceName` and `instanceId` should be specified.
	InstanceId *string `pulumi:"instanceId"`
	// The DocumentDB Instance Name on which the endpoint is attached. Only one of `instanceName` and `instanceId` should be specified.
	InstanceName *string `pulumi:"instanceName"`
	// The ID of the project the DocumentDB endpoint is associated with.
	ProjectId *string `pulumi:"projectId"`
	// `region`) The region in which the DocumentDB endpoint exists.
	Region *string `pulumi:"region"`
}

A collection of arguments for invoking getLoadBalancerEndpoint.

type GetLoadBalancerEndpointOutputArgs

type GetLoadBalancerEndpointOutputArgs struct {
	// The DocumentDB Instance on which the endpoint is attached. Only one of `instanceName` and `instanceId` should be specified.
	InstanceId pulumi.StringPtrInput `pulumi:"instanceId"`
	// The DocumentDB Instance Name on which the endpoint is attached. Only one of `instanceName` and `instanceId` should be specified.
	InstanceName pulumi.StringPtrInput `pulumi:"instanceName"`
	// The ID of the project the DocumentDB endpoint is associated with.
	ProjectId pulumi.StringPtrInput `pulumi:"projectId"`
	// `region`) The region in which the DocumentDB endpoint exists.
	Region pulumi.StringPtrInput `pulumi:"region"`
}

A collection of arguments for invoking getLoadBalancerEndpoint.

func (GetLoadBalancerEndpointOutputArgs) ElementType

type GetLoadBalancerEndpointResult

type GetLoadBalancerEndpointResult struct {
	// The hostname of your endpoint.
	Hostname string `pulumi:"hostname"`
	// The provider-assigned unique ID for this managed resource.
	Id           string `pulumi:"id"`
	InstanceId   string `pulumi:"instanceId"`
	InstanceName string `pulumi:"instanceName"`
	// The IP of your load balancer service.
	Ip string `pulumi:"ip"`
	// The name of your load balancer service.
	Name string `pulumi:"name"`
	// The port of your load balancer service.
	Port      int    `pulumi:"port"`
	ProjectId string `pulumi:"projectId"`
	Region    string `pulumi:"region"`
}

A collection of values returned by getLoadBalancerEndpoint.

func GetLoadBalancerEndpoint

func GetLoadBalancerEndpoint(ctx *pulumi.Context, args *GetLoadBalancerEndpointArgs, opts ...pulumi.InvokeOption) (*GetLoadBalancerEndpointResult, error)

Gets information about an DocumentDB load balancer endpoint.

## Example Usage

<!--Start PulumiCodeChooser --> ```go package main

import (

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/raeumlich/pulumi-scaleway/sdk/go/scaleway/documentdb"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := documentdb.GetLoadBalancerEndpoint(ctx, &documentdb.GetLoadBalancerEndpointArgs{
			InstanceId: pulumi.StringRef("11111111-1111-1111-1111-111111111111"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

type GetLoadBalancerEndpointResultOutput

type GetLoadBalancerEndpointResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getLoadBalancerEndpoint.

func (GetLoadBalancerEndpointResultOutput) ElementType

func (GetLoadBalancerEndpointResultOutput) Hostname

The hostname of your endpoint.

func (GetLoadBalancerEndpointResultOutput) Id

The provider-assigned unique ID for this managed resource.

func (GetLoadBalancerEndpointResultOutput) InstanceId

func (GetLoadBalancerEndpointResultOutput) InstanceName

func (GetLoadBalancerEndpointResultOutput) Ip

The IP of your load balancer service.

func (GetLoadBalancerEndpointResultOutput) Name

The name of your load balancer service.

func (GetLoadBalancerEndpointResultOutput) Port

The port of your load balancer service.

func (GetLoadBalancerEndpointResultOutput) ProjectId

func (GetLoadBalancerEndpointResultOutput) Region

func (GetLoadBalancerEndpointResultOutput) ToGetLoadBalancerEndpointResultOutput

func (o GetLoadBalancerEndpointResultOutput) ToGetLoadBalancerEndpointResultOutput() GetLoadBalancerEndpointResultOutput

func (GetLoadBalancerEndpointResultOutput) ToGetLoadBalancerEndpointResultOutputWithContext

func (o GetLoadBalancerEndpointResultOutput) ToGetLoadBalancerEndpointResultOutputWithContext(ctx context.Context) GetLoadBalancerEndpointResultOutput

type Instance

type Instance 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"`
}

Creates and manages Scaleway Database Instances. For more information, see [the documentation](https://www.scaleway.com/en/developers/api/document_db/).

## Example Usage

### Example Basic

<!--Start PulumiCodeChooser --> ```go package main

import (

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/raeumlich/pulumi-scaleway/sdk/go/scaleway/documentdb"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := documentdb.NewInstance(ctx, "main", &documentdb.InstanceArgs{
			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
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Database Instance can be imported using the `{region}/{id}`, e.g.

bash

```sh $ pulumi import scaleway:documentdb/instance:Instance db fr-par/11111111-1111-1111-1111-111111111111 ```

func GetInstance

func GetInstance(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *InstanceState, opts ...pulumi.ResourceOption) (*Instance, error)

GetInstance gets an existing Instance 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 NewInstance

func NewInstance(ctx *pulumi.Context,
	name string, args *InstanceArgs, opts ...pulumi.ResourceOption) (*Instance, error)

NewInstance registers a new resource with the given unique name, arguments, and options.

func (*Instance) ElementType

func (*Instance) ElementType() reflect.Type

func (*Instance) ToInstanceOutput

func (i *Instance) ToInstanceOutput() InstanceOutput

func (*Instance) ToInstanceOutputWithContext

func (i *Instance) ToInstanceOutputWithContext(ctx context.Context) InstanceOutput

type InstanceArgs

type InstanceArgs 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
}

The set of arguments for constructing a Instance resource.

func (InstanceArgs) ElementType

func (InstanceArgs) ElementType() reflect.Type

type InstanceArray

type InstanceArray []InstanceInput

func (InstanceArray) ElementType

func (InstanceArray) ElementType() reflect.Type

func (InstanceArray) ToInstanceArrayOutput

func (i InstanceArray) ToInstanceArrayOutput() InstanceArrayOutput

func (InstanceArray) ToInstanceArrayOutputWithContext

func (i InstanceArray) ToInstanceArrayOutputWithContext(ctx context.Context) InstanceArrayOutput

type InstanceArrayInput

type InstanceArrayInput interface {
	pulumi.Input

	ToInstanceArrayOutput() InstanceArrayOutput
	ToInstanceArrayOutputWithContext(context.Context) InstanceArrayOutput
}

InstanceArrayInput is an input type that accepts InstanceArray and InstanceArrayOutput values. You can construct a concrete instance of `InstanceArrayInput` via:

InstanceArray{ InstanceArgs{...} }

type InstanceArrayOutput

type InstanceArrayOutput struct{ *pulumi.OutputState }

func (InstanceArrayOutput) ElementType

func (InstanceArrayOutput) ElementType() reflect.Type

func (InstanceArrayOutput) Index

func (InstanceArrayOutput) ToInstanceArrayOutput

func (o InstanceArrayOutput) ToInstanceArrayOutput() InstanceArrayOutput

func (InstanceArrayOutput) ToInstanceArrayOutputWithContext

func (o InstanceArrayOutput) ToInstanceArrayOutputWithContext(ctx context.Context) InstanceArrayOutput

type InstanceInput

type InstanceInput interface {
	pulumi.Input

	ToInstanceOutput() InstanceOutput
	ToInstanceOutputWithContext(ctx context.Context) InstanceOutput
}

type InstanceMap

type InstanceMap map[string]InstanceInput

func (InstanceMap) ElementType

func (InstanceMap) ElementType() reflect.Type

func (InstanceMap) ToInstanceMapOutput

func (i InstanceMap) ToInstanceMapOutput() InstanceMapOutput

func (InstanceMap) ToInstanceMapOutputWithContext

func (i InstanceMap) ToInstanceMapOutputWithContext(ctx context.Context) InstanceMapOutput

type InstanceMapInput

type InstanceMapInput interface {
	pulumi.Input

	ToInstanceMapOutput() InstanceMapOutput
	ToInstanceMapOutputWithContext(context.Context) InstanceMapOutput
}

InstanceMapInput is an input type that accepts InstanceMap and InstanceMapOutput values. You can construct a concrete instance of `InstanceMapInput` via:

InstanceMap{ "key": InstanceArgs{...} }

type InstanceMapOutput

type InstanceMapOutput struct{ *pulumi.OutputState }

func (InstanceMapOutput) ElementType

func (InstanceMapOutput) ElementType() reflect.Type

func (InstanceMapOutput) MapIndex

func (InstanceMapOutput) ToInstanceMapOutput

func (o InstanceMapOutput) ToInstanceMapOutput() InstanceMapOutput

func (InstanceMapOutput) ToInstanceMapOutputWithContext

func (o InstanceMapOutput) ToInstanceMapOutputWithContext(ctx context.Context) InstanceMapOutput

type InstanceOutput

type InstanceOutput struct{ *pulumi.OutputState }

func (InstanceOutput) ElementType

func (InstanceOutput) ElementType() reflect.Type

func (InstanceOutput) Engine

func (o InstanceOutput) Engine() pulumi.StringOutput

Database Instance's engine version (e.g. `FerretDB-1`).

> **Important:** Updates to `engine` will recreate the Database Instance.

func (InstanceOutput) IsHaCluster

func (o InstanceOutput) IsHaCluster() pulumi.BoolPtrOutput

Enable or disable high availability for the database instance.

func (InstanceOutput) Name

The name of the Database Instance.

func (InstanceOutput) NodeType

func (o InstanceOutput) NodeType() 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 (InstanceOutput) Password

func (o InstanceOutput) Password() pulumi.StringPtrOutput

Password for the first user of the database instance.

func (InstanceOutput) ProjectId

func (o InstanceOutput) ProjectId() pulumi.StringOutput

`projectId`) The ID of the project the Database Instance is associated with.

func (InstanceOutput) Region

func (o InstanceOutput) Region() pulumi.StringOutput

`region`) The region in which the Database Instance should be created.

func (InstanceOutput) Tags

The tags associated with the Database Instance.

func (InstanceOutput) TelemetryEnabled

func (o InstanceOutput) TelemetryEnabled() pulumi.BoolPtrOutput

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 (InstanceOutput) ToInstanceOutput

func (o InstanceOutput) ToInstanceOutput() InstanceOutput

func (InstanceOutput) ToInstanceOutputWithContext

func (o InstanceOutput) ToInstanceOutputWithContext(ctx context.Context) InstanceOutput

func (InstanceOutput) UserName

func (o InstanceOutput) UserName() pulumi.StringPtrOutput

Identifier for the first user of the database instance.

> **Important:** Updates to `userName` will recreate the Database Instance.

func (InstanceOutput) VolumeSizeInGb

func (o InstanceOutput) VolumeSizeInGb() pulumi.IntOutput

Volume size (in GB) when `volumeType` is set to `bssd`.

func (InstanceOutput) VolumeType

func (o InstanceOutput) VolumeType() pulumi.StringPtrOutput

Type of volume where data are stored (`bssd` or `lssd`).

type InstanceState

type InstanceState 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 (InstanceState) ElementType

func (InstanceState) ElementType() reflect.Type

type LookupDatabaseArgs

type LookupDatabaseArgs struct {
	// The DocumentDB instance ID.
	InstanceId string `pulumi:"instanceId"`
	// The name of the DocumentDB instance.
	Name   *string `pulumi:"name"`
	Region *string `pulumi:"region"`
}

A collection of arguments for invoking getDatabase.

type LookupDatabaseOutputArgs

type LookupDatabaseOutputArgs struct {
	// The DocumentDB instance ID.
	InstanceId pulumi.StringInput `pulumi:"instanceId"`
	// The name of the DocumentDB instance.
	Name   pulumi.StringPtrInput `pulumi:"name"`
	Region pulumi.StringPtrInput `pulumi:"region"`
}

A collection of arguments for invoking getDatabase.

func (LookupDatabaseOutputArgs) ElementType

func (LookupDatabaseOutputArgs) ElementType() reflect.Type

type LookupDatabaseResult

type LookupDatabaseResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id         string `pulumi:"id"`
	InstanceId string `pulumi:"instanceId"`
	// Whether the database is managed or not.
	Managed bool    `pulumi:"managed"`
	Name    *string `pulumi:"name"`
	// The name of the owner of the database.
	Owner     string  `pulumi:"owner"`
	ProjectId string  `pulumi:"projectId"`
	Region    *string `pulumi:"region"`
	// Size of the database (in bytes).
	Size string `pulumi:"size"`
}

A collection of values returned by getDatabase.

func LookupDatabase

func LookupDatabase(ctx *pulumi.Context, args *LookupDatabaseArgs, opts ...pulumi.InvokeOption) (*LookupDatabaseResult, error)

Gets information about DocumentDB database. More on our official [site](https://www.scaleway.com/en/developers/api/document_db/)

## Example Usage

<!--Start PulumiCodeChooser --> ```go package main

import (

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/raeumlich/pulumi-scaleway/sdk/go/scaleway/documentdb"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := documentdb.LookupDatabase(ctx, &documentdb.LookupDatabaseArgs{
			InstanceId: "11111111-1111-1111-1111-111111111111",
			Name:       pulumi.StringRef("foobar"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

type LookupDatabaseResultOutput

type LookupDatabaseResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getDatabase.

func (LookupDatabaseResultOutput) ElementType

func (LookupDatabaseResultOutput) ElementType() reflect.Type

func (LookupDatabaseResultOutput) Id

The provider-assigned unique ID for this managed resource.

func (LookupDatabaseResultOutput) InstanceId

func (LookupDatabaseResultOutput) Managed

Whether the database is managed or not.

func (LookupDatabaseResultOutput) Name

func (LookupDatabaseResultOutput) Owner

The name of the owner of the database.

func (LookupDatabaseResultOutput) ProjectId

func (LookupDatabaseResultOutput) Region

func (LookupDatabaseResultOutput) Size

Size of the database (in bytes).

func (LookupDatabaseResultOutput) ToLookupDatabaseResultOutput

func (o LookupDatabaseResultOutput) ToLookupDatabaseResultOutput() LookupDatabaseResultOutput

func (LookupDatabaseResultOutput) ToLookupDatabaseResultOutputWithContext

func (o LookupDatabaseResultOutput) ToLookupDatabaseResultOutputWithContext(ctx context.Context) LookupDatabaseResultOutput

type LookupInstanceArgs

type LookupInstanceArgs struct {
	// The DocumentDB instance ID.
	// Only one of `name` and `instanceId` should be specified.
	InstanceId *string `pulumi:"instanceId"`
	// The name of the DocumentDB instance.
	// Only one of `name` and `instanceId` should be specified.
	Name *string `pulumi:"name"`
	// The ID of the project the DocumentDB instance is associated with.
	ProjectId *string `pulumi:"projectId"`
	// `region`) The region in which the DocumentDB instance exists.
	Region *string `pulumi:"region"`
}

A collection of arguments for invoking getInstance.

type LookupInstanceOutputArgs

type LookupInstanceOutputArgs struct {
	// The DocumentDB instance ID.
	// Only one of `name` and `instanceId` should be specified.
	InstanceId pulumi.StringPtrInput `pulumi:"instanceId"`
	// The name of the DocumentDB instance.
	// Only one of `name` and `instanceId` should be specified.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// The ID of the project the DocumentDB instance is associated with.
	ProjectId pulumi.StringPtrInput `pulumi:"projectId"`
	// `region`) The region in which the DocumentDB instance exists.
	Region pulumi.StringPtrInput `pulumi:"region"`
}

A collection of arguments for invoking getInstance.

func (LookupInstanceOutputArgs) ElementType

func (LookupInstanceOutputArgs) ElementType() reflect.Type

type LookupInstanceResult

type LookupInstanceResult struct {
	Engine string `pulumi:"engine"`
	// The provider-assigned unique ID for this managed resource.
	Id               string   `pulumi:"id"`
	InstanceId       *string  `pulumi:"instanceId"`
	IsHaCluster      bool     `pulumi:"isHaCluster"`
	Name             *string  `pulumi:"name"`
	NodeType         string   `pulumi:"nodeType"`
	Password         string   `pulumi:"password"`
	ProjectId        *string  `pulumi:"projectId"`
	Region           *string  `pulumi:"region"`
	Tags             []string `pulumi:"tags"`
	TelemetryEnabled bool     `pulumi:"telemetryEnabled"`
	UserName         string   `pulumi:"userName"`
	VolumeSizeInGb   int      `pulumi:"volumeSizeInGb"`
	VolumeType       string   `pulumi:"volumeType"`
}

A collection of values returned by getInstance.

func LookupInstance

func LookupInstance(ctx *pulumi.Context, args *LookupInstanceArgs, opts ...pulumi.InvokeOption) (*LookupInstanceResult, error)

Gets information about an DocumentDB instance. For further information see our [developers website](https://www.scaleway.com/en/developers/api/document_db/)

## Example Usage

<!--Start PulumiCodeChooser --> ```go package main

import (

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/raeumlich/pulumi-scaleway/sdk/go/scaleway/documentdb"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := documentdb.LookupInstance(ctx, &documentdb.LookupInstanceArgs{
			InstanceId: pulumi.StringRef("11111111-1111-1111-1111-111111111111"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

type LookupInstanceResultOutput

type LookupInstanceResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getInstance.

func (LookupInstanceResultOutput) ElementType

func (LookupInstanceResultOutput) ElementType() reflect.Type

func (LookupInstanceResultOutput) Engine

func (LookupInstanceResultOutput) Id

The provider-assigned unique ID for this managed resource.

func (LookupInstanceResultOutput) InstanceId

func (LookupInstanceResultOutput) IsHaCluster

func (LookupInstanceResultOutput) Name

func (LookupInstanceResultOutput) NodeType

func (LookupInstanceResultOutput) Password

func (LookupInstanceResultOutput) ProjectId

func (LookupInstanceResultOutput) Region

func (LookupInstanceResultOutput) Tags

func (LookupInstanceResultOutput) TelemetryEnabled

func (o LookupInstanceResultOutput) TelemetryEnabled() pulumi.BoolOutput

func (LookupInstanceResultOutput) ToLookupInstanceResultOutput

func (o LookupInstanceResultOutput) ToLookupInstanceResultOutput() LookupInstanceResultOutput

func (LookupInstanceResultOutput) ToLookupInstanceResultOutputWithContext

func (o LookupInstanceResultOutput) ToLookupInstanceResultOutputWithContext(ctx context.Context) LookupInstanceResultOutput

func (LookupInstanceResultOutput) UserName

func (LookupInstanceResultOutput) VolumeSizeInGb

func (o LookupInstanceResultOutput) VolumeSizeInGb() pulumi.IntOutput

func (LookupInstanceResultOutput) VolumeType

type PrivateNetworkEndpoint

type PrivateNetworkEndpoint struct {
	pulumi.CustomResourceState

	// Hostname of the endpoint.
	Hostname pulumi.StringOutput `pulumi:"hostname"`
	// UUID of the documentdb instance.
	InstanceId pulumi.StringOutput `pulumi:"instanceId"`
	// IPv4 address on the network.
	Ip pulumi.StringOutput `pulumi:"ip"`
	// The IP network address within the private subnet. This must be an IPv4 address with a
	// CIDR notation. The IP network address within the private subnet is determined by the IP Address Management (IPAM)
	// service if not set.
	IpNet pulumi.StringOutput `pulumi:"ipNet"`
	// Name of the endpoint.
	Name pulumi.StringOutput `pulumi:"name"`
	// Port in the Private Network.
	Port pulumi.IntOutput `pulumi:"port"`
	// The ID of the private network.
	PrivateNetworkId pulumi.StringOutput `pulumi:"privateNetworkId"`
	// The region you want to attach the resource to
	Region pulumi.StringOutput `pulumi:"region"`
	// The zone you want to attach the resource to
	Zone pulumi.StringOutput `pulumi:"zone"`
}

Creates and manages Scaleway Database Private Network Endpoint. For more information, see [the documentation](https://www.scaleway.com/en/developers/api/document_db/).

## Example Usage

## Import

Database Instance Endpoint can be imported using the `{region}/{endpoint_id}`, e.g.

bash

```sh $ pulumi import scaleway:documentdb/privateNetworkEndpoint:PrivateNetworkEndpoint end fr-par/11111111-1111-1111-1111-111111111111 ```

func GetPrivateNetworkEndpoint

func GetPrivateNetworkEndpoint(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *PrivateNetworkEndpointState, opts ...pulumi.ResourceOption) (*PrivateNetworkEndpoint, error)

GetPrivateNetworkEndpoint gets an existing PrivateNetworkEndpoint 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 NewPrivateNetworkEndpoint

func NewPrivateNetworkEndpoint(ctx *pulumi.Context,
	name string, args *PrivateNetworkEndpointArgs, opts ...pulumi.ResourceOption) (*PrivateNetworkEndpoint, error)

NewPrivateNetworkEndpoint registers a new resource with the given unique name, arguments, and options.

func (*PrivateNetworkEndpoint) ElementType

func (*PrivateNetworkEndpoint) ElementType() reflect.Type

func (*PrivateNetworkEndpoint) ToPrivateNetworkEndpointOutput

func (i *PrivateNetworkEndpoint) ToPrivateNetworkEndpointOutput() PrivateNetworkEndpointOutput

func (*PrivateNetworkEndpoint) ToPrivateNetworkEndpointOutputWithContext

func (i *PrivateNetworkEndpoint) ToPrivateNetworkEndpointOutputWithContext(ctx context.Context) PrivateNetworkEndpointOutput

type PrivateNetworkEndpointArgs

type PrivateNetworkEndpointArgs struct {
	// UUID of the documentdb instance.
	InstanceId pulumi.StringInput
	// The IP network address within the private subnet. This must be an IPv4 address with a
	// CIDR notation. The IP network address within the private subnet is determined by the IP Address Management (IPAM)
	// service if not set.
	IpNet pulumi.StringPtrInput
	// Port in the Private Network.
	Port pulumi.IntPtrInput
	// The ID of the private network.
	PrivateNetworkId pulumi.StringInput
	// The region you want to attach the resource to
	Region pulumi.StringPtrInput
	// The zone you want to attach the resource to
	Zone pulumi.StringPtrInput
}

The set of arguments for constructing a PrivateNetworkEndpoint resource.

func (PrivateNetworkEndpointArgs) ElementType

func (PrivateNetworkEndpointArgs) ElementType() reflect.Type

type PrivateNetworkEndpointArray

type PrivateNetworkEndpointArray []PrivateNetworkEndpointInput

func (PrivateNetworkEndpointArray) ElementType

func (PrivateNetworkEndpointArray) ToPrivateNetworkEndpointArrayOutput

func (i PrivateNetworkEndpointArray) ToPrivateNetworkEndpointArrayOutput() PrivateNetworkEndpointArrayOutput

func (PrivateNetworkEndpointArray) ToPrivateNetworkEndpointArrayOutputWithContext

func (i PrivateNetworkEndpointArray) ToPrivateNetworkEndpointArrayOutputWithContext(ctx context.Context) PrivateNetworkEndpointArrayOutput

type PrivateNetworkEndpointArrayInput

type PrivateNetworkEndpointArrayInput interface {
	pulumi.Input

	ToPrivateNetworkEndpointArrayOutput() PrivateNetworkEndpointArrayOutput
	ToPrivateNetworkEndpointArrayOutputWithContext(context.Context) PrivateNetworkEndpointArrayOutput
}

PrivateNetworkEndpointArrayInput is an input type that accepts PrivateNetworkEndpointArray and PrivateNetworkEndpointArrayOutput values. You can construct a concrete instance of `PrivateNetworkEndpointArrayInput` via:

PrivateNetworkEndpointArray{ PrivateNetworkEndpointArgs{...} }

type PrivateNetworkEndpointArrayOutput

type PrivateNetworkEndpointArrayOutput struct{ *pulumi.OutputState }

func (PrivateNetworkEndpointArrayOutput) ElementType

func (PrivateNetworkEndpointArrayOutput) Index

func (PrivateNetworkEndpointArrayOutput) ToPrivateNetworkEndpointArrayOutput

func (o PrivateNetworkEndpointArrayOutput) ToPrivateNetworkEndpointArrayOutput() PrivateNetworkEndpointArrayOutput

func (PrivateNetworkEndpointArrayOutput) ToPrivateNetworkEndpointArrayOutputWithContext

func (o PrivateNetworkEndpointArrayOutput) ToPrivateNetworkEndpointArrayOutputWithContext(ctx context.Context) PrivateNetworkEndpointArrayOutput

type PrivateNetworkEndpointInput

type PrivateNetworkEndpointInput interface {
	pulumi.Input

	ToPrivateNetworkEndpointOutput() PrivateNetworkEndpointOutput
	ToPrivateNetworkEndpointOutputWithContext(ctx context.Context) PrivateNetworkEndpointOutput
}

type PrivateNetworkEndpointMap

type PrivateNetworkEndpointMap map[string]PrivateNetworkEndpointInput

func (PrivateNetworkEndpointMap) ElementType

func (PrivateNetworkEndpointMap) ElementType() reflect.Type

func (PrivateNetworkEndpointMap) ToPrivateNetworkEndpointMapOutput

func (i PrivateNetworkEndpointMap) ToPrivateNetworkEndpointMapOutput() PrivateNetworkEndpointMapOutput

func (PrivateNetworkEndpointMap) ToPrivateNetworkEndpointMapOutputWithContext

func (i PrivateNetworkEndpointMap) ToPrivateNetworkEndpointMapOutputWithContext(ctx context.Context) PrivateNetworkEndpointMapOutput

type PrivateNetworkEndpointMapInput

type PrivateNetworkEndpointMapInput interface {
	pulumi.Input

	ToPrivateNetworkEndpointMapOutput() PrivateNetworkEndpointMapOutput
	ToPrivateNetworkEndpointMapOutputWithContext(context.Context) PrivateNetworkEndpointMapOutput
}

PrivateNetworkEndpointMapInput is an input type that accepts PrivateNetworkEndpointMap and PrivateNetworkEndpointMapOutput values. You can construct a concrete instance of `PrivateNetworkEndpointMapInput` via:

PrivateNetworkEndpointMap{ "key": PrivateNetworkEndpointArgs{...} }

type PrivateNetworkEndpointMapOutput

type PrivateNetworkEndpointMapOutput struct{ *pulumi.OutputState }

func (PrivateNetworkEndpointMapOutput) ElementType

func (PrivateNetworkEndpointMapOutput) MapIndex

func (PrivateNetworkEndpointMapOutput) ToPrivateNetworkEndpointMapOutput

func (o PrivateNetworkEndpointMapOutput) ToPrivateNetworkEndpointMapOutput() PrivateNetworkEndpointMapOutput

func (PrivateNetworkEndpointMapOutput) ToPrivateNetworkEndpointMapOutputWithContext

func (o PrivateNetworkEndpointMapOutput) ToPrivateNetworkEndpointMapOutputWithContext(ctx context.Context) PrivateNetworkEndpointMapOutput

type PrivateNetworkEndpointOutput

type PrivateNetworkEndpointOutput struct{ *pulumi.OutputState }

func (PrivateNetworkEndpointOutput) ElementType

func (PrivateNetworkEndpointOutput) Hostname

Hostname of the endpoint.

func (PrivateNetworkEndpointOutput) InstanceId

UUID of the documentdb instance.

func (PrivateNetworkEndpointOutput) Ip

IPv4 address on the network.

func (PrivateNetworkEndpointOutput) IpNet

The IP network address within the private subnet. This must be an IPv4 address with a CIDR notation. The IP network address within the private subnet is determined by the IP Address Management (IPAM) service if not set.

func (PrivateNetworkEndpointOutput) Name

Name of the endpoint.

func (PrivateNetworkEndpointOutput) Port

Port in the Private Network.

func (PrivateNetworkEndpointOutput) PrivateNetworkId

func (o PrivateNetworkEndpointOutput) PrivateNetworkId() pulumi.StringOutput

The ID of the private network.

func (PrivateNetworkEndpointOutput) Region

The region you want to attach the resource to

func (PrivateNetworkEndpointOutput) ToPrivateNetworkEndpointOutput

func (o PrivateNetworkEndpointOutput) ToPrivateNetworkEndpointOutput() PrivateNetworkEndpointOutput

func (PrivateNetworkEndpointOutput) ToPrivateNetworkEndpointOutputWithContext

func (o PrivateNetworkEndpointOutput) ToPrivateNetworkEndpointOutputWithContext(ctx context.Context) PrivateNetworkEndpointOutput

func (PrivateNetworkEndpointOutput) Zone

The zone you want to attach the resource to

type PrivateNetworkEndpointState

type PrivateNetworkEndpointState struct {
	// Hostname of the endpoint.
	Hostname pulumi.StringPtrInput
	// UUID of the documentdb instance.
	InstanceId pulumi.StringPtrInput
	// IPv4 address on the network.
	Ip pulumi.StringPtrInput
	// The IP network address within the private subnet. This must be an IPv4 address with a
	// CIDR notation. The IP network address within the private subnet is determined by the IP Address Management (IPAM)
	// service if not set.
	IpNet pulumi.StringPtrInput
	// Name of the endpoint.
	Name pulumi.StringPtrInput
	// Port in the Private Network.
	Port pulumi.IntPtrInput
	// The ID of the private network.
	PrivateNetworkId pulumi.StringPtrInput
	// The region you want to attach the resource to
	Region pulumi.StringPtrInput
	// The zone you want to attach the resource to
	Zone pulumi.StringPtrInput
}

func (PrivateNetworkEndpointState) ElementType

type Privilege

type Privilege struct {
	pulumi.CustomResourceState

	// Name of the database (e.g. `my-db-name`).
	DatabaseName pulumi.StringOutput `pulumi:"databaseName"`
	// UUID of the rdb instance.
	InstanceId pulumi.StringOutput `pulumi:"instanceId"`
	// Permission to set. Valid values are `readonly`, `readwrite`, `all`, `custom` and `none`.
	Permission pulumi.StringOutput `pulumi:"permission"`
	// `region`) The region in which the resource exists.
	Region pulumi.StringOutput `pulumi:"region"`
	// Name of the user (e.g. `my-db-user`).
	UserName pulumi.StringOutput `pulumi:"userName"`
}

Create and manage Scaleway DocumentDB database privilege. For more information, see [the documentation](https://www.scaleway.com/en/developers/api/document_db/).

## Example Usage

<!--Start PulumiCodeChooser --> ```go package main

import (

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/raeumlich/pulumi-scaleway/sdk/go/scaleway/documentdb"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := documentdb.NewPrivilege(ctx, "main", &documentdb.PrivilegeArgs{
			DatabaseName: pulumi.String("my-db-name"),
			InstanceId:   pulumi.String("11111111-1111-1111-1111-111111111111"),
			Permission:   pulumi.String("all"),
			UserName:     pulumi.String("my-db-user"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

The user privileges can be imported using the `{region}/{instance_id}/{database_name}/{user_name}`, e.g.

bash

```sh $ pulumi import scaleway:documentdb/privilege:Privilege o fr-par/11111111-1111-1111-1111-111111111111/database_name/foo ```

func GetPrivilege

func GetPrivilege(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *PrivilegeState, opts ...pulumi.ResourceOption) (*Privilege, error)

GetPrivilege gets an existing Privilege 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 NewPrivilege

func NewPrivilege(ctx *pulumi.Context,
	name string, args *PrivilegeArgs, opts ...pulumi.ResourceOption) (*Privilege, error)

NewPrivilege registers a new resource with the given unique name, arguments, and options.

func (*Privilege) ElementType

func (*Privilege) ElementType() reflect.Type

func (*Privilege) ToPrivilegeOutput

func (i *Privilege) ToPrivilegeOutput() PrivilegeOutput

func (*Privilege) ToPrivilegeOutputWithContext

func (i *Privilege) ToPrivilegeOutputWithContext(ctx context.Context) PrivilegeOutput

type PrivilegeArgs

type PrivilegeArgs struct {
	// Name of the database (e.g. `my-db-name`).
	DatabaseName pulumi.StringInput
	// UUID of the rdb instance.
	InstanceId pulumi.StringInput
	// Permission to set. Valid values are `readonly`, `readwrite`, `all`, `custom` and `none`.
	Permission pulumi.StringInput
	// `region`) The region in which the resource exists.
	Region pulumi.StringPtrInput
	// Name of the user (e.g. `my-db-user`).
	UserName pulumi.StringInput
}

The set of arguments for constructing a Privilege resource.

func (PrivilegeArgs) ElementType

func (PrivilegeArgs) ElementType() reflect.Type

type PrivilegeArray

type PrivilegeArray []PrivilegeInput

func (PrivilegeArray) ElementType

func (PrivilegeArray) ElementType() reflect.Type

func (PrivilegeArray) ToPrivilegeArrayOutput

func (i PrivilegeArray) ToPrivilegeArrayOutput() PrivilegeArrayOutput

func (PrivilegeArray) ToPrivilegeArrayOutputWithContext

func (i PrivilegeArray) ToPrivilegeArrayOutputWithContext(ctx context.Context) PrivilegeArrayOutput

type PrivilegeArrayInput

type PrivilegeArrayInput interface {
	pulumi.Input

	ToPrivilegeArrayOutput() PrivilegeArrayOutput
	ToPrivilegeArrayOutputWithContext(context.Context) PrivilegeArrayOutput
}

PrivilegeArrayInput is an input type that accepts PrivilegeArray and PrivilegeArrayOutput values. You can construct a concrete instance of `PrivilegeArrayInput` via:

PrivilegeArray{ PrivilegeArgs{...} }

type PrivilegeArrayOutput

type PrivilegeArrayOutput struct{ *pulumi.OutputState }

func (PrivilegeArrayOutput) ElementType

func (PrivilegeArrayOutput) ElementType() reflect.Type

func (PrivilegeArrayOutput) Index

func (PrivilegeArrayOutput) ToPrivilegeArrayOutput

func (o PrivilegeArrayOutput) ToPrivilegeArrayOutput() PrivilegeArrayOutput

func (PrivilegeArrayOutput) ToPrivilegeArrayOutputWithContext

func (o PrivilegeArrayOutput) ToPrivilegeArrayOutputWithContext(ctx context.Context) PrivilegeArrayOutput

type PrivilegeInput

type PrivilegeInput interface {
	pulumi.Input

	ToPrivilegeOutput() PrivilegeOutput
	ToPrivilegeOutputWithContext(ctx context.Context) PrivilegeOutput
}

type PrivilegeMap

type PrivilegeMap map[string]PrivilegeInput

func (PrivilegeMap) ElementType

func (PrivilegeMap) ElementType() reflect.Type

func (PrivilegeMap) ToPrivilegeMapOutput

func (i PrivilegeMap) ToPrivilegeMapOutput() PrivilegeMapOutput

func (PrivilegeMap) ToPrivilegeMapOutputWithContext

func (i PrivilegeMap) ToPrivilegeMapOutputWithContext(ctx context.Context) PrivilegeMapOutput

type PrivilegeMapInput

type PrivilegeMapInput interface {
	pulumi.Input

	ToPrivilegeMapOutput() PrivilegeMapOutput
	ToPrivilegeMapOutputWithContext(context.Context) PrivilegeMapOutput
}

PrivilegeMapInput is an input type that accepts PrivilegeMap and PrivilegeMapOutput values. You can construct a concrete instance of `PrivilegeMapInput` via:

PrivilegeMap{ "key": PrivilegeArgs{...} }

type PrivilegeMapOutput

type PrivilegeMapOutput struct{ *pulumi.OutputState }

func (PrivilegeMapOutput) ElementType

func (PrivilegeMapOutput) ElementType() reflect.Type

func (PrivilegeMapOutput) MapIndex

func (PrivilegeMapOutput) ToPrivilegeMapOutput

func (o PrivilegeMapOutput) ToPrivilegeMapOutput() PrivilegeMapOutput

func (PrivilegeMapOutput) ToPrivilegeMapOutputWithContext

func (o PrivilegeMapOutput) ToPrivilegeMapOutputWithContext(ctx context.Context) PrivilegeMapOutput

type PrivilegeOutput

type PrivilegeOutput struct{ *pulumi.OutputState }

func (PrivilegeOutput) DatabaseName

func (o PrivilegeOutput) DatabaseName() pulumi.StringOutput

Name of the database (e.g. `my-db-name`).

func (PrivilegeOutput) ElementType

func (PrivilegeOutput) ElementType() reflect.Type

func (PrivilegeOutput) InstanceId

func (o PrivilegeOutput) InstanceId() pulumi.StringOutput

UUID of the rdb instance.

func (PrivilegeOutput) Permission

func (o PrivilegeOutput) Permission() pulumi.StringOutput

Permission to set. Valid values are `readonly`, `readwrite`, `all`, `custom` and `none`.

func (PrivilegeOutput) Region

func (o PrivilegeOutput) Region() pulumi.StringOutput

`region`) The region in which the resource exists.

func (PrivilegeOutput) ToPrivilegeOutput

func (o PrivilegeOutput) ToPrivilegeOutput() PrivilegeOutput

func (PrivilegeOutput) ToPrivilegeOutputWithContext

func (o PrivilegeOutput) ToPrivilegeOutputWithContext(ctx context.Context) PrivilegeOutput

func (PrivilegeOutput) UserName

func (o PrivilegeOutput) UserName() pulumi.StringOutput

Name of the user (e.g. `my-db-user`).

type PrivilegeState

type PrivilegeState struct {
	// Name of the database (e.g. `my-db-name`).
	DatabaseName pulumi.StringPtrInput
	// UUID of the rdb instance.
	InstanceId pulumi.StringPtrInput
	// Permission to set. Valid values are `readonly`, `readwrite`, `all`, `custom` and `none`.
	Permission pulumi.StringPtrInput
	// `region`) The region in which the resource exists.
	Region pulumi.StringPtrInput
	// Name of the user (e.g. `my-db-user`).
	UserName pulumi.StringPtrInput
}

func (PrivilegeState) ElementType

func (PrivilegeState) ElementType() reflect.Type

type ReadReplica

type ReadReplica struct {
	pulumi.CustomResourceState

	// Creates a direct access endpoint to documentdb replica.
	DirectAccess ReadReplicaDirectAccessPtrOutput `pulumi:"directAccess"`
	// UUID of the documentdb instance.
	//
	// > **Important:** The replica musts contains at least one of `directAccess` or `privateNetwork`. It can contain both.
	InstanceId pulumi.StringOutput `pulumi:"instanceId"`
	// Create an endpoint in a private network.
	PrivateNetwork ReadReplicaPrivateNetworkPtrOutput `pulumi:"privateNetwork"`
	// `region`) The region
	// in which the Database read replica should be created.
	Region pulumi.StringOutput `pulumi:"region"`
}

Creates and manages Scaleway DocumentDB Database read replicas. For more information, see [the documentation](https://www.scaleway.com/en/developers/api/document_db/).

## Example Usage

### Basic

<!--Start PulumiCodeChooser --> ```go package main

import (

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/raeumlich/pulumi-scaleway/sdk/go/scaleway/documentdb"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := documentdb.NewReadReplica(ctx, "replica", &documentdb.ReadReplicaArgs{
			DirectAccess: nil,
			InstanceId:   pulumi.String("11111111-1111-1111-1111-111111111111"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

### Private network

<!--Start PulumiCodeChooser --> ```go package main

import (

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/raeumlich/pulumi-scaleway/sdk/go/scaleway/documentdb"
"github.com/raeumlich/pulumi-scaleway/sdk/go/scaleway/vpc"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		pn, err := vpc.NewPrivateNetwork(ctx, "pn", nil)
		if err != nil {
			return err
		}
		_, err = documentdb.NewReadReplica(ctx, "replica", &documentdb.ReadReplicaArgs{
			InstanceId: pulumi.Any(scaleway_rdb_instance.Instance.Id),
			PrivateNetwork: &documentdb.ReadReplicaPrivateNetworkArgs{
				PrivateNetworkId: pn.ID(),
				ServiceIp:        pulumi.String("192.168.1.254/24"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Database Read replica can be imported using the `{region}/{id}`, e.g.

bash

```sh $ pulumi import scaleway:documentdb/readReplica:ReadReplica rr fr-par/11111111-1111-1111-1111-111111111111 ```

func GetReadReplica

func GetReadReplica(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ReadReplicaState, opts ...pulumi.ResourceOption) (*ReadReplica, error)

GetReadReplica gets an existing ReadReplica 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 NewReadReplica

func NewReadReplica(ctx *pulumi.Context,
	name string, args *ReadReplicaArgs, opts ...pulumi.ResourceOption) (*ReadReplica, error)

NewReadReplica registers a new resource with the given unique name, arguments, and options.

func (*ReadReplica) ElementType

func (*ReadReplica) ElementType() reflect.Type

func (*ReadReplica) ToReadReplicaOutput

func (i *ReadReplica) ToReadReplicaOutput() ReadReplicaOutput

func (*ReadReplica) ToReadReplicaOutputWithContext

func (i *ReadReplica) ToReadReplicaOutputWithContext(ctx context.Context) ReadReplicaOutput

type ReadReplicaArgs

type ReadReplicaArgs struct {
	// Creates a direct access endpoint to documentdb replica.
	DirectAccess ReadReplicaDirectAccessPtrInput
	// UUID of the documentdb instance.
	//
	// > **Important:** The replica musts contains at least one of `directAccess` or `privateNetwork`. It can contain both.
	InstanceId pulumi.StringInput
	// Create an endpoint in a private network.
	PrivateNetwork ReadReplicaPrivateNetworkPtrInput
	// `region`) The region
	// in which the Database read replica should be created.
	Region pulumi.StringPtrInput
}

The set of arguments for constructing a ReadReplica resource.

func (ReadReplicaArgs) ElementType

func (ReadReplicaArgs) ElementType() reflect.Type

type ReadReplicaArray

type ReadReplicaArray []ReadReplicaInput

func (ReadReplicaArray) ElementType

func (ReadReplicaArray) ElementType() reflect.Type

func (ReadReplicaArray) ToReadReplicaArrayOutput

func (i ReadReplicaArray) ToReadReplicaArrayOutput() ReadReplicaArrayOutput

func (ReadReplicaArray) ToReadReplicaArrayOutputWithContext

func (i ReadReplicaArray) ToReadReplicaArrayOutputWithContext(ctx context.Context) ReadReplicaArrayOutput

type ReadReplicaArrayInput

type ReadReplicaArrayInput interface {
	pulumi.Input

	ToReadReplicaArrayOutput() ReadReplicaArrayOutput
	ToReadReplicaArrayOutputWithContext(context.Context) ReadReplicaArrayOutput
}

ReadReplicaArrayInput is an input type that accepts ReadReplicaArray and ReadReplicaArrayOutput values. You can construct a concrete instance of `ReadReplicaArrayInput` via:

ReadReplicaArray{ ReadReplicaArgs{...} }

type ReadReplicaArrayOutput

type ReadReplicaArrayOutput struct{ *pulumi.OutputState }

func (ReadReplicaArrayOutput) ElementType

func (ReadReplicaArrayOutput) ElementType() reflect.Type

func (ReadReplicaArrayOutput) Index

func (ReadReplicaArrayOutput) ToReadReplicaArrayOutput

func (o ReadReplicaArrayOutput) ToReadReplicaArrayOutput() ReadReplicaArrayOutput

func (ReadReplicaArrayOutput) ToReadReplicaArrayOutputWithContext

func (o ReadReplicaArrayOutput) ToReadReplicaArrayOutputWithContext(ctx context.Context) ReadReplicaArrayOutput

type ReadReplicaDirectAccess

type ReadReplicaDirectAccess struct {
	// The ID of the endpoint of the read replica.
	EndpointId *string `pulumi:"endpointId"`
	// Hostname of the endpoint. Only one of ip and hostname may be set.
	Hostname *string `pulumi:"hostname"`
	// IPv4 address of the endpoint (IP address). Only one of ip and hostname may be set.
	Ip *string `pulumi:"ip"`
	// Name of the endpoint.
	Name *string `pulumi:"name"`
	// TCP port of the endpoint.
	Port *int `pulumi:"port"`
}

type ReadReplicaDirectAccessArgs

type ReadReplicaDirectAccessArgs struct {
	// The ID of the endpoint of the read replica.
	EndpointId pulumi.StringPtrInput `pulumi:"endpointId"`
	// Hostname of the endpoint. Only one of ip and hostname may be set.
	Hostname pulumi.StringPtrInput `pulumi:"hostname"`
	// IPv4 address of the endpoint (IP address). Only one of ip and hostname may be set.
	Ip pulumi.StringPtrInput `pulumi:"ip"`
	// Name of the endpoint.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// TCP port of the endpoint.
	Port pulumi.IntPtrInput `pulumi:"port"`
}

func (ReadReplicaDirectAccessArgs) ElementType

func (ReadReplicaDirectAccessArgs) ToReadReplicaDirectAccessOutput

func (i ReadReplicaDirectAccessArgs) ToReadReplicaDirectAccessOutput() ReadReplicaDirectAccessOutput

func (ReadReplicaDirectAccessArgs) ToReadReplicaDirectAccessOutputWithContext

func (i ReadReplicaDirectAccessArgs) ToReadReplicaDirectAccessOutputWithContext(ctx context.Context) ReadReplicaDirectAccessOutput

func (ReadReplicaDirectAccessArgs) ToReadReplicaDirectAccessPtrOutput

func (i ReadReplicaDirectAccessArgs) ToReadReplicaDirectAccessPtrOutput() ReadReplicaDirectAccessPtrOutput

func (ReadReplicaDirectAccessArgs) ToReadReplicaDirectAccessPtrOutputWithContext

func (i ReadReplicaDirectAccessArgs) ToReadReplicaDirectAccessPtrOutputWithContext(ctx context.Context) ReadReplicaDirectAccessPtrOutput

type ReadReplicaDirectAccessInput

type ReadReplicaDirectAccessInput interface {
	pulumi.Input

	ToReadReplicaDirectAccessOutput() ReadReplicaDirectAccessOutput
	ToReadReplicaDirectAccessOutputWithContext(context.Context) ReadReplicaDirectAccessOutput
}

ReadReplicaDirectAccessInput is an input type that accepts ReadReplicaDirectAccessArgs and ReadReplicaDirectAccessOutput values. You can construct a concrete instance of `ReadReplicaDirectAccessInput` via:

ReadReplicaDirectAccessArgs{...}

type ReadReplicaDirectAccessOutput

type ReadReplicaDirectAccessOutput struct{ *pulumi.OutputState }

func (ReadReplicaDirectAccessOutput) ElementType

func (ReadReplicaDirectAccessOutput) EndpointId

The ID of the endpoint of the read replica.

func (ReadReplicaDirectAccessOutput) Hostname

Hostname of the endpoint. Only one of ip and hostname may be set.

func (ReadReplicaDirectAccessOutput) Ip

IPv4 address of the endpoint (IP address). Only one of ip and hostname may be set.

func (ReadReplicaDirectAccessOutput) Name

Name of the endpoint.

func (ReadReplicaDirectAccessOutput) Port

TCP port of the endpoint.

func (ReadReplicaDirectAccessOutput) ToReadReplicaDirectAccessOutput

func (o ReadReplicaDirectAccessOutput) ToReadReplicaDirectAccessOutput() ReadReplicaDirectAccessOutput

func (ReadReplicaDirectAccessOutput) ToReadReplicaDirectAccessOutputWithContext

func (o ReadReplicaDirectAccessOutput) ToReadReplicaDirectAccessOutputWithContext(ctx context.Context) ReadReplicaDirectAccessOutput

func (ReadReplicaDirectAccessOutput) ToReadReplicaDirectAccessPtrOutput

func (o ReadReplicaDirectAccessOutput) ToReadReplicaDirectAccessPtrOutput() ReadReplicaDirectAccessPtrOutput

func (ReadReplicaDirectAccessOutput) ToReadReplicaDirectAccessPtrOutputWithContext

func (o ReadReplicaDirectAccessOutput) ToReadReplicaDirectAccessPtrOutputWithContext(ctx context.Context) ReadReplicaDirectAccessPtrOutput

type ReadReplicaDirectAccessPtrInput

type ReadReplicaDirectAccessPtrInput interface {
	pulumi.Input

	ToReadReplicaDirectAccessPtrOutput() ReadReplicaDirectAccessPtrOutput
	ToReadReplicaDirectAccessPtrOutputWithContext(context.Context) ReadReplicaDirectAccessPtrOutput
}

ReadReplicaDirectAccessPtrInput is an input type that accepts ReadReplicaDirectAccessArgs, ReadReplicaDirectAccessPtr and ReadReplicaDirectAccessPtrOutput values. You can construct a concrete instance of `ReadReplicaDirectAccessPtrInput` via:

        ReadReplicaDirectAccessArgs{...}

or:

        nil

type ReadReplicaDirectAccessPtrOutput

type ReadReplicaDirectAccessPtrOutput struct{ *pulumi.OutputState }

func (ReadReplicaDirectAccessPtrOutput) Elem

func (ReadReplicaDirectAccessPtrOutput) ElementType

func (ReadReplicaDirectAccessPtrOutput) EndpointId

The ID of the endpoint of the read replica.

func (ReadReplicaDirectAccessPtrOutput) Hostname

Hostname of the endpoint. Only one of ip and hostname may be set.

func (ReadReplicaDirectAccessPtrOutput) Ip

IPv4 address of the endpoint (IP address). Only one of ip and hostname may be set.

func (ReadReplicaDirectAccessPtrOutput) Name

Name of the endpoint.

func (ReadReplicaDirectAccessPtrOutput) Port

TCP port of the endpoint.

func (ReadReplicaDirectAccessPtrOutput) ToReadReplicaDirectAccessPtrOutput

func (o ReadReplicaDirectAccessPtrOutput) ToReadReplicaDirectAccessPtrOutput() ReadReplicaDirectAccessPtrOutput

func (ReadReplicaDirectAccessPtrOutput) ToReadReplicaDirectAccessPtrOutputWithContext

func (o ReadReplicaDirectAccessPtrOutput) ToReadReplicaDirectAccessPtrOutputWithContext(ctx context.Context) ReadReplicaDirectAccessPtrOutput

type ReadReplicaInput

type ReadReplicaInput interface {
	pulumi.Input

	ToReadReplicaOutput() ReadReplicaOutput
	ToReadReplicaOutputWithContext(ctx context.Context) ReadReplicaOutput
}

type ReadReplicaMap

type ReadReplicaMap map[string]ReadReplicaInput

func (ReadReplicaMap) ElementType

func (ReadReplicaMap) ElementType() reflect.Type

func (ReadReplicaMap) ToReadReplicaMapOutput

func (i ReadReplicaMap) ToReadReplicaMapOutput() ReadReplicaMapOutput

func (ReadReplicaMap) ToReadReplicaMapOutputWithContext

func (i ReadReplicaMap) ToReadReplicaMapOutputWithContext(ctx context.Context) ReadReplicaMapOutput

type ReadReplicaMapInput

type ReadReplicaMapInput interface {
	pulumi.Input

	ToReadReplicaMapOutput() ReadReplicaMapOutput
	ToReadReplicaMapOutputWithContext(context.Context) ReadReplicaMapOutput
}

ReadReplicaMapInput is an input type that accepts ReadReplicaMap and ReadReplicaMapOutput values. You can construct a concrete instance of `ReadReplicaMapInput` via:

ReadReplicaMap{ "key": ReadReplicaArgs{...} }

type ReadReplicaMapOutput

type ReadReplicaMapOutput struct{ *pulumi.OutputState }

func (ReadReplicaMapOutput) ElementType

func (ReadReplicaMapOutput) ElementType() reflect.Type

func (ReadReplicaMapOutput) MapIndex

func (ReadReplicaMapOutput) ToReadReplicaMapOutput

func (o ReadReplicaMapOutput) ToReadReplicaMapOutput() ReadReplicaMapOutput

func (ReadReplicaMapOutput) ToReadReplicaMapOutputWithContext

func (o ReadReplicaMapOutput) ToReadReplicaMapOutputWithContext(ctx context.Context) ReadReplicaMapOutput

type ReadReplicaOutput

type ReadReplicaOutput struct{ *pulumi.OutputState }

func (ReadReplicaOutput) DirectAccess

Creates a direct access endpoint to documentdb replica.

func (ReadReplicaOutput) ElementType

func (ReadReplicaOutput) ElementType() reflect.Type

func (ReadReplicaOutput) InstanceId

func (o ReadReplicaOutput) InstanceId() pulumi.StringOutput

UUID of the documentdb instance.

> **Important:** The replica musts contains at least one of `directAccess` or `privateNetwork`. It can contain both.

func (ReadReplicaOutput) PrivateNetwork

Create an endpoint in a private network.

func (ReadReplicaOutput) Region

`region`) The region in which the Database read replica should be created.

func (ReadReplicaOutput) ToReadReplicaOutput

func (o ReadReplicaOutput) ToReadReplicaOutput() ReadReplicaOutput

func (ReadReplicaOutput) ToReadReplicaOutputWithContext

func (o ReadReplicaOutput) ToReadReplicaOutputWithContext(ctx context.Context) ReadReplicaOutput

type ReadReplicaPrivateNetwork

type ReadReplicaPrivateNetwork struct {
	// The ID of the endpoint of the read replica.
	EndpointId *string `pulumi:"endpointId"`
	// Hostname of the endpoint. Only one of ip and hostname may be set.
	Hostname *string `pulumi:"hostname"`
	// IPv4 address of the endpoint (IP address). Only one of ip and hostname may be set.
	Ip *string `pulumi:"ip"`
	// Name of the endpoint.
	Name *string `pulumi:"name"`
	// TCP port of the endpoint.
	Port *int `pulumi:"port"`
	// UUID of the private network to be connected to the read replica.
	PrivateNetworkId string `pulumi:"privateNetworkId"`
	// The IP network address within the private subnet. This must be an IPv4 address with a
	// CIDR notation. The IP network address within the private subnet is determined by the IP Address Management (IPAM)
	// service if not set.
	ServiceIp *string `pulumi:"serviceIp"`
	// Private network zone
	Zone *string `pulumi:"zone"`
}

type ReadReplicaPrivateNetworkArgs

type ReadReplicaPrivateNetworkArgs struct {
	// The ID of the endpoint of the read replica.
	EndpointId pulumi.StringPtrInput `pulumi:"endpointId"`
	// Hostname of the endpoint. Only one of ip and hostname may be set.
	Hostname pulumi.StringPtrInput `pulumi:"hostname"`
	// IPv4 address of the endpoint (IP address). Only one of ip and hostname may be set.
	Ip pulumi.StringPtrInput `pulumi:"ip"`
	// Name of the endpoint.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// TCP port of the endpoint.
	Port pulumi.IntPtrInput `pulumi:"port"`
	// UUID of the private network to be connected to the read replica.
	PrivateNetworkId pulumi.StringInput `pulumi:"privateNetworkId"`
	// The IP network address within the private subnet. This must be an IPv4 address with a
	// CIDR notation. The IP network address within the private subnet is determined by the IP Address Management (IPAM)
	// service if not set.
	ServiceIp pulumi.StringPtrInput `pulumi:"serviceIp"`
	// Private network zone
	Zone pulumi.StringPtrInput `pulumi:"zone"`
}

func (ReadReplicaPrivateNetworkArgs) ElementType

func (ReadReplicaPrivateNetworkArgs) ToReadReplicaPrivateNetworkOutput

func (i ReadReplicaPrivateNetworkArgs) ToReadReplicaPrivateNetworkOutput() ReadReplicaPrivateNetworkOutput

func (ReadReplicaPrivateNetworkArgs) ToReadReplicaPrivateNetworkOutputWithContext

func (i ReadReplicaPrivateNetworkArgs) ToReadReplicaPrivateNetworkOutputWithContext(ctx context.Context) ReadReplicaPrivateNetworkOutput

func (ReadReplicaPrivateNetworkArgs) ToReadReplicaPrivateNetworkPtrOutput

func (i ReadReplicaPrivateNetworkArgs) ToReadReplicaPrivateNetworkPtrOutput() ReadReplicaPrivateNetworkPtrOutput

func (ReadReplicaPrivateNetworkArgs) ToReadReplicaPrivateNetworkPtrOutputWithContext

func (i ReadReplicaPrivateNetworkArgs) ToReadReplicaPrivateNetworkPtrOutputWithContext(ctx context.Context) ReadReplicaPrivateNetworkPtrOutput

type ReadReplicaPrivateNetworkInput

type ReadReplicaPrivateNetworkInput interface {
	pulumi.Input

	ToReadReplicaPrivateNetworkOutput() ReadReplicaPrivateNetworkOutput
	ToReadReplicaPrivateNetworkOutputWithContext(context.Context) ReadReplicaPrivateNetworkOutput
}

ReadReplicaPrivateNetworkInput is an input type that accepts ReadReplicaPrivateNetworkArgs and ReadReplicaPrivateNetworkOutput values. You can construct a concrete instance of `ReadReplicaPrivateNetworkInput` via:

ReadReplicaPrivateNetworkArgs{...}

type ReadReplicaPrivateNetworkOutput

type ReadReplicaPrivateNetworkOutput struct{ *pulumi.OutputState }

func (ReadReplicaPrivateNetworkOutput) ElementType

func (ReadReplicaPrivateNetworkOutput) EndpointId

The ID of the endpoint of the read replica.

func (ReadReplicaPrivateNetworkOutput) Hostname

Hostname of the endpoint. Only one of ip and hostname may be set.

func (ReadReplicaPrivateNetworkOutput) Ip

IPv4 address of the endpoint (IP address). Only one of ip and hostname may be set.

func (ReadReplicaPrivateNetworkOutput) Name

Name of the endpoint.

func (ReadReplicaPrivateNetworkOutput) Port

TCP port of the endpoint.

func (ReadReplicaPrivateNetworkOutput) PrivateNetworkId

UUID of the private network to be connected to the read replica.

func (ReadReplicaPrivateNetworkOutput) ServiceIp

The IP network address within the private subnet. This must be an IPv4 address with a CIDR notation. The IP network address within the private subnet is determined by the IP Address Management (IPAM) service if not set.

func (ReadReplicaPrivateNetworkOutput) ToReadReplicaPrivateNetworkOutput

func (o ReadReplicaPrivateNetworkOutput) ToReadReplicaPrivateNetworkOutput() ReadReplicaPrivateNetworkOutput

func (ReadReplicaPrivateNetworkOutput) ToReadReplicaPrivateNetworkOutputWithContext

func (o ReadReplicaPrivateNetworkOutput) ToReadReplicaPrivateNetworkOutputWithContext(ctx context.Context) ReadReplicaPrivateNetworkOutput

func (ReadReplicaPrivateNetworkOutput) ToReadReplicaPrivateNetworkPtrOutput

func (o ReadReplicaPrivateNetworkOutput) ToReadReplicaPrivateNetworkPtrOutput() ReadReplicaPrivateNetworkPtrOutput

func (ReadReplicaPrivateNetworkOutput) ToReadReplicaPrivateNetworkPtrOutputWithContext

func (o ReadReplicaPrivateNetworkOutput) ToReadReplicaPrivateNetworkPtrOutputWithContext(ctx context.Context) ReadReplicaPrivateNetworkPtrOutput

func (ReadReplicaPrivateNetworkOutput) Zone

Private network zone

type ReadReplicaPrivateNetworkPtrInput

type ReadReplicaPrivateNetworkPtrInput interface {
	pulumi.Input

	ToReadReplicaPrivateNetworkPtrOutput() ReadReplicaPrivateNetworkPtrOutput
	ToReadReplicaPrivateNetworkPtrOutputWithContext(context.Context) ReadReplicaPrivateNetworkPtrOutput
}

ReadReplicaPrivateNetworkPtrInput is an input type that accepts ReadReplicaPrivateNetworkArgs, ReadReplicaPrivateNetworkPtr and ReadReplicaPrivateNetworkPtrOutput values. You can construct a concrete instance of `ReadReplicaPrivateNetworkPtrInput` via:

        ReadReplicaPrivateNetworkArgs{...}

or:

        nil

type ReadReplicaPrivateNetworkPtrOutput

type ReadReplicaPrivateNetworkPtrOutput struct{ *pulumi.OutputState }

func (ReadReplicaPrivateNetworkPtrOutput) Elem

func (ReadReplicaPrivateNetworkPtrOutput) ElementType

func (ReadReplicaPrivateNetworkPtrOutput) EndpointId

The ID of the endpoint of the read replica.

func (ReadReplicaPrivateNetworkPtrOutput) Hostname

Hostname of the endpoint. Only one of ip and hostname may be set.

func (ReadReplicaPrivateNetworkPtrOutput) Ip

IPv4 address of the endpoint (IP address). Only one of ip and hostname may be set.

func (ReadReplicaPrivateNetworkPtrOutput) Name

Name of the endpoint.

func (ReadReplicaPrivateNetworkPtrOutput) Port

TCP port of the endpoint.

func (ReadReplicaPrivateNetworkPtrOutput) PrivateNetworkId

UUID of the private network to be connected to the read replica.

func (ReadReplicaPrivateNetworkPtrOutput) ServiceIp

The IP network address within the private subnet. This must be an IPv4 address with a CIDR notation. The IP network address within the private subnet is determined by the IP Address Management (IPAM) service if not set.

func (ReadReplicaPrivateNetworkPtrOutput) ToReadReplicaPrivateNetworkPtrOutput

func (o ReadReplicaPrivateNetworkPtrOutput) ToReadReplicaPrivateNetworkPtrOutput() ReadReplicaPrivateNetworkPtrOutput

func (ReadReplicaPrivateNetworkPtrOutput) ToReadReplicaPrivateNetworkPtrOutputWithContext

func (o ReadReplicaPrivateNetworkPtrOutput) ToReadReplicaPrivateNetworkPtrOutputWithContext(ctx context.Context) ReadReplicaPrivateNetworkPtrOutput

func (ReadReplicaPrivateNetworkPtrOutput) Zone

Private network zone

type ReadReplicaState

type ReadReplicaState struct {
	// Creates a direct access endpoint to documentdb replica.
	DirectAccess ReadReplicaDirectAccessPtrInput
	// UUID of the documentdb instance.
	//
	// > **Important:** The replica musts contains at least one of `directAccess` or `privateNetwork`. It can contain both.
	InstanceId pulumi.StringPtrInput
	// Create an endpoint in a private network.
	PrivateNetwork ReadReplicaPrivateNetworkPtrInput
	// `region`) The region
	// in which the Database read replica should be created.
	Region pulumi.StringPtrInput
}

func (ReadReplicaState) ElementType

func (ReadReplicaState) ElementType() reflect.Type

type User

type User struct {
	pulumi.CustomResourceState

	// UUID of the documentDB instance.
	//
	// > **Important:** Updates to `instanceId` will recreate the Database User.
	InstanceId pulumi.StringOutput `pulumi:"instanceId"`
	// Grant admin permissions to the Database User.
	IsAdmin pulumi.BoolPtrOutput `pulumi:"isAdmin"`
	// Database Username.
	//
	// > **Important:** Updates to `name` will recreate the Database User.
	Name pulumi.StringOutput `pulumi:"name"`
	// Database User password.
	Password pulumi.StringOutput `pulumi:"password"`
	// The Scaleway region this resource resides in.
	Region pulumi.StringOutput `pulumi:"region"`
}

Creates and manages Scaleway Database DocumentDB Users. For more information, see [the documentation](https://www.scaleway.com/en/developers/api/document_db/).

## Example Usage

### Basic

<!--Start PulumiCodeChooser --> ```go package main

import (

"github.com/pulumi/pulumi-random/sdk/v4/go/random"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/raeumlich/pulumi-scaleway/sdk/go/scaleway/documentdb"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		dbPassword, err := random.NewRandomPassword(ctx, "dbPassword", &random.RandomPasswordArgs{
			Length:  pulumi.Int(16),
			Special: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = documentdb.NewUser(ctx, "dbAdmin", &documentdb.UserArgs{
			InstanceId: pulumi.String("11111111-1111-1111-1111-111111111111"),
			Password:   dbPassword.Result,
			IsAdmin:    pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Database User can be imported using `{region}/{instance_id}/{user_name}`, e.g.

bash

```sh $ pulumi import scaleway:documentdb/user:User admin fr-par/11111111-1111-1111-1111-111111111111/admin ```

func GetUser

func GetUser(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *UserState, opts ...pulumi.ResourceOption) (*User, error)

GetUser gets an existing User 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 NewUser

func NewUser(ctx *pulumi.Context,
	name string, args *UserArgs, opts ...pulumi.ResourceOption) (*User, error)

NewUser registers a new resource with the given unique name, arguments, and options.

func (*User) ElementType

func (*User) ElementType() reflect.Type

func (*User) ToUserOutput

func (i *User) ToUserOutput() UserOutput

func (*User) ToUserOutputWithContext

func (i *User) ToUserOutputWithContext(ctx context.Context) UserOutput

type UserArgs

type UserArgs struct {
	// UUID of the documentDB instance.
	//
	// > **Important:** Updates to `instanceId` will recreate the Database User.
	InstanceId pulumi.StringInput
	// Grant admin permissions to the Database User.
	IsAdmin pulumi.BoolPtrInput
	// Database Username.
	//
	// > **Important:** Updates to `name` will recreate the Database User.
	Name pulumi.StringPtrInput
	// Database User password.
	Password pulumi.StringInput
	// The Scaleway region this resource resides in.
	Region pulumi.StringPtrInput
}

The set of arguments for constructing a User resource.

func (UserArgs) ElementType

func (UserArgs) ElementType() reflect.Type

type UserArray

type UserArray []UserInput

func (UserArray) ElementType

func (UserArray) ElementType() reflect.Type

func (UserArray) ToUserArrayOutput

func (i UserArray) ToUserArrayOutput() UserArrayOutput

func (UserArray) ToUserArrayOutputWithContext

func (i UserArray) ToUserArrayOutputWithContext(ctx context.Context) UserArrayOutput

type UserArrayInput

type UserArrayInput interface {
	pulumi.Input

	ToUserArrayOutput() UserArrayOutput
	ToUserArrayOutputWithContext(context.Context) UserArrayOutput
}

UserArrayInput is an input type that accepts UserArray and UserArrayOutput values. You can construct a concrete instance of `UserArrayInput` via:

UserArray{ UserArgs{...} }

type UserArrayOutput

type UserArrayOutput struct{ *pulumi.OutputState }

func (UserArrayOutput) ElementType

func (UserArrayOutput) ElementType() reflect.Type

func (UserArrayOutput) Index

func (UserArrayOutput) ToUserArrayOutput

func (o UserArrayOutput) ToUserArrayOutput() UserArrayOutput

func (UserArrayOutput) ToUserArrayOutputWithContext

func (o UserArrayOutput) ToUserArrayOutputWithContext(ctx context.Context) UserArrayOutput

type UserInput

type UserInput interface {
	pulumi.Input

	ToUserOutput() UserOutput
	ToUserOutputWithContext(ctx context.Context) UserOutput
}

type UserMap

type UserMap map[string]UserInput

func (UserMap) ElementType

func (UserMap) ElementType() reflect.Type

func (UserMap) ToUserMapOutput

func (i UserMap) ToUserMapOutput() UserMapOutput

func (UserMap) ToUserMapOutputWithContext

func (i UserMap) ToUserMapOutputWithContext(ctx context.Context) UserMapOutput

type UserMapInput

type UserMapInput interface {
	pulumi.Input

	ToUserMapOutput() UserMapOutput
	ToUserMapOutputWithContext(context.Context) UserMapOutput
}

UserMapInput is an input type that accepts UserMap and UserMapOutput values. You can construct a concrete instance of `UserMapInput` via:

UserMap{ "key": UserArgs{...} }

type UserMapOutput

type UserMapOutput struct{ *pulumi.OutputState }

func (UserMapOutput) ElementType

func (UserMapOutput) ElementType() reflect.Type

func (UserMapOutput) MapIndex

func (UserMapOutput) ToUserMapOutput

func (o UserMapOutput) ToUserMapOutput() UserMapOutput

func (UserMapOutput) ToUserMapOutputWithContext

func (o UserMapOutput) ToUserMapOutputWithContext(ctx context.Context) UserMapOutput

type UserOutput

type UserOutput struct{ *pulumi.OutputState }

func (UserOutput) ElementType

func (UserOutput) ElementType() reflect.Type

func (UserOutput) InstanceId

func (o UserOutput) InstanceId() pulumi.StringOutput

UUID of the documentDB instance.

> **Important:** Updates to `instanceId` will recreate the Database User.

func (UserOutput) IsAdmin

func (o UserOutput) IsAdmin() pulumi.BoolPtrOutput

Grant admin permissions to the Database User.

func (UserOutput) Name

func (o UserOutput) Name() pulumi.StringOutput

Database Username.

> **Important:** Updates to `name` will recreate the Database User.

func (UserOutput) Password

func (o UserOutput) Password() pulumi.StringOutput

Database User password.

func (UserOutput) Region

func (o UserOutput) Region() pulumi.StringOutput

The Scaleway region this resource resides in.

func (UserOutput) ToUserOutput

func (o UserOutput) ToUserOutput() UserOutput

func (UserOutput) ToUserOutputWithContext

func (o UserOutput) ToUserOutputWithContext(ctx context.Context) UserOutput

type UserState

type UserState struct {
	// UUID of the documentDB instance.
	//
	// > **Important:** Updates to `instanceId` will recreate the Database User.
	InstanceId pulumi.StringPtrInput
	// Grant admin permissions to the Database User.
	IsAdmin pulumi.BoolPtrInput
	// Database Username.
	//
	// > **Important:** Updates to `name` will recreate the Database User.
	Name pulumi.StringPtrInput
	// Database User password.
	Password pulumi.StringPtrInput
	// The Scaleway region this resource resides in.
	Region pulumi.StringPtrInput
}

func (UserState) ElementType

func (UserState) ElementType() reflect.Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL