Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Datadog Provider
  3. API Docs
  4. AppBuilderApp
Datadog v4.49.1 published on Saturday, Apr 26, 2025 by Pulumi
pulumi/pulumi-datadog

datadog.AppBuilderApp

Explore with Pulumi AI

datadog logo
Datadog v4.49.1 published on Saturday, Apr 26, 2025 by Pulumi
pulumi/pulumi-datadog

    Provides a Datadog App resource for creating and managing Datadog Apps from App Builder using the JSON definition.

    Create AppBuilderApp Resource

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

    Constructor syntax

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

@overload
def AppBuilderApp(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  app_json: Optional[str] = None,
                  action_query_names_to_connection_ids: Optional[Mapping[str, str]] = None,
                  description: Optional[str] = None,
                  name: Optional[str] = None,
                  published: Optional[bool] = None,
                  root_instance_name: Optional[str] = None)
    func NewAppBuilderApp(ctx *Context, name string, args AppBuilderAppArgs, opts ...ResourceOption) (*AppBuilderApp, error)
    public AppBuilderApp(string name, AppBuilderAppArgs args, CustomResourceOptions? opts = null)
    public AppBuilderApp(String name, AppBuilderAppArgs args)
public AppBuilderApp(String name, AppBuilderAppArgs args, CustomResourceOptions options)

    type: datadog:AppBuilderApp
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 AppBuilderAppArgs
    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 AppBuilderAppArgs
    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 AppBuilderAppArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AppBuilderAppArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AppBuilderAppArgs
    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 appBuilderAppResource = new Datadog.AppBuilderApp("appBuilderAppResource", new()
{
    AppJson = "string",
    ActionQueryNamesToConnectionIds = 
    {
        { "string", "string" },
    },
    Description = "string",
    Name = "string",
    Published = false,
    RootInstanceName = "string",
});

    example, err := datadog.NewAppBuilderApp(ctx, "appBuilderAppResource", &datadog.AppBuilderAppArgs{
	AppJson: pulumi.String("string"),
	ActionQueryNamesToConnectionIds: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description:      pulumi.String("string"),
	Name:             pulumi.String("string"),
	Published:        pulumi.Bool(false),
	RootInstanceName: pulumi.String("string"),
})

    var appBuilderAppResource = new AppBuilderApp("appBuilderAppResource", AppBuilderAppArgs.builder()
    .appJson("string")
    .actionQueryNamesToConnectionIds(Map.of("string", "string"))
    .description("string")
    .name("string")
    .published(false)
    .rootInstanceName("string")
    .build());

    app_builder_app_resource = datadog.AppBuilderApp("appBuilderAppResource",
    app_json="string",
    action_query_names_to_connection_ids={
        "string": "string",
    },
    description="string",
    name="string",
    published=False,
    root_instance_name="string")

    const appBuilderAppResource = new datadog.AppBuilderApp("appBuilderAppResource", {
    appJson: "string",
    actionQueryNamesToConnectionIds: {
        string: "string",
    },
    description: "string",
    name: "string",
    published: false,
    rootInstanceName: "string",
});

    type: datadog:AppBuilderApp
properties:
    actionQueryNamesToConnectionIds:
        string: string
    appJson: string
    description: string
    name: string
    published: false
    rootInstanceName: string

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

    AppJson string
    The JSON representation of the App. String length must be at least 1.
    ActionQueryNamesToConnectionIds Dictionary<string, string>
    If specified, this will override the Action Connection IDs for the specified Action Query Names in the App JSON. Otherwise, a map of the App's Action Query Names to Action Connection IDs will be returned in output.
    Description string
    If specified, this will override the human-readable description of the App in the App JSON. String length must be at least 1.
    Name string
    If specified, this will override the name of the App in the App JSON. String length must be at least 1.
    Published bool
    Set the app to published or unpublished. Published apps are available to other users. To ensure the app is accessible to the correct users, you also need to set a Restriction Policy on the app if a policy does not yet exist. Defaults to false.
    RootInstanceName string
    The name of the root component of the app. This must be a grid component that contains all other components. If specified, this will override the root instance name of the App in the App JSON. String length must be at least 1.
    AppJson string
    The JSON representation of the App. String length must be at least 1.
    ActionQueryNamesToConnectionIds map[string]string
    If specified, this will override the Action Connection IDs for the specified Action Query Names in the App JSON. Otherwise, a map of the App's Action Query Names to Action Connection IDs will be returned in output.
    Description string
    If specified, this will override the human-readable description of the App in the App JSON. String length must be at least 1.
    Name string
    If specified, this will override the name of the App in the App JSON. String length must be at least 1.
    Published bool
    Set the app to published or unpublished. Published apps are available to other users. To ensure the app is accessible to the correct users, you also need to set a Restriction Policy on the app if a policy does not yet exist. Defaults to false.
    RootInstanceName string
    The name of the root component of the app. This must be a grid component that contains all other components. If specified, this will override the root instance name of the App in the App JSON. String length must be at least 1.
    appJson String
    The JSON representation of the App. String length must be at least 1.
    actionQueryNamesToConnectionIds Map<String,String>
    If specified, this will override the Action Connection IDs for the specified Action Query Names in the App JSON. Otherwise, a map of the App's Action Query Names to Action Connection IDs will be returned in output.
    description String
    If specified, this will override the human-readable description of the App in the App JSON. String length must be at least 1.
    name String
    If specified, this will override the name of the App in the App JSON. String length must be at least 1.
    published Boolean
    Set the app to published or unpublished. Published apps are available to other users. To ensure the app is accessible to the correct users, you also need to set a Restriction Policy on the app if a policy does not yet exist. Defaults to false.
    rootInstanceName String
    The name of the root component of the app. This must be a grid component that contains all other components. If specified, this will override the root instance name of the App in the App JSON. String length must be at least 1.
    appJson string
    The JSON representation of the App. String length must be at least 1.
    actionQueryNamesToConnectionIds {[key: string]: string}
    If specified, this will override the Action Connection IDs for the specified Action Query Names in the App JSON. Otherwise, a map of the App's Action Query Names to Action Connection IDs will be returned in output.
    description string
    If specified, this will override the human-readable description of the App in the App JSON. String length must be at least 1.
    name string
    If specified, this will override the name of the App in the App JSON. String length must be at least 1.
    published boolean
    Set the app to published or unpublished. Published apps are available to other users. To ensure the app is accessible to the correct users, you also need to set a Restriction Policy on the app if a policy does not yet exist. Defaults to false.
    rootInstanceName string
    The name of the root component of the app. This must be a grid component that contains all other components. If specified, this will override the root instance name of the App in the App JSON. String length must be at least 1.
    app_json str
    The JSON representation of the App. String length must be at least 1.
    action_query_names_to_connection_ids Mapping[str, str]
    If specified, this will override the Action Connection IDs for the specified Action Query Names in the App JSON. Otherwise, a map of the App's Action Query Names to Action Connection IDs will be returned in output.
    description str
    If specified, this will override the human-readable description of the App in the App JSON. String length must be at least 1.
    name str
    If specified, this will override the name of the App in the App JSON. String length must be at least 1.
    published bool
    Set the app to published or unpublished. Published apps are available to other users. To ensure the app is accessible to the correct users, you also need to set a Restriction Policy on the app if a policy does not yet exist. Defaults to false.
    root_instance_name str
    The name of the root component of the app. This must be a grid component that contains all other components. If specified, this will override the root instance name of the App in the App JSON. String length must be at least 1.
    appJson String
    The JSON representation of the App. String length must be at least 1.
    actionQueryNamesToConnectionIds Map<String>
    If specified, this will override the Action Connection IDs for the specified Action Query Names in the App JSON. Otherwise, a map of the App's Action Query Names to Action Connection IDs will be returned in output.
    description String
    If specified, this will override the human-readable description of the App in the App JSON. String length must be at least 1.
    name String
    If specified, this will override the name of the App in the App JSON. String length must be at least 1.
    published Boolean
    Set the app to published or unpublished. Published apps are available to other users. To ensure the app is accessible to the correct users, you also need to set a Restriction Policy on the app if a policy does not yet exist. Defaults to false.
    rootInstanceName String
    The name of the root component of the app. This must be a grid component that contains all other components. If specified, this will override the root instance name of the App in the App JSON. String length must be at least 1.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AppBuilderApp Resource

    Get an existing AppBuilderApp 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?: AppBuilderAppState, opts?: CustomResourceOptions): AppBuilderApp
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action_query_names_to_connection_ids: Optional[Mapping[str, str]] = None,
        app_json: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        published: Optional[bool] = None,
        root_instance_name: Optional[str] = None) -> AppBuilderApp
    func GetAppBuilderApp(ctx *Context, name string, id IDInput, state *AppBuilderAppState, opts ...ResourceOption) (*AppBuilderApp, error)
    public static AppBuilderApp Get(string name, Input<string> id, AppBuilderAppState? state, CustomResourceOptions? opts = null)
    public static AppBuilderApp get(String name, Output<String> id, AppBuilderAppState state, CustomResourceOptions options)
    resources:  _:    type: datadog:AppBuilderApp    get:      id: ${id}
    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:
    ActionQueryNamesToConnectionIds Dictionary<string, string>
    If specified, this will override the Action Connection IDs for the specified Action Query Names in the App JSON. Otherwise, a map of the App's Action Query Names to Action Connection IDs will be returned in output.
    AppJson string
    The JSON representation of the App. String length must be at least 1.
    Description string
    If specified, this will override the human-readable description of the App in the App JSON. String length must be at least 1.
    Name string
    If specified, this will override the name of the App in the App JSON. String length must be at least 1.
    Published bool
    Set the app to published or unpublished. Published apps are available to other users. To ensure the app is accessible to the correct users, you also need to set a Restriction Policy on the app if a policy does not yet exist. Defaults to false.
    RootInstanceName string
    The name of the root component of the app. This must be a grid component that contains all other components. If specified, this will override the root instance name of the App in the App JSON. String length must be at least 1.
    ActionQueryNamesToConnectionIds map[string]string
    If specified, this will override the Action Connection IDs for the specified Action Query Names in the App JSON. Otherwise, a map of the App's Action Query Names to Action Connection IDs will be returned in output.
    AppJson string
    The JSON representation of the App. String length must be at least 1.
    Description string
    If specified, this will override the human-readable description of the App in the App JSON. String length must be at least 1.
    Name string
    If specified, this will override the name of the App in the App JSON. String length must be at least 1.
    Published bool
    Set the app to published or unpublished. Published apps are available to other users. To ensure the app is accessible to the correct users, you also need to set a Restriction Policy on the app if a policy does not yet exist. Defaults to false.
    RootInstanceName string
    The name of the root component of the app. This must be a grid component that contains all other components. If specified, this will override the root instance name of the App in the App JSON. String length must be at least 1.
    actionQueryNamesToConnectionIds Map<String,String>
    If specified, this will override the Action Connection IDs for the specified Action Query Names in the App JSON. Otherwise, a map of the App's Action Query Names to Action Connection IDs will be returned in output.
    appJson String
    The JSON representation of the App. String length must be at least 1.
    description String
    If specified, this will override the human-readable description of the App in the App JSON. String length must be at least 1.
    name String
    If specified, this will override the name of the App in the App JSON. String length must be at least 1.
    published Boolean
    Set the app to published or unpublished. Published apps are available to other users. To ensure the app is accessible to the correct users, you also need to set a Restriction Policy on the app if a policy does not yet exist. Defaults to false.
    rootInstanceName String
    The name of the root component of the app. This must be a grid component that contains all other components. If specified, this will override the root instance name of the App in the App JSON. String length must be at least 1.
    actionQueryNamesToConnectionIds {[key: string]: string}
    If specified, this will override the Action Connection IDs for the specified Action Query Names in the App JSON. Otherwise, a map of the App's Action Query Names to Action Connection IDs will be returned in output.
    appJson string
    The JSON representation of the App. String length must be at least 1.
    description string
    If specified, this will override the human-readable description of the App in the App JSON. String length must be at least 1.
    name string
    If specified, this will override the name of the App in the App JSON. String length must be at least 1.
    published boolean
    Set the app to published or unpublished. Published apps are available to other users. To ensure the app is accessible to the correct users, you also need to set a Restriction Policy on the app if a policy does not yet exist. Defaults to false.
    rootInstanceName string
    The name of the root component of the app. This must be a grid component that contains all other components. If specified, this will override the root instance name of the App in the App JSON. String length must be at least 1.
    action_query_names_to_connection_ids Mapping[str, str]
    If specified, this will override the Action Connection IDs for the specified Action Query Names in the App JSON. Otherwise, a map of the App's Action Query Names to Action Connection IDs will be returned in output.
    app_json str
    The JSON representation of the App. String length must be at least 1.
    description str
    If specified, this will override the human-readable description of the App in the App JSON. String length must be at least 1.
    name str
    If specified, this will override the name of the App in the App JSON. String length must be at least 1.
    published bool
    Set the app to published or unpublished. Published apps are available to other users. To ensure the app is accessible to the correct users, you also need to set a Restriction Policy on the app if a policy does not yet exist. Defaults to false.
    root_instance_name str
    The name of the root component of the app. This must be a grid component that contains all other components. If specified, this will override the root instance name of the App in the App JSON. String length must be at least 1.
    actionQueryNamesToConnectionIds Map<String>
    If specified, this will override the Action Connection IDs for the specified Action Query Names in the App JSON. Otherwise, a map of the App's Action Query Names to Action Connection IDs will be returned in output.
    appJson String
    The JSON representation of the App. String length must be at least 1.
    description String
    If specified, this will override the human-readable description of the App in the App JSON. String length must be at least 1.
    name String
    If specified, this will override the name of the App in the App JSON. String length must be at least 1.
    published Boolean
    Set the app to published or unpublished. Published apps are available to other users. To ensure the app is accessible to the correct users, you also need to set a Restriction Policy on the app if a policy does not yet exist. Defaults to false.
    rootInstanceName String
    The name of the root component of the app. This must be a grid component that contains all other components. If specified, this will override the root instance name of the App in the App JSON. String length must be at least 1.

    Import

    $ pulumi import datadog:index/appBuilderApp:AppBuilderApp my_app 11111111-2222-3333-4444-555555555555

    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.
    datadog logo
    Datadog v4.49.1 published on Saturday, Apr 26, 2025 by Pulumi
    pulumi/pulumi-datadog