datadog.OpenapiApi

Deprecated: use the datadog.SoftwareCatalog resource instead. Provides a Datadog OpenAPI resource. This can be used to synchronize Datadog’s API catalog with an OpenAPI specifications file.

Create OpenapiApi Resource

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

Constructor syntax

new OpenapiApi(name: string, args: OpenapiApiArgs, opts?: CustomResourceOptions);

@overload
def OpenapiApi(resource_name: str,
               args: OpenapiApiArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def OpenapiApi(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               spec: Optional[str] = None)

func NewOpenapiApi(ctx *Context, name string, args OpenapiApiArgs, opts ...ResourceOption) (*OpenapiApi, error)

public OpenapiApi(string name, OpenapiApiArgs args, CustomResourceOptions? opts = null)

public OpenapiApi(String name, OpenapiApiArgs args)
public OpenapiApi(String name, OpenapiApiArgs args, CustomResourceOptions options)

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

Parameters

Constructor example

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

var openapiApiResource = new Datadog.OpenapiApi("openapiApiResource", new()
{
    Spec = "string",
});

example, err := datadog.NewOpenapiApi(ctx, "openapiApiResource", &datadog.OpenapiApiArgs{
	Spec: pulumi.String("string"),
})

var openapiApiResource = new OpenapiApi("openapiApiResource", OpenapiApiArgs.builder()
    .spec("string")
    .build());

openapi_api_resource = datadog.OpenapiApi("openapiApiResource", spec="string")

const openapiApiResource = new datadog.OpenapiApi("openapiApiResource", {spec: "string"});

type: datadog:OpenapiApi
properties:
    spec: string

OpenapiApi 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 OpenapiApi resource accepts the following input properties:

Outputs

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

Look up Existing OpenapiApi Resource

Get an existing OpenapiApi 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?: OpenapiApiState, opts?: CustomResourceOptions): OpenapiApi

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        spec: Optional[str] = None) -> OpenapiApi

func GetOpenapiApi(ctx *Context, name string, id IDInput, state *OpenapiApiState, opts ...ResourceOption) (*OpenapiApi, error)

public static OpenapiApi Get(string name, Input<string> id, OpenapiApiState? state, CustomResourceOptions? opts = null)

public static OpenapiApi get(String name, Output<String> id, OpenapiApiState state, CustomResourceOptions options)

resources:  _:    type: datadog:OpenapiApi    get:      id: ${id}

Import

$ pulumi import datadog:index/openapiApi:OpenapiApi new_list "90646597-5fdb-4a17-a240-647003f8c028"

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

Package Details

Repository

Datadog pulumi/pulumi-datadog

License

Apache-2.0

Notes

This Pulumi package is based on the datadog Terraform Provider.