1. Packages
  2. OVH
  3. API Docs
  4. CloudProject
  5. getM3dbNamespace
OVHCloud v1.1.0 published on Thursday, Nov 21, 2024 by OVHcloud

ovh.CloudProject.getM3dbNamespace

Explore with Pulumi AI

ovh logo
OVHCloud v1.1.0 published on Thursday, Nov 21, 2024 by OVHcloud

    Use this data source to get information about a namespace of a M3DB cluster associated with a public cloud project.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ovh from "@pulumi/ovh";
    
    const m3dbNamespace = ovh.CloudProject.getM3dbNamespace({
        serviceName: "XXX",
        clusterId: "YYY",
        name: "ZZZ",
    });
    export const m3dbnamespaceType = m3dbNamespace.then(m3dbNamespace => m3dbNamespace.type);
    
    import pulumi
    import pulumi_ovh as ovh
    
    m3db_namespace = ovh.CloudProject.get_m3db_namespace(service_name="XXX",
        cluster_id="YYY",
        name="ZZZ")
    pulumi.export("m3dbnamespaceType", m3db_namespace.type)
    
    package main
    
    import (
    	"github.com/ovh/pulumi-ovh/sdk/go/ovh/CloudProject"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		m3dbNamespace, err := CloudProject.GetM3dbNamespace(ctx, &cloudproject.GetM3dbNamespaceArgs{
    			ServiceName: "XXX",
    			ClusterId:   "YYY",
    			Name:        "ZZZ",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("m3dbnamespaceType", m3dbNamespace.Type)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ovh = Pulumi.Ovh;
    
    return await Deployment.RunAsync(() => 
    {
        var m3dbNamespace = Ovh.CloudProject.GetM3dbNamespace.Invoke(new()
        {
            ServiceName = "XXX",
            ClusterId = "YYY",
            Name = "ZZZ",
        });
    
        return new Dictionary<string, object?>
        {
            ["m3dbnamespaceType"] = m3dbNamespace.Apply(getM3dbNamespaceResult => getM3dbNamespaceResult.Type),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ovh.CloudProject.CloudProjectFunctions;
    import com.pulumi.ovh.CloudProject.inputs.GetM3dbNamespaceArgs;
    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 m3dbNamespace = CloudProjectFunctions.getM3dbNamespace(GetM3dbNamespaceArgs.builder()
                .serviceName("XXX")
                .clusterId("YYY")
                .name("ZZZ")
                .build());
    
            ctx.export("m3dbnamespaceType", m3dbNamespace.applyValue(getM3dbNamespaceResult -> getM3dbNamespaceResult.type()));
        }
    }
    
    variables:
      m3dbNamespace:
        fn::invoke:
          Function: ovh:CloudProject:getM3dbNamespace
          Arguments:
            serviceName: XXX
            clusterId: YYY
            name: ZZZ
    outputs:
      m3dbnamespaceType: ${m3dbNamespace.type}
    

    Using getM3dbNamespace

    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 getM3dbNamespace(args: GetM3dbNamespaceArgs, opts?: InvokeOptions): Promise<GetM3dbNamespaceResult>
    function getM3dbNamespaceOutput(args: GetM3dbNamespaceOutputArgs, opts?: InvokeOptions): Output<GetM3dbNamespaceResult>
    def get_m3db_namespace(cluster_id: Optional[str] = None,
                           name: Optional[str] = None,
                           service_name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetM3dbNamespaceResult
    def get_m3db_namespace_output(cluster_id: Optional[pulumi.Input[str]] = None,
                           name: Optional[pulumi.Input[str]] = None,
                           service_name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetM3dbNamespaceResult]
    func GetM3dbNamespace(ctx *Context, args *GetM3dbNamespaceArgs, opts ...InvokeOption) (*GetM3dbNamespaceResult, error)
    func GetM3dbNamespaceOutput(ctx *Context, args *GetM3dbNamespaceOutputArgs, opts ...InvokeOption) GetM3dbNamespaceResultOutput

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

    public static class GetM3dbNamespace 
    {
        public static Task<GetM3dbNamespaceResult> InvokeAsync(GetM3dbNamespaceArgs args, InvokeOptions? opts = null)
        public static Output<GetM3dbNamespaceResult> Invoke(GetM3dbNamespaceInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetM3dbNamespaceResult> getM3dbNamespace(GetM3dbNamespaceArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: ovh:CloudProject/getM3dbNamespace:getM3dbNamespace
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ClusterId string
    Cluster ID
    Name string
    Name of the namespace.
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    ClusterId string
    Cluster ID
    Name string
    Name of the namespace.
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    clusterId String
    Cluster ID
    name String
    Name of the namespace.
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    clusterId string
    Cluster ID
    name string
    Name of the namespace.
    serviceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    cluster_id str
    Cluster ID
    name str
    Name of the namespace.
    service_name str
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    clusterId String
    Cluster ID
    name String
    Name of the namespace.
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.

    getM3dbNamespace Result

    The following output properties are available:

    ClusterId string
    See Argument Reference above.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    See Argument Reference above.
    Resolution string
    Resolution for an aggregated namespace.
    RetentionBlockDataExpirationDuration string
    Controls how long we wait before expiring stale data.
    RetentionBlockSizeDuration string
    Controls how long to keep a block in memory before flushing to a fileset on disk.
    RetentionBufferFutureDuration string
    Controls how far into the future writes to the namespace will be accepted.
    RetentionBufferPastDuration string
    Controls how far into the past writes to the namespace will be accepted.
    RetentionPeriodDuration string
    Controls the duration of time that M3DB will retain data for the namespace.
    ServiceName string
    See Argument Reference above.
    SnapshotEnabled bool
    SDefines whether M3db will create snapshot files for this namespace.
    Type string
    Type of namespace.
    WritesToCommitLogEnabled bool
    Defines whether M3DB will include writes to this namespace in the commit log.
    ClusterId string
    See Argument Reference above.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    See Argument Reference above.
    Resolution string
    Resolution for an aggregated namespace.
    RetentionBlockDataExpirationDuration string
    Controls how long we wait before expiring stale data.
    RetentionBlockSizeDuration string
    Controls how long to keep a block in memory before flushing to a fileset on disk.
    RetentionBufferFutureDuration string
    Controls how far into the future writes to the namespace will be accepted.
    RetentionBufferPastDuration string
    Controls how far into the past writes to the namespace will be accepted.
    RetentionPeriodDuration string
    Controls the duration of time that M3DB will retain data for the namespace.
    ServiceName string
    See Argument Reference above.
    SnapshotEnabled bool
    SDefines whether M3db will create snapshot files for this namespace.
    Type string
    Type of namespace.
    WritesToCommitLogEnabled bool
    Defines whether M3DB will include writes to this namespace in the commit log.
    clusterId String
    See Argument Reference above.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    See Argument Reference above.
    resolution String
    Resolution for an aggregated namespace.
    retentionBlockDataExpirationDuration String
    Controls how long we wait before expiring stale data.
    retentionBlockSizeDuration String
    Controls how long to keep a block in memory before flushing to a fileset on disk.
    retentionBufferFutureDuration String
    Controls how far into the future writes to the namespace will be accepted.
    retentionBufferPastDuration String
    Controls how far into the past writes to the namespace will be accepted.
    retentionPeriodDuration String
    Controls the duration of time that M3DB will retain data for the namespace.
    serviceName String
    See Argument Reference above.
    snapshotEnabled Boolean
    SDefines whether M3db will create snapshot files for this namespace.
    type String
    Type of namespace.
    writesToCommitLogEnabled Boolean
    Defines whether M3DB will include writes to this namespace in the commit log.
    clusterId string
    See Argument Reference above.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    See Argument Reference above.
    resolution string
    Resolution for an aggregated namespace.
    retentionBlockDataExpirationDuration string
    Controls how long we wait before expiring stale data.
    retentionBlockSizeDuration string
    Controls how long to keep a block in memory before flushing to a fileset on disk.
    retentionBufferFutureDuration string
    Controls how far into the future writes to the namespace will be accepted.
    retentionBufferPastDuration string
    Controls how far into the past writes to the namespace will be accepted.
    retentionPeriodDuration string
    Controls the duration of time that M3DB will retain data for the namespace.
    serviceName string
    See Argument Reference above.
    snapshotEnabled boolean
    SDefines whether M3db will create snapshot files for this namespace.
    type string
    Type of namespace.
    writesToCommitLogEnabled boolean
    Defines whether M3DB will include writes to this namespace in the commit log.
    cluster_id str
    See Argument Reference above.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    See Argument Reference above.
    resolution str
    Resolution for an aggregated namespace.
    retention_block_data_expiration_duration str
    Controls how long we wait before expiring stale data.
    retention_block_size_duration str
    Controls how long to keep a block in memory before flushing to a fileset on disk.
    retention_buffer_future_duration str
    Controls how far into the future writes to the namespace will be accepted.
    retention_buffer_past_duration str
    Controls how far into the past writes to the namespace will be accepted.
    retention_period_duration str
    Controls the duration of time that M3DB will retain data for the namespace.
    service_name str
    See Argument Reference above.
    snapshot_enabled bool
    SDefines whether M3db will create snapshot files for this namespace.
    type str
    Type of namespace.
    writes_to_commit_log_enabled bool
    Defines whether M3DB will include writes to this namespace in the commit log.
    clusterId String
    See Argument Reference above.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    See Argument Reference above.
    resolution String
    Resolution for an aggregated namespace.
    retentionBlockDataExpirationDuration String
    Controls how long we wait before expiring stale data.
    retentionBlockSizeDuration String
    Controls how long to keep a block in memory before flushing to a fileset on disk.
    retentionBufferFutureDuration String
    Controls how far into the future writes to the namespace will be accepted.
    retentionBufferPastDuration String
    Controls how far into the past writes to the namespace will be accepted.
    retentionPeriodDuration String
    Controls the duration of time that M3DB will retain data for the namespace.
    serviceName String
    See Argument Reference above.
    snapshotEnabled Boolean
    SDefines whether M3db will create snapshot files for this namespace.
    type String
    Type of namespace.
    writesToCommitLogEnabled Boolean
    Defines whether M3DB will include writes to this namespace in the commit log.

    Package Details

    Repository
    ovh ovh/pulumi-ovh
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ovh Terraform Provider.
    ovh logo
    OVHCloud v1.1.0 published on Thursday, Nov 21, 2024 by OVHcloud