Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Google Cloud (GCP) Classic
  4. API Docs
  5. apigee
  6. EnvironmentDebugmask
Viewing docs for Google Cloud v9.29.0
published on Wednesday, Jun 24, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

gcp.apigee.EnvironmentDebugmask

gcp logo
Viewing docs for Google Cloud v9.29.0
published on Wednesday, Jun 24, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

    Manages the debug mask singleton for an Apigee environment. The debug mask configuration restricts which data is captured (masked) in API proxy debug sessions for an environment.

    The debug mask always exists for every environment and cannot be created or deleted through the API. Terraform manages it via GET/PATCH on the environment’s debugmask sub-resource. Creating the resource sets the configured masks, and destroying it clears all masks.

    To get more information about EnvironmentDebugmask, see:

    Example Usage

    Apigee Environment Debugmask Basic

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

const debugmask = new gcp.apigee.EnvironmentDebugmask("debugmask", {
    envId: apigeeEnv.id,
    requestXPaths: ["/request/headers/header[@name=\"x-secret\"]"],
    responseXPaths: ["/response/body/token"],
    variables: ["request.header.apikey"],
});

    import pulumi
import pulumi_gcp as gcp

debugmask = gcp.apigee.EnvironmentDebugmask("debugmask",
    env_id=apigee_env["id"],
    request_x_paths=["/request/headers/header[@name=\"x-secret\"]"],
    response_x_paths=["/response/body/token"],
    variables=["request.header.apikey"])

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/apigee"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigee.NewEnvironmentDebugmask(ctx, "debugmask", &apigee.EnvironmentDebugmaskArgs{
			EnvId: pulumi.Any(apigeeEnv.Id),
			RequestXPaths: pulumi.StringArray{
				pulumi.String("/request/headers/header[@name=\"x-secret\"]"),
			},
			ResponseXPaths: pulumi.StringArray{
				pulumi.String("/response/body/token"),
			},
			Variables: pulumi.StringArray{
				pulumi.String("request.header.apikey"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var debugmask = new Gcp.Apigee.EnvironmentDebugmask("debugmask", new()
    {
        EnvId = apigeeEnv.Id,
        RequestXPaths = new[]
        {
            "/request/headers/header[@name=\"x-secret\"]",
        },
        ResponseXPaths = new[]
        {
            "/response/body/token",
        },
        Variables = new[]
        {
            "request.header.apikey",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.apigee.EnvironmentDebugmask;
import com.pulumi.gcp.apigee.EnvironmentDebugmaskArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 debugmask = new EnvironmentDebugmask("debugmask", EnvironmentDebugmaskArgs.builder()
            .envId(apigeeEnv.id())
            .requestXPaths("/request/headers/header[@name=\"x-secret\"]")
            .responseXPaths("/response/body/token")
            .variables("request.header.apikey")
            .build());

    }
}

    resources:
  debugmask:
    type: gcp:apigee:EnvironmentDebugmask
    properties:
      envId: ${apigeeEnv.id}
      requestXPaths:
        - /request/headers/header[@name="x-secret"]
      responseXPaths:
        - /response/body/token
      variables:
        - request.header.apikey

    pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_apigee_environmentdebugmask" "debugmask" {
  env_id           = apigeeEnv.id
  request_x_paths  = ["/request/headers/header[@name=\"x-secret\"]"]
  response_x_paths = ["/response/body/token"]
  variables        = ["request.header.apikey"]
}

    Apigee Environment Debugmask Full

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

const debugmask = new gcp.apigee.EnvironmentDebugmask("debugmask", {
    envId: apigeeEnv.id,
    requestXPaths: [
        "/request/headers/header[@name=\"x-secret\"]",
        "/request/body/password",
    ],
    responseXPaths: ["/response/body/token"],
    faultXPaths: ["/fault/faultstring"],
    requestJsonPaths: ["$.store.book[*].author"],
    responseJsonPaths: ["$.store.book[*].price"],
    variables: [
        "request.header.apikey",
        "request.header.x-token",
    ],
    namespaces: {
        ns: "http://example.com",
    },
});

    import pulumi
import pulumi_gcp as gcp

debugmask = gcp.apigee.EnvironmentDebugmask("debugmask",
    env_id=apigee_env["id"],
    request_x_paths=[
        "/request/headers/header[@name=\"x-secret\"]",
        "/request/body/password",
    ],
    response_x_paths=["/response/body/token"],
    fault_x_paths=["/fault/faultstring"],
    request_json_paths=["$.store.book[*].author"],
    response_json_paths=["$.store.book[*].price"],
    variables=[
        "request.header.apikey",
        "request.header.x-token",
    ],
    namespaces={
        "ns": "http://example.com",
    })

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/apigee"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigee.NewEnvironmentDebugmask(ctx, "debugmask", &apigee.EnvironmentDebugmaskArgs{
			EnvId: pulumi.Any(apigeeEnv.Id),
			RequestXPaths: pulumi.StringArray{
				pulumi.String("/request/headers/header[@name=\"x-secret\"]"),
				pulumi.String("/request/body/password"),
			},
			ResponseXPaths: pulumi.StringArray{
				pulumi.String("/response/body/token"),
			},
			FaultXPaths: pulumi.StringArray{
				pulumi.String("/fault/faultstring"),
			},
			RequestJsonPaths: pulumi.StringArray{
				pulumi.String("$.store.book[*].author"),
			},
			ResponseJsonPaths: pulumi.StringArray{
				pulumi.String("$.store.book[*].price"),
			},
			Variables: pulumi.StringArray{
				pulumi.String("request.header.apikey"),
				pulumi.String("request.header.x-token"),
			},
			Namespaces: pulumi.StringMap{
				"ns": pulumi.String("http://example.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var debugmask = new Gcp.Apigee.EnvironmentDebugmask("debugmask", new()
    {
        EnvId = apigeeEnv.Id,
        RequestXPaths = new[]
        {
            "/request/headers/header[@name=\"x-secret\"]",
            "/request/body/password",
        },
        ResponseXPaths = new[]
        {
            "/response/body/token",
        },
        FaultXPaths = new[]
        {
            "/fault/faultstring",
        },
        RequestJsonPaths = new[]
        {
            "$.store.book[*].author",
        },
        ResponseJsonPaths = new[]
        {
            "$.store.book[*].price",
        },
        Variables = new[]
        {
            "request.header.apikey",
            "request.header.x-token",
        },
        Namespaces = 
        {
            { "ns", "http://example.com" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.apigee.EnvironmentDebugmask;
import com.pulumi.gcp.apigee.EnvironmentDebugmaskArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 debugmask = new EnvironmentDebugmask("debugmask", EnvironmentDebugmaskArgs.builder()
            .envId(apigeeEnv.id())
            .requestXPaths(            
                "/request/headers/header[@name=\"x-secret\"]",
                "/request/body/password")
            .responseXPaths("/response/body/token")
            .faultXPaths("/fault/faultstring")
            .requestJsonPaths("$.store.book[*].author")
            .responseJsonPaths("$.store.book[*].price")
            .variables(            
                "request.header.apikey",
                "request.header.x-token")
            .namespaces(Map.of("ns", "http://example.com"))
            .build());

    }
}

    resources:
  debugmask:
    type: gcp:apigee:EnvironmentDebugmask
    properties:
      envId: ${apigeeEnv.id}
      requestXPaths:
        - /request/headers/header[@name="x-secret"]
        - /request/body/password
      responseXPaths:
        - /response/body/token
      faultXPaths:
        - /fault/faultstring
      requestJsonPaths:
        - $.store.book[*].author
      responseJsonPaths:
        - $.store.book[*].price
      variables:
        - request.header.apikey
        - request.header.x-token
      namespaces:
        ns: http://example.com

    pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_apigee_environmentdebugmask" "debugmask" {
  env_id              = apigeeEnv.id
  request_x_paths     = ["/request/headers/header[@name=\"x-secret\"]", "/request/body/password"]
  response_x_paths    = ["/response/body/token"]
  fault_x_paths       = ["/fault/faultstring"]
  request_json_paths  = ["$.store.book[*].author"]
  response_json_paths = ["$.store.book[*].price"]
  variables           = ["request.header.apikey", "request.header.x-token"]
  namespaces = {
    "ns" = "http://example.com"
  }
}

    Create EnvironmentDebugmask Resource

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

    Constructor syntax

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

@overload
def EnvironmentDebugmask(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         env_id: Optional[str] = None,
                         fault_x_paths: Optional[Sequence[str]] = None,
                         namespaces: Optional[Mapping[str, str]] = None,
                         request_json_paths: Optional[Sequence[str]] = None,
                         request_x_paths: Optional[Sequence[str]] = None,
                         response_json_paths: Optional[Sequence[str]] = None,
                         response_x_paths: Optional[Sequence[str]] = None,
                         variables: Optional[Sequence[str]] = None)
    func NewEnvironmentDebugmask(ctx *Context, name string, args EnvironmentDebugmaskArgs, opts ...ResourceOption) (*EnvironmentDebugmask, error)
    public EnvironmentDebugmask(string name, EnvironmentDebugmaskArgs args, CustomResourceOptions? opts = null)
    public EnvironmentDebugmask(String name, EnvironmentDebugmaskArgs args)
public EnvironmentDebugmask(String name, EnvironmentDebugmaskArgs args, CustomResourceOptions options)

    type: gcp:apigee:EnvironmentDebugmask
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "gcp_apigee_environmentdebugmask" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args EnvironmentDebugmaskArgs
    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 EnvironmentDebugmaskArgs
    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 EnvironmentDebugmaskArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EnvironmentDebugmaskArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EnvironmentDebugmaskArgs
    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 environmentDebugmaskResource = new Gcp.Apigee.EnvironmentDebugmask("environmentDebugmaskResource", new()
{
    EnvId = "string",
    FaultXPaths = new[]
    {
        "string",
    },
    Namespaces = 
    {
        { "string", "string" },
    },
    RequestJsonPaths = new[]
    {
        "string",
    },
    RequestXPaths = new[]
    {
        "string",
    },
    ResponseJsonPaths = new[]
    {
        "string",
    },
    ResponseXPaths = new[]
    {
        "string",
    },
    Variables = new[]
    {
        "string",
    },
});

    example, err := apigee.NewEnvironmentDebugmask(ctx, "environmentDebugmaskResource", &apigee.EnvironmentDebugmaskArgs{
	EnvId: pulumi.String("string"),
	FaultXPaths: pulumi.StringArray{
		pulumi.String("string"),
	},
	Namespaces: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	RequestJsonPaths: pulumi.StringArray{
		pulumi.String("string"),
	},
	RequestXPaths: pulumi.StringArray{
		pulumi.String("string"),
	},
	ResponseJsonPaths: pulumi.StringArray{
		pulumi.String("string"),
	},
	ResponseXPaths: pulumi.StringArray{
		pulumi.String("string"),
	},
	Variables: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    resource "gcp_apigee_environmentdebugmask" "environmentDebugmaskResource" {
  env_id        = "string"
  fault_x_paths = ["string"]
  namespaces = {
    "string" = "string"
  }
  request_json_paths  = ["string"]
  request_x_paths     = ["string"]
  response_json_paths = ["string"]
  response_x_paths    = ["string"]
  variables           = ["string"]
}

    var environmentDebugmaskResource = new EnvironmentDebugmask("environmentDebugmaskResource", EnvironmentDebugmaskArgs.builder()
    .envId("string")
    .faultXPaths("string")
    .namespaces(Map.of("string", "string"))
    .requestJsonPaths("string")
    .requestXPaths("string")
    .responseJsonPaths("string")
    .responseXPaths("string")
    .variables("string")
    .build());

    environment_debugmask_resource = gcp.apigee.EnvironmentDebugmask("environmentDebugmaskResource",
    env_id="string",
    fault_x_paths=["string"],
    namespaces={
        "string": "string",
    },
    request_json_paths=["string"],
    request_x_paths=["string"],
    response_json_paths=["string"],
    response_x_paths=["string"],
    variables=["string"])

    const environmentDebugmaskResource = new gcp.apigee.EnvironmentDebugmask("environmentDebugmaskResource", {
    envId: "string",
    faultXPaths: ["string"],
    namespaces: {
        string: "string",
    },
    requestJsonPaths: ["string"],
    requestXPaths: ["string"],
    responseJsonPaths: ["string"],
    responseXPaths: ["string"],
    variables: ["string"],
});

    type: gcp:apigee:EnvironmentDebugmask
properties:
    envId: string
    faultXPaths:
        - string
    namespaces:
        string: string
    requestJsonPaths:
        - string
    requestXPaths:
        - string
    responseJsonPaths:
        - string
    responseXPaths:
        - string
    variables:
        - string

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

    EnvId string
    The Apigee environment associated with the debug mask, in the format organizations/{{org_name}}/environments/{{env_name}}.

    FaultXPaths List<string>
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for fault messages.
    Namespaces Dictionary<string, string>
    Map of namespace prefixes to URIs used to evaluate the configured XPath expressions.
    RequestJsonPaths List<string>
    List of JSONPath expressions that specify the JSON elements or attributes that the debug mask applies to for request messages.
    RequestXPaths List<string>
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for request messages.
    ResponseJsonPaths List<string>
    List of JSONPath expressions that specify the JSON elements or attributes that the debug mask applies to for response messages.
    ResponseXPaths List<string>
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for response messages.
    Variables List<string>
    List of flow variables that the debug mask applies to.
    EnvId string
    The Apigee environment associated with the debug mask, in the format organizations/{{org_name}}/environments/{{env_name}}.

    FaultXPaths []string
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for fault messages.
    Namespaces map[string]string
    Map of namespace prefixes to URIs used to evaluate the configured XPath expressions.
    RequestJsonPaths []string
    List of JSONPath expressions that specify the JSON elements or attributes that the debug mask applies to for request messages.
    RequestXPaths []string
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for request messages.
    ResponseJsonPaths []string
    List of JSONPath expressions that specify the JSON elements or attributes that the debug mask applies to for response messages.
    ResponseXPaths []string
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for response messages.
    Variables []string
    List of flow variables that the debug mask applies to.
    env_id string
    The Apigee environment associated with the debug mask, in the format organizations/{{org_name}}/environments/{{env_name}}.

    fault_x_paths list(string)
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for fault messages.
    namespaces map(string)
    Map of namespace prefixes to URIs used to evaluate the configured XPath expressions.
    request_json_paths list(string)
    List of JSONPath expressions that specify the JSON elements or attributes that the debug mask applies to for request messages.
    request_x_paths list(string)
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for request messages.
    response_json_paths list(string)
    List of JSONPath expressions that specify the JSON elements or attributes that the debug mask applies to for response messages.
    response_x_paths list(string)
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for response messages.
    variables list(string)
    List of flow variables that the debug mask applies to.
    envId String
    The Apigee environment associated with the debug mask, in the format organizations/{{org_name}}/environments/{{env_name}}.

    faultXPaths List<String>
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for fault messages.
    namespaces Map<String,String>
    Map of namespace prefixes to URIs used to evaluate the configured XPath expressions.
    requestJsonPaths List<String>
    List of JSONPath expressions that specify the JSON elements or attributes that the debug mask applies to for request messages.
    requestXPaths List<String>
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for request messages.
    responseJsonPaths List<String>
    List of JSONPath expressions that specify the JSON elements or attributes that the debug mask applies to for response messages.
    responseXPaths List<String>
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for response messages.
    variables List<String>
    List of flow variables that the debug mask applies to.
    envId string
    The Apigee environment associated with the debug mask, in the format organizations/{{org_name}}/environments/{{env_name}}.

    faultXPaths string[]
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for fault messages.
    namespaces {[key: string]: string}
    Map of namespace prefixes to URIs used to evaluate the configured XPath expressions.
    requestJsonPaths string[]
    List of JSONPath expressions that specify the JSON elements or attributes that the debug mask applies to for request messages.
    requestXPaths string[]
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for request messages.
    responseJsonPaths string[]
    List of JSONPath expressions that specify the JSON elements or attributes that the debug mask applies to for response messages.
    responseXPaths string[]
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for response messages.
    variables string[]
    List of flow variables that the debug mask applies to.
    env_id str
    The Apigee environment associated with the debug mask, in the format organizations/{{org_name}}/environments/{{env_name}}.

    fault_x_paths Sequence[str]
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for fault messages.
    namespaces Mapping[str, str]
    Map of namespace prefixes to URIs used to evaluate the configured XPath expressions.
    request_json_paths Sequence[str]
    List of JSONPath expressions that specify the JSON elements or attributes that the debug mask applies to for request messages.
    request_x_paths Sequence[str]
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for request messages.
    response_json_paths Sequence[str]
    List of JSONPath expressions that specify the JSON elements or attributes that the debug mask applies to for response messages.
    response_x_paths Sequence[str]
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for response messages.
    variables Sequence[str]
    List of flow variables that the debug mask applies to.
    envId String
    The Apigee environment associated with the debug mask, in the format organizations/{{org_name}}/environments/{{env_name}}.

    faultXPaths List<String>
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for fault messages.
    namespaces Map<String>
    Map of namespace prefixes to URIs used to evaluate the configured XPath expressions.
    requestJsonPaths List<String>
    List of JSONPath expressions that specify the JSON elements or attributes that the debug mask applies to for request messages.
    requestXPaths List<String>
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for request messages.
    responseJsonPaths List<String>
    List of JSONPath expressions that specify the JSON elements or attributes that the debug mask applies to for response messages.
    responseXPaths List<String>
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for response messages.
    variables List<String>
    List of flow variables that the debug mask applies to.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The fully qualified name of the debug mask, in the format organizations/{{org_name}}/environments/{{env_name}}/debugmask.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The fully qualified name of the debug mask, in the format organizations/{{org_name}}/environments/{{env_name}}/debugmask.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The fully qualified name of the debug mask, in the format organizations/{{org_name}}/environments/{{env_name}}/debugmask.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The fully qualified name of the debug mask, in the format organizations/{{org_name}}/environments/{{env_name}}/debugmask.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The fully qualified name of the debug mask, in the format organizations/{{org_name}}/environments/{{env_name}}/debugmask.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The fully qualified name of the debug mask, in the format organizations/{{org_name}}/environments/{{env_name}}/debugmask.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The fully qualified name of the debug mask, in the format organizations/{{org_name}}/environments/{{env_name}}/debugmask.

    Look up Existing EnvironmentDebugmask Resource

    Get an existing EnvironmentDebugmask 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?: EnvironmentDebugmaskState, opts?: CustomResourceOptions): EnvironmentDebugmask
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        env_id: Optional[str] = None,
        fault_x_paths: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        namespaces: Optional[Mapping[str, str]] = None,
        request_json_paths: Optional[Sequence[str]] = None,
        request_x_paths: Optional[Sequence[str]] = None,
        response_json_paths: Optional[Sequence[str]] = None,
        response_x_paths: Optional[Sequence[str]] = None,
        variables: Optional[Sequence[str]] = None) -> EnvironmentDebugmask
    func GetEnvironmentDebugmask(ctx *Context, name string, id IDInput, state *EnvironmentDebugmaskState, opts ...ResourceOption) (*EnvironmentDebugmask, error)
    public static EnvironmentDebugmask Get(string name, Input<string> id, EnvironmentDebugmaskState? state, CustomResourceOptions? opts = null)
    public static EnvironmentDebugmask get(String name, Output<String> id, EnvironmentDebugmaskState state, CustomResourceOptions options)
    resources:  _:    type: gcp:apigee:EnvironmentDebugmask    get:      id: ${id}
    import {
  to = gcp_apigee_environmentdebugmask.example
  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:
    EnvId string
    The Apigee environment associated with the debug mask, in the format organizations/{{org_name}}/environments/{{env_name}}.

    FaultXPaths List<string>
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for fault messages.
    Name string
    The fully qualified name of the debug mask, in the format organizations/{{org_name}}/environments/{{env_name}}/debugmask.
    Namespaces Dictionary<string, string>
    Map of namespace prefixes to URIs used to evaluate the configured XPath expressions.
    RequestJsonPaths List<string>
    List of JSONPath expressions that specify the JSON elements or attributes that the debug mask applies to for request messages.
    RequestXPaths List<string>
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for request messages.
    ResponseJsonPaths List<string>
    List of JSONPath expressions that specify the JSON elements or attributes that the debug mask applies to for response messages.
    ResponseXPaths List<string>
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for response messages.
    Variables List<string>
    List of flow variables that the debug mask applies to.
    EnvId string
    The Apigee environment associated with the debug mask, in the format organizations/{{org_name}}/environments/{{env_name}}.

    FaultXPaths []string
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for fault messages.
    Name string
    The fully qualified name of the debug mask, in the format organizations/{{org_name}}/environments/{{env_name}}/debugmask.
    Namespaces map[string]string
    Map of namespace prefixes to URIs used to evaluate the configured XPath expressions.
    RequestJsonPaths []string
    List of JSONPath expressions that specify the JSON elements or attributes that the debug mask applies to for request messages.
    RequestXPaths []string
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for request messages.
    ResponseJsonPaths []string
    List of JSONPath expressions that specify the JSON elements or attributes that the debug mask applies to for response messages.
    ResponseXPaths []string
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for response messages.
    Variables []string
    List of flow variables that the debug mask applies to.
    env_id string
    The Apigee environment associated with the debug mask, in the format organizations/{{org_name}}/environments/{{env_name}}.

    fault_x_paths list(string)
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for fault messages.
    name string
    The fully qualified name of the debug mask, in the format organizations/{{org_name}}/environments/{{env_name}}/debugmask.
    namespaces map(string)
    Map of namespace prefixes to URIs used to evaluate the configured XPath expressions.
    request_json_paths list(string)
    List of JSONPath expressions that specify the JSON elements or attributes that the debug mask applies to for request messages.
    request_x_paths list(string)
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for request messages.
    response_json_paths list(string)
    List of JSONPath expressions that specify the JSON elements or attributes that the debug mask applies to for response messages.
    response_x_paths list(string)
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for response messages.
    variables list(string)
    List of flow variables that the debug mask applies to.
    envId String
    The Apigee environment associated with the debug mask, in the format organizations/{{org_name}}/environments/{{env_name}}.

    faultXPaths List<String>
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for fault messages.
    name String
    The fully qualified name of the debug mask, in the format organizations/{{org_name}}/environments/{{env_name}}/debugmask.
    namespaces Map<String,String>
    Map of namespace prefixes to URIs used to evaluate the configured XPath expressions.
    requestJsonPaths List<String>
    List of JSONPath expressions that specify the JSON elements or attributes that the debug mask applies to for request messages.
    requestXPaths List<String>
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for request messages.
    responseJsonPaths List<String>
    List of JSONPath expressions that specify the JSON elements or attributes that the debug mask applies to for response messages.
    responseXPaths List<String>
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for response messages.
    variables List<String>
    List of flow variables that the debug mask applies to.
    envId string
    The Apigee environment associated with the debug mask, in the format organizations/{{org_name}}/environments/{{env_name}}.

    faultXPaths string[]
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for fault messages.
    name string
    The fully qualified name of the debug mask, in the format organizations/{{org_name}}/environments/{{env_name}}/debugmask.
    namespaces {[key: string]: string}
    Map of namespace prefixes to URIs used to evaluate the configured XPath expressions.
    requestJsonPaths string[]
    List of JSONPath expressions that specify the JSON elements or attributes that the debug mask applies to for request messages.
    requestXPaths string[]
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for request messages.
    responseJsonPaths string[]
    List of JSONPath expressions that specify the JSON elements or attributes that the debug mask applies to for response messages.
    responseXPaths string[]
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for response messages.
    variables string[]
    List of flow variables that the debug mask applies to.
    env_id str
    The Apigee environment associated with the debug mask, in the format organizations/{{org_name}}/environments/{{env_name}}.

    fault_x_paths Sequence[str]
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for fault messages.
    name str
    The fully qualified name of the debug mask, in the format organizations/{{org_name}}/environments/{{env_name}}/debugmask.
    namespaces Mapping[str, str]
    Map of namespace prefixes to URIs used to evaluate the configured XPath expressions.
    request_json_paths Sequence[str]
    List of JSONPath expressions that specify the JSON elements or attributes that the debug mask applies to for request messages.
    request_x_paths Sequence[str]
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for request messages.
    response_json_paths Sequence[str]
    List of JSONPath expressions that specify the JSON elements or attributes that the debug mask applies to for response messages.
    response_x_paths Sequence[str]
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for response messages.
    variables Sequence[str]
    List of flow variables that the debug mask applies to.
    envId String
    The Apigee environment associated with the debug mask, in the format organizations/{{org_name}}/environments/{{env_name}}.

    faultXPaths List<String>
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for fault messages.
    name String
    The fully qualified name of the debug mask, in the format organizations/{{org_name}}/environments/{{env_name}}/debugmask.
    namespaces Map<String>
    Map of namespace prefixes to URIs used to evaluate the configured XPath expressions.
    requestJsonPaths List<String>
    List of JSONPath expressions that specify the JSON elements or attributes that the debug mask applies to for request messages.
    requestXPaths List<String>
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for request messages.
    responseJsonPaths List<String>
    List of JSONPath expressions that specify the JSON elements or attributes that the debug mask applies to for response messages.
    responseXPaths List<String>
    List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for response messages.
    variables List<String>
    List of flow variables that the debug mask applies to.

    Import

    EnvironmentDebugmask can be imported using any of these accepted formats:

    • {{env_id}}/debugmask
    • organizations/{{org_name}}/environments/{{env_name}}

    When using the pulumi import command, EnvironmentDebugmask can be imported using one of the formats above. For example:

    $ pulumi import gcp:apigee/environmentDebugmask:EnvironmentDebugmask default {{env_id}}/debugmask
$ pulumi import gcp:apigee/environmentDebugmask:EnvironmentDebugmask default organizations/{{org_name}}/environments/{{env_name}}

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

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Viewing docs for Google Cloud v9.29.0
    published on Wednesday, Jun 24, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-gcp

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial