Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. CockroachDB Cloud
  3. API Docs
  4. MetricExportDatadogConfig
CockroachDB v0.6.0 published on Friday, Nov 1, 2024 by pulumiverse
pulumiverse/pulumi-cockroach

cockroach.MetricExportDatadogConfig

Explore with Pulumi AI

cockroach logo
CockroachDB v0.6.0 published on Friday, Nov 1, 2024 by pulumiverse
pulumiverse/pulumi-cockroach

    DataDog metric export configuration for a cluster.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as cockroach from "@pulumiverse/cockroach";

const config = new pulumi.Config();
const clusterId = config.require("clusterId");
const datadogSite = config.require("datadogSite");
const datadogApiKey = config.require("datadogApiKey");
const example = new cockroach.MetricExportDatadogConfig("example", {
    clusterId: clusterId,
    site: datadogSite,
    apiKey: datadogApiKey,
});

    import pulumi
import pulumiverse_cockroach as cockroach

config = pulumi.Config()
cluster_id = config.require("clusterId")
datadog_site = config.require("datadogSite")
datadog_api_key = config.require("datadogApiKey")
example = cockroach.MetricExportDatadogConfig("example",
    cluster_id=cluster_id,
    site=datadog_site,
    api_key=datadog_api_key)

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
	"github.com/pulumiverse/pulumi-cockroach/sdk/go/cockroach"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		clusterId := cfg.Require("clusterId")
		datadogSite := cfg.Require("datadogSite")
		datadogApiKey := cfg.Require("datadogApiKey")
		_, err := cockroach.NewMetricExportDatadogConfig(ctx, "example", &cockroach.MetricExportDatadogConfigArgs{
			ClusterId: pulumi.String(clusterId),
			Site:      pulumi.String(datadogSite),
			ApiKey:    pulumi.String(datadogApiKey),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cockroach = Pulumiverse.Cockroach;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var clusterId = config.Require("clusterId");
    var datadogSite = config.Require("datadogSite");
    var datadogApiKey = config.Require("datadogApiKey");
    var example = new Cockroach.MetricExportDatadogConfig("example", new()
    {
        ClusterId = clusterId,
        Site = datadogSite,
        ApiKey = datadogApiKey,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cockroach.MetricExportDatadogConfig;
import com.pulumi.cockroach.MetricExportDatadogConfigArgs;
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 config = ctx.config();
        final var clusterId = config.get("clusterId");
        final var datadogSite = config.get("datadogSite");
        final var datadogApiKey = config.get("datadogApiKey");
        var example = new MetricExportDatadogConfig("example", MetricExportDatadogConfigArgs.builder()
            .clusterId(clusterId)
            .site(datadogSite)
            .apiKey(datadogApiKey)
            .build());

    }
}

    configuration:
  clusterId:
    type: string
  datadogSite:
    type: string
  datadogApiKey:
    type: string
resources:
  example:
    type: cockroach:MetricExportDatadogConfig
    properties:
      clusterId: ${clusterId}
      site: ${datadogSite}
      apiKey: ${datadogApiKey}

    Create MetricExportDatadogConfig Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new MetricExportDatadogConfig(name: string, args: MetricExportDatadogConfigArgs, opts?: CustomResourceOptions);
    @overload
def MetricExportDatadogConfig(resource_name: str,
                              args: MetricExportDatadogConfigArgs,
                              opts: Optional[ResourceOptions] = None)

@overload
def MetricExportDatadogConfig(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              api_key: Optional[str] = None,
                              cluster_id: Optional[str] = None,
                              site: Optional[str] = None)
    func NewMetricExportDatadogConfig(ctx *Context, name string, args MetricExportDatadogConfigArgs, opts ...ResourceOption) (*MetricExportDatadogConfig, error)
    public MetricExportDatadogConfig(string name, MetricExportDatadogConfigArgs args, CustomResourceOptions? opts = null)
    public MetricExportDatadogConfig(String name, MetricExportDatadogConfigArgs args)
public MetricExportDatadogConfig(String name, MetricExportDatadogConfigArgs args, CustomResourceOptions options)

    type: cockroach:MetricExportDatadogConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args MetricExportDatadogConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args MetricExportDatadogConfigArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args MetricExportDatadogConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MetricExportDatadogConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MetricExportDatadogConfigArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var metricExportDatadogConfigResource = new Cockroach.MetricExportDatadogConfig("metricExportDatadogConfigResource", new()
{
    ApiKey = "string",
    ClusterId = "string",
    Site = "string",
});

    example, err := cockroach.NewMetricExportDatadogConfig(ctx, "metricExportDatadogConfigResource", &cockroach.MetricExportDatadogConfigArgs{
	ApiKey:    pulumi.String("string"),
	ClusterId: pulumi.String("string"),
	Site:      pulumi.String("string"),
})

    var metricExportDatadogConfigResource = new MetricExportDatadogConfig("metricExportDatadogConfigResource", MetricExportDatadogConfigArgs.builder()
    .apiKey("string")
    .clusterId("string")
    .site("string")
    .build());

    metric_export_datadog_config_resource = cockroach.MetricExportDatadogConfig("metricExportDatadogConfigResource",
    api_key="string",
    cluster_id="string",
    site="string")

    const metricExportDatadogConfigResource = new cockroach.MetricExportDatadogConfig("metricExportDatadogConfigResource", {
    apiKey: "string",
    clusterId: "string",
    site: "string",
});

    type: cockroach:MetricExportDatadogConfig
properties:
    apiKey: string
    clusterId: string
    site: string

    MetricExportDatadogConfig Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The MetricExportDatadogConfig resource accepts the following input properties:

    ApiKey string
    A Datadog API key.
    ClusterId string
    Cluster ID.
    Site string
    The Datadog region to export to.
    ApiKey string
    A Datadog API key.
    ClusterId string
    Cluster ID.
    Site string
    The Datadog region to export to.
    apiKey String
    A Datadog API key.
    clusterId String
    Cluster ID.
    site String
    The Datadog region to export to.
    apiKey string
    A Datadog API key.
    clusterId string
    Cluster ID.
    site string
    The Datadog region to export to.
    api_key str
    A Datadog API key.
    cluster_id str
    Cluster ID.
    site str
    The Datadog region to export to.
    apiKey String
    A Datadog API key.
    clusterId String
    Cluster ID.
    site String
    The Datadog region to export to.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the MetricExportDatadogConfig resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Encodes the possible states that a metric export configuration can be in as it is created, deployed, and disabled.
    UserMessage string
    Elaborates on the metric export status and hints at how to fix issues that may have occurred during asynchronous operations.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Encodes the possible states that a metric export configuration can be in as it is created, deployed, and disabled.
    UserMessage string
    Elaborates on the metric export status and hints at how to fix issues that may have occurred during asynchronous operations.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Encodes the possible states that a metric export configuration can be in as it is created, deployed, and disabled.
    userMessage String
    Elaborates on the metric export status and hints at how to fix issues that may have occurred during asynchronous operations.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Encodes the possible states that a metric export configuration can be in as it is created, deployed, and disabled.
    userMessage string
    Elaborates on the metric export status and hints at how to fix issues that may have occurred during asynchronous operations.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    Encodes the possible states that a metric export configuration can be in as it is created, deployed, and disabled.
    user_message str
    Elaborates on the metric export status and hints at how to fix issues that may have occurred during asynchronous operations.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Encodes the possible states that a metric export configuration can be in as it is created, deployed, and disabled.
    userMessage String
    Elaborates on the metric export status and hints at how to fix issues that may have occurred during asynchronous operations.

    Look up Existing MetricExportDatadogConfig Resource

    Get an existing MetricExportDatadogConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: MetricExportDatadogConfigState, opts?: CustomResourceOptions): MetricExportDatadogConfig
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_key: Optional[str] = None,
        cluster_id: Optional[str] = None,
        site: Optional[str] = None,
        status: Optional[str] = None,
        user_message: Optional[str] = None) -> MetricExportDatadogConfig
    func GetMetricExportDatadogConfig(ctx *Context, name string, id IDInput, state *MetricExportDatadogConfigState, opts ...ResourceOption) (*MetricExportDatadogConfig, error)
    public static MetricExportDatadogConfig Get(string name, Input<string> id, MetricExportDatadogConfigState? state, CustomResourceOptions? opts = null)
    public static MetricExportDatadogConfig get(String name, Output<String> id, MetricExportDatadogConfigState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApiKey string
    A Datadog API key.
    ClusterId string
    Cluster ID.
    Site string
    The Datadog region to export to.
    Status string
    Encodes the possible states that a metric export configuration can be in as it is created, deployed, and disabled.
    UserMessage string
    Elaborates on the metric export status and hints at how to fix issues that may have occurred during asynchronous operations.
    ApiKey string
    A Datadog API key.
    ClusterId string
    Cluster ID.
    Site string
    The Datadog region to export to.
    Status string
    Encodes the possible states that a metric export configuration can be in as it is created, deployed, and disabled.
    UserMessage string
    Elaborates on the metric export status and hints at how to fix issues that may have occurred during asynchronous operations.
    apiKey String
    A Datadog API key.
    clusterId String
    Cluster ID.
    site String
    The Datadog region to export to.
    status String
    Encodes the possible states that a metric export configuration can be in as it is created, deployed, and disabled.
    userMessage String
    Elaborates on the metric export status and hints at how to fix issues that may have occurred during asynchronous operations.
    apiKey string
    A Datadog API key.
    clusterId string
    Cluster ID.
    site string
    The Datadog region to export to.
    status string
    Encodes the possible states that a metric export configuration can be in as it is created, deployed, and disabled.
    userMessage string
    Elaborates on the metric export status and hints at how to fix issues that may have occurred during asynchronous operations.
    api_key str
    A Datadog API key.
    cluster_id str
    Cluster ID.
    site str
    The Datadog region to export to.
    status str
    Encodes the possible states that a metric export configuration can be in as it is created, deployed, and disabled.
    user_message str
    Elaborates on the metric export status and hints at how to fix issues that may have occurred during asynchronous operations.
    apiKey String
    A Datadog API key.
    clusterId String
    Cluster ID.
    site String
    The Datadog region to export to.
    status String
    Encodes the possible states that a metric export configuration can be in as it is created, deployed, and disabled.
    userMessage String
    Elaborates on the metric export status and hints at how to fix issues that may have occurred during asynchronous operations.

    Package Details

    Repository
    cockroach pulumiverse/pulumi-cockroach
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cockroach Terraform Provider.
    cockroach logo
    CockroachDB v0.6.0 published on Friday, Nov 1, 2024 by pulumiverse
    pulumiverse/pulumi-cockroach