1. Packages
  2. Scaleway
  3. API Docs
  4. getDocumentdbInstance
Scaleway v1.15.0 published on Tuesday, Jul 30, 2024 by pulumiverse

scaleway.getDocumentdbInstance

Explore with Pulumi AI

scaleway logo
Scaleway v1.15.0 published on Tuesday, Jul 30, 2024 by pulumiverse

    Gets information about an DocumentDB instance.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as scaleway from "@pulumi/scaleway";
    
    const db = scaleway.getDocumentdbInstance({
        instanceId: "11111111-1111-1111-1111-111111111111",
    });
    
    import pulumi
    import pulumi_scaleway as scaleway
    
    db = scaleway.get_documentdb_instance(instance_id="11111111-1111-1111-1111-111111111111")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := scaleway.LookupDocumentdbInstance(ctx, &scaleway.LookupDocumentdbInstanceArgs{
    			InstanceId: pulumi.StringRef("11111111-1111-1111-1111-111111111111"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Scaleway = Pulumi.Scaleway;
    
    return await Deployment.RunAsync(() => 
    {
        var db = Scaleway.GetDocumentdbInstance.Invoke(new()
        {
            InstanceId = "11111111-1111-1111-1111-111111111111",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.scaleway.ScalewayFunctions;
    import com.pulumi.scaleway.inputs.GetDocumentdbInstanceArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var db = ScalewayFunctions.getDocumentdbInstance(GetDocumentdbInstanceArgs.builder()
                .instanceId("11111111-1111-1111-1111-111111111111")
                .build());
    
        }
    }
    
    variables:
      db:
        fn::invoke:
          Function: scaleway:getDocumentdbInstance
          Arguments:
            instanceId: 11111111-1111-1111-1111-111111111111
    

    Using getDocumentdbInstance

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDocumentdbInstance(args: GetDocumentdbInstanceArgs, opts?: InvokeOptions): Promise<GetDocumentdbInstanceResult>
    function getDocumentdbInstanceOutput(args: GetDocumentdbInstanceOutputArgs, opts?: InvokeOptions): Output<GetDocumentdbInstanceResult>
    def get_documentdb_instance(instance_id: Optional[str] = None,
                                name: Optional[str] = None,
                                project_id: Optional[str] = None,
                                region: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetDocumentdbInstanceResult
    def get_documentdb_instance_output(instance_id: Optional[pulumi.Input[str]] = None,
                                name: Optional[pulumi.Input[str]] = None,
                                project_id: Optional[pulumi.Input[str]] = None,
                                region: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetDocumentdbInstanceResult]
    func LookupDocumentdbInstance(ctx *Context, args *LookupDocumentdbInstanceArgs, opts ...InvokeOption) (*LookupDocumentdbInstanceResult, error)
    func LookupDocumentdbInstanceOutput(ctx *Context, args *LookupDocumentdbInstanceOutputArgs, opts ...InvokeOption) LookupDocumentdbInstanceResultOutput

    > Note: This function is named LookupDocumentdbInstance in the Go SDK.

    public static class GetDocumentdbInstance 
    {
        public static Task<GetDocumentdbInstanceResult> InvokeAsync(GetDocumentdbInstanceArgs args, InvokeOptions? opts = null)
        public static Output<GetDocumentdbInstanceResult> Invoke(GetDocumentdbInstanceInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDocumentdbInstanceResult> getDocumentdbInstance(GetDocumentdbInstanceArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: scaleway:index/getDocumentdbInstance:getDocumentdbInstance
      arguments:
        # arguments dictionary

    The following arguments are supported:

    InstanceId string
    The DocumentDB instance ID. Only one of name and instance_id should be specified.
    Name string
    The name of the DocumentDB instance. Only one of name and instance_id should be specified.
    ProjectId string
    The ID of the project the DocumentDB instance is associated with.
    Region string
    region) The region in which the DocumentDB instance exists.
    InstanceId string
    The DocumentDB instance ID. Only one of name and instance_id should be specified.
    Name string
    The name of the DocumentDB instance. Only one of name and instance_id should be specified.
    ProjectId string
    The ID of the project the DocumentDB instance is associated with.
    Region string
    region) The region in which the DocumentDB instance exists.
    instanceId String
    The DocumentDB instance ID. Only one of name and instance_id should be specified.
    name String
    The name of the DocumentDB instance. Only one of name and instance_id should be specified.
    projectId String
    The ID of the project the DocumentDB instance is associated with.
    region String
    region) The region in which the DocumentDB instance exists.
    instanceId string
    The DocumentDB instance ID. Only one of name and instance_id should be specified.
    name string
    The name of the DocumentDB instance. Only one of name and instance_id should be specified.
    projectId string
    The ID of the project the DocumentDB instance is associated with.
    region string
    region) The region in which the DocumentDB instance exists.
    instance_id str
    The DocumentDB instance ID. Only one of name and instance_id should be specified.
    name str
    The name of the DocumentDB instance. Only one of name and instance_id should be specified.
    project_id str
    The ID of the project the DocumentDB instance is associated with.
    region str
    region) The region in which the DocumentDB instance exists.
    instanceId String
    The DocumentDB instance ID. Only one of name and instance_id should be specified.
    name String
    The name of the DocumentDB instance. Only one of name and instance_id should be specified.
    projectId String
    The ID of the project the DocumentDB instance is associated with.
    region String
    region) The region in which the DocumentDB instance exists.

    getDocumentdbInstance Result

    The following output properties are available:

    Engine string
    Id string
    The provider-assigned unique ID for this managed resource.
    IsHaCluster bool
    NodeType string
    Password string
    Tags List<string>
    TelemetryEnabled bool
    UserName string
    VolumeSizeInGb int
    VolumeType string
    InstanceId string
    Name string
    ProjectId string
    Region string
    Engine string
    Id string
    The provider-assigned unique ID for this managed resource.
    IsHaCluster bool
    NodeType string
    Password string
    Tags []string
    TelemetryEnabled bool
    UserName string
    VolumeSizeInGb int
    VolumeType string
    InstanceId string
    Name string
    ProjectId string
    Region string
    engine String
    id String
    The provider-assigned unique ID for this managed resource.
    isHaCluster Boolean
    nodeType String
    password String
    tags List<String>
    telemetryEnabled Boolean
    userName String
    volumeSizeInGb Integer
    volumeType String
    instanceId String
    name String
    projectId String
    region String
    engine string
    id string
    The provider-assigned unique ID for this managed resource.
    isHaCluster boolean
    nodeType string
    password string
    tags string[]
    telemetryEnabled boolean
    userName string
    volumeSizeInGb number
    volumeType string
    instanceId string
    name string
    projectId string
    region string
    engine str
    id str
    The provider-assigned unique ID for this managed resource.
    is_ha_cluster bool
    node_type str
    password str
    tags Sequence[str]
    telemetry_enabled bool
    user_name str
    volume_size_in_gb int
    volume_type str
    instance_id str
    name str
    project_id str
    region str
    engine String
    id String
    The provider-assigned unique ID for this managed resource.
    isHaCluster Boolean
    nodeType String
    password String
    tags List<String>
    telemetryEnabled Boolean
    userName String
    volumeSizeInGb Number
    volumeType String
    instanceId String
    name String
    projectId String
    region String

    Package Details

    Repository
    scaleway pulumiverse/pulumi-scaleway
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scaleway Terraform Provider.
    scaleway logo
    Scaleway v1.15.0 published on Tuesday, Jul 30, 2024 by pulumiverse