Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aviatrix
  3. API Docs
  4. AviatrixDatadogAgent
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix
astipkovits/pulumi-aviatrix

aviatrix.AviatrixDatadogAgent

Explore with Pulumi AI

aviatrix logo
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix
astipkovits/pulumi-aviatrix

    The aviatrix_datadog_agent resource allows the enabling and disabling of datadog agent.

    Example Usage

    using System.Collections.Generic;
using Pulumi;
using Aviatrix = Pulumi.Aviatrix;

return await Deployment.RunAsync(() => 
{
    // Enable datadog agent
    var testDatadogAgent = new Aviatrix.AviatrixDatadogAgent("testDatadogAgent", new()
    {
        ApiKey = "your_api_key",
        ExcludedGateways = new[]
        {
            "a",
            "b",
        },
        Site = "datadoghq.com",
    });

});

    package main

import (
	"github.com/astipkovits/pulumi-aviatrix/sdk/go/aviatrix"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aviatrix.NewAviatrixDatadogAgent(ctx, "testDatadogAgent", &aviatrix.AviatrixDatadogAgentArgs{
			ApiKey: pulumi.String("your_api_key"),
			ExcludedGateways: pulumi.StringArray{
				pulumi.String("a"),
				pulumi.String("b"),
			},
			Site: pulumi.String("datadoghq.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aviatrix.AviatrixDatadogAgent;
import com.pulumi.aviatrix.AviatrixDatadogAgentArgs;
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) {
        var testDatadogAgent = new AviatrixDatadogAgent("testDatadogAgent", AviatrixDatadogAgentArgs.builder()        
            .apiKey("your_api_key")
            .excludedGateways(            
                "a",
                "b")
            .site("datadoghq.com")
            .build());

    }
}

    import pulumi
import pulumi_aviatrix as aviatrix

# Enable datadog agent
test_datadog_agent = aviatrix.AviatrixDatadogAgent("testDatadogAgent",
    api_key="your_api_key",
    excluded_gateways=[
        "a",
        "b",
    ],
    site="datadoghq.com")

    import * as pulumi from "@pulumi/pulumi";
import * as aviatrix from "@pulumi/aviatrix";

// Enable datadog agent
const testDatadogAgent = new aviatrix.AviatrixDatadogAgent("test_datadog_agent", {
    apiKey: "your_api_key",
    excludedGateways: [
        "a",
        "b",
    ],
    site: "datadoghq.com",
});

    resources:
  # Enable datadog agent
  testDatadogAgent:
    type: aviatrix:AviatrixDatadogAgent
    properties:
      apiKey: your_api_key
      excludedGateways:
        - a
        - b
      site: datadoghq.com

    Create AviatrixDatadogAgent Resource

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

    Constructor syntax

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

@overload
def AviatrixDatadogAgent(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         api_key: Optional[str] = None,
                         excluded_gateways: Optional[Sequence[str]] = None,
                         metrics_only: Optional[bool] = None,
                         site: Optional[str] = None)
    func NewAviatrixDatadogAgent(ctx *Context, name string, args AviatrixDatadogAgentArgs, opts ...ResourceOption) (*AviatrixDatadogAgent, error)
    public AviatrixDatadogAgent(string name, AviatrixDatadogAgentArgs args, CustomResourceOptions? opts = null)
    public AviatrixDatadogAgent(String name, AviatrixDatadogAgentArgs args)
public AviatrixDatadogAgent(String name, AviatrixDatadogAgentArgs args, CustomResourceOptions options)

    type: aviatrix:AviatrixDatadogAgent
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 AviatrixDatadogAgentArgs
    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 AviatrixDatadogAgentArgs
    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 AviatrixDatadogAgentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AviatrixDatadogAgentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AviatrixDatadogAgentArgs
    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 aviatrixDatadogAgentResource = new Aviatrix.AviatrixDatadogAgent("aviatrixDatadogAgentResource", new()
{
    ApiKey = "string",
    ExcludedGateways = new[]
    {
        "string",
    },
    MetricsOnly = false,
    Site = "string",
});

    example, err := aviatrix.NewAviatrixDatadogAgent(ctx, "aviatrixDatadogAgentResource", &aviatrix.AviatrixDatadogAgentArgs{
	ApiKey: pulumi.String("string"),
	ExcludedGateways: pulumi.StringArray{
		pulumi.String("string"),
	},
	MetricsOnly: pulumi.Bool(false),
	Site:        pulumi.String("string"),
})

    var aviatrixDatadogAgentResource = new AviatrixDatadogAgent("aviatrixDatadogAgentResource", AviatrixDatadogAgentArgs.builder()
    .apiKey("string")
    .excludedGateways("string")
    .metricsOnly(false)
    .site("string")
    .build());

    aviatrix_datadog_agent_resource = aviatrix.AviatrixDatadogAgent("aviatrixDatadogAgentResource",
    api_key="string",
    excluded_gateways=["string"],
    metrics_only=False,
    site="string")

    const aviatrixDatadogAgentResource = new aviatrix.AviatrixDatadogAgent("aviatrixDatadogAgentResource", {
    apiKey: "string",
    excludedGateways: ["string"],
    metricsOnly: false,
    site: "string",
});

    type: aviatrix:AviatrixDatadogAgent
properties:
    apiKey: string
    excludedGateways:
        - string
    metricsOnly: false
    site: string

    AviatrixDatadogAgent Resource Properties

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

    Inputs

    The AviatrixDatadogAgent resource accepts the following input properties:

    ApiKey string
    API key.
    ExcludedGateways List<string>
    List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
    MetricsOnly bool
    Only export metrics without exporting logs. False by default.
    Site string
    Site preference ("datadoghq.com" or" datadoghq.eu"). "datadoghq.com" by default.
    ApiKey string
    API key.
    ExcludedGateways []string
    List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
    MetricsOnly bool
    Only export metrics without exporting logs. False by default.
    Site string
    Site preference ("datadoghq.com" or" datadoghq.eu"). "datadoghq.com" by default.
    apiKey String
    API key.
    excludedGateways List<String>
    List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
    metricsOnly Boolean
    Only export metrics without exporting logs. False by default.
    site String
    Site preference ("datadoghq.com" or" datadoghq.eu"). "datadoghq.com" by default.
    apiKey string
    API key.
    excludedGateways string[]
    List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
    metricsOnly boolean
    Only export metrics without exporting logs. False by default.
    site string
    Site preference ("datadoghq.com" or" datadoghq.eu"). "datadoghq.com" by default.
    api_key str
    API key.
    excluded_gateways Sequence[str]
    List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
    metrics_only bool
    Only export metrics without exporting logs. False by default.
    site str
    Site preference ("datadoghq.com" or" datadoghq.eu"). "datadoghq.com" by default.
    apiKey String
    API key.
    excludedGateways List<String>
    List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
    metricsOnly Boolean
    Only export metrics without exporting logs. False by default.
    site String
    Site preference ("datadoghq.com" or" datadoghq.eu"). "datadoghq.com" by default.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of datadog agent.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of datadog agent.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of datadog agent.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The status of datadog agent.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The status of datadog agent.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of datadog agent.

    Look up Existing AviatrixDatadogAgent Resource

    Get an existing AviatrixDatadogAgent 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?: AviatrixDatadogAgentState, opts?: CustomResourceOptions): AviatrixDatadogAgent
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_key: Optional[str] = None,
        excluded_gateways: Optional[Sequence[str]] = None,
        metrics_only: Optional[bool] = None,
        site: Optional[str] = None,
        status: Optional[str] = None) -> AviatrixDatadogAgent
    func GetAviatrixDatadogAgent(ctx *Context, name string, id IDInput, state *AviatrixDatadogAgentState, opts ...ResourceOption) (*AviatrixDatadogAgent, error)
    public static AviatrixDatadogAgent Get(string name, Input<string> id, AviatrixDatadogAgentState? state, CustomResourceOptions? opts = null)
    public static AviatrixDatadogAgent get(String name, Output<String> id, AviatrixDatadogAgentState 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
    API key.
    ExcludedGateways List<string>
    List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
    MetricsOnly bool
    Only export metrics without exporting logs. False by default.
    Site string
    Site preference ("datadoghq.com" or" datadoghq.eu"). "datadoghq.com" by default.
    Status string
    The status of datadog agent.
    ApiKey string
    API key.
    ExcludedGateways []string
    List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
    MetricsOnly bool
    Only export metrics without exporting logs. False by default.
    Site string
    Site preference ("datadoghq.com" or" datadoghq.eu"). "datadoghq.com" by default.
    Status string
    The status of datadog agent.
    apiKey String
    API key.
    excludedGateways List<String>
    List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
    metricsOnly Boolean
    Only export metrics without exporting logs. False by default.
    site String
    Site preference ("datadoghq.com" or" datadoghq.eu"). "datadoghq.com" by default.
    status String
    The status of datadog agent.
    apiKey string
    API key.
    excludedGateways string[]
    List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
    metricsOnly boolean
    Only export metrics without exporting logs. False by default.
    site string
    Site preference ("datadoghq.com" or" datadoghq.eu"). "datadoghq.com" by default.
    status string
    The status of datadog agent.
    api_key str
    API key.
    excluded_gateways Sequence[str]
    List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
    metrics_only bool
    Only export metrics without exporting logs. False by default.
    site str
    Site preference ("datadoghq.com" or" datadoghq.eu"). "datadoghq.com" by default.
    status str
    The status of datadog agent.
    apiKey String
    API key.
    excludedGateways List<String>
    List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
    metricsOnly Boolean
    Only export metrics without exporting logs. False by default.
    site String
    Site preference ("datadoghq.com" or" datadoghq.eu"). "datadoghq.com" by default.
    status String
    The status of datadog agent.

    Import

    datadog_agent can be imported using “datadog_agent”, e.g.

     $ pulumi import aviatrix:index/aviatrixDatadogAgent:AviatrixDatadogAgent test datadog_agent

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    aviatrix astipkovits/pulumi-aviatrix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aviatrix Terraform Provider.
    aviatrix logo
    Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix
    astipkovits/pulumi-aviatrix