EnvironmentDebugmask class

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:

• API documentation
• How-to Guides
• Masking sensitive data

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"])

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 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
	})
}

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"]
}

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.get("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

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",
    })

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 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
	})
}

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"
  }
}

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.get("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

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}}

Constructors

EnvironmentDebugmask(String name, {EnvironmentDebugmaskArgs? args, CustomResourceOptions? options})

Creates a new EnvironmentDebugmask. name The Pulumi resource name. args Arguments used to configure this EnvironmentDebugmask. The set of arguments for EnvironmentDebugmask. options Resource options controlling this resource's behavior.

EnvironmentDebugmask.reference(String urn)

Creates a typed reference to an existing EnvironmentDebugmask resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

envId ↔ Output<String>

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

late, final

faultXPaths ↔ Output<List<String>?>

List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for fault messages.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

name ↔ Output<String>

The fully qualified name of the debug mask, in the format organizations/{{org_name}}/environments/{{env_name}}/debugmask.

late, final

namespaces ↔ Output<Map<String, String>?>

Map of namespace prefixes to URIs used to evaluate the configured XPath expressions.

late, final

requestJsonPaths ↔ Output<List<String>?>

List of JSONPath expressions that specify the JSON elements or attributes that the debug mask applies to for request messages.

late, final

requestXPaths ↔ Output<List<String>?>

List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for request messages.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

responseJsonPaths ↔ Output<List<String>?>

List of JSONPath expressions that specify the JSON elements or attributes that the debug mask applies to for response messages.

late, final

responseXPaths ↔ Output<List<String>?>

List of XPath expressions that specify the XML elements or attributes that the debug mask applies to for response messages.

late, final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

variables ↔ Output<List<String>?>

List of flow variables that the debug mask applies to.

late, final

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {EnvironmentDebugmaskState? state, CustomResourceOptions? options}) → EnvironmentDebugmask

Gets an existing EnvironmentDebugmask resource's state with the given name and id.