@lbrlabs/pulumi-scaleway/documentdbReadReplica.d.ts

A Pulumi package for creating and managing scaleway cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * Creates and manages Scaleway DocumentDB Database read replicas.
 * For more information, see [the documentation](https://www.scaleway.com/en/developers/api/document_db/).
 *
 * ## Examples
 *
 * ### Basic
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@lbrlabs/pulumi-scaleway";
 *
 * const replica = new scaleway.DocumentdbReadReplica("replica", {
 *     directAccess: {},
 *     instanceId: "11111111-1111-1111-1111-111111111111",
 * });
 * ```
 *
 * ### Private network
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@lbrlabs/pulumi-scaleway";
 *
 * const pn = new scaleway.VpcPrivateNetwork("pn", {});
 * const replica = new scaleway.DocumentdbReadReplica("replica", {
 *     instanceId: scaleway_rdb_instance.instance.id,
 *     privateNetwork: {
 *         privateNetworkId: pn.id,
 *         serviceIp: "192.168.1.254/24",
 *     },
 * });
 * ```
 *
 * ## Import
 *
 * Database Read replica can be imported using the `{region}/{id}`, e.g. bash
 *
 * ```sh
 *  $ pulumi import scaleway:index/documentdbReadReplica:DocumentdbReadReplica rr fr-par/11111111-1111-1111-1111-111111111111
 * ```
 */
export declare class DocumentdbReadReplica extends pulumi.CustomResource {
    /**
     * Get an existing DocumentdbReadReplica resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DocumentdbReadReplicaState, opts?: pulumi.CustomResourceOptions): DocumentdbReadReplica;
    /**
     * Returns true if the given object is an instance of DocumentdbReadReplica.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is DocumentdbReadReplica;
    /**
     * Creates a direct access endpoint to documentdb replica.
     */
    readonly directAccess: pulumi.Output<outputs.DocumentdbReadReplicaDirectAccess | undefined>;
    /**
     * UUID of the documentdb instance.
     *
     * > **Important:** The replica musts contains at least one of `directAccess` or `privateNetwork`. It can contain both.
     */
    readonly instanceId: pulumi.Output<string>;
    /**
     * Create an endpoint in a private network.
     */
    readonly privateNetwork: pulumi.Output<outputs.DocumentdbReadReplicaPrivateNetwork | undefined>;
    /**
     * `region`) The region
     * in which the Database read replica should be created.
     */
    readonly region: pulumi.Output<string>;
    /**
     * Create a DocumentdbReadReplica resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: DocumentdbReadReplicaArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering DocumentdbReadReplica resources.
 */
export interface DocumentdbReadReplicaState {
    /**
     * Creates a direct access endpoint to documentdb replica.
     */
    directAccess?: pulumi.Input<inputs.DocumentdbReadReplicaDirectAccess>;
    /**
     * UUID of the documentdb instance.
     *
     * > **Important:** The replica musts contains at least one of `directAccess` or `privateNetwork`. It can contain both.
     */
    instanceId?: pulumi.Input<string>;
    /**
     * Create an endpoint in a private network.
     */
    privateNetwork?: pulumi.Input<inputs.DocumentdbReadReplicaPrivateNetwork>;
    /**
     * `region`) The region
     * in which the Database read replica should be created.
     */
    region?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a DocumentdbReadReplica resource.
 */
export interface DocumentdbReadReplicaArgs {
    /**
     * Creates a direct access endpoint to documentdb replica.
     */
    directAccess?: pulumi.Input<inputs.DocumentdbReadReplicaDirectAccess>;
    /**
     * UUID of the documentdb instance.
     *
     * > **Important:** The replica musts contains at least one of `directAccess` or `privateNetwork`. It can contain both.
     */
    instanceId: pulumi.Input<string>;
    /**
     * Create an endpoint in a private network.
     */
    privateNetwork?: pulumi.Input<inputs.DocumentdbReadReplicaPrivateNetwork>;
    /**
     * `region`) The region
     * in which the Database read replica should be created.
     */
    region?: pulumi.Input<string>;
}