@pulumi/gcp/apigee/environmentDebugmask.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * 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](https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations.environments/getDebugmask)
 * * How-to Guides
 *     * [Masking sensitive data](https://cloud.google.com/apigee/docs/api-platform/debug/masking-data)
 *
 * ## Example Usage
 *
 * ### Apigee Environment Debugmask Basic
 *
 * ```typescript
 * 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"],
 * });
 * ```
 *
 * ### Apigee Environment Debugmask Full
 *
 * ```typescript
 * 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
 *
 * 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:
 *
 * ```sh
 * $ pulumi import gcp:apigee/environmentDebugmask:EnvironmentDebugmask default {{env_id}}/debugmask
 * $ pulumi import gcp:apigee/environmentDebugmask:EnvironmentDebugmask default organizations/{{org_name}}/environments/{{env_name}}
 * ```
 */
export declare class EnvironmentDebugmask extends pulumi.CustomResource {
    /**
     * Get an existing EnvironmentDebugmask resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EnvironmentDebugmaskState, opts?: pulumi.CustomResourceOptions): EnvironmentDebugmask;
    /**
     * Returns true if the given object is an instance of EnvironmentDebugmask.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is EnvironmentDebugmask;
    /**
     * The Apigee environment associated with the debug mask, in the format
     * `organizations/{{org_name}}/environments/{{env_name}}`.
     *
     * ***
     */
    readonly envId: pulumi.Output<string>;
    /**
     * List of XPath expressions that specify the XML elements or attributes that the
     * debug mask applies to for fault messages.
     */
    readonly faultXPaths: pulumi.Output<string[] | undefined>;
    /**
     * The fully qualified name of the debug mask, in the format
     * `organizations/{{org_name}}/environments/{{env_name}}/debugmask`.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Map of namespace prefixes to URIs used to evaluate the configured XPath
     * expressions.
     */
    readonly namespaces: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    /**
     * List of JSONPath expressions that specify the JSON elements or attributes that
     * the debug mask applies to for request messages.
     */
    readonly requestJsonPaths: pulumi.Output<string[] | undefined>;
    /**
     * List of XPath expressions that specify the XML elements or attributes that the
     * debug mask applies to for request messages.
     */
    readonly requestXPaths: pulumi.Output<string[] | undefined>;
    /**
     * List of JSONPath expressions that specify the JSON elements or attributes that
     * the debug mask applies to for response messages.
     */
    readonly responseJsonPaths: pulumi.Output<string[] | undefined>;
    /**
     * List of XPath expressions that specify the XML elements or attributes that the
     * debug mask applies to for response messages.
     */
    readonly responseXPaths: pulumi.Output<string[] | undefined>;
    /**
     * List of flow variables that the debug mask applies to.
     */
    readonly variables: pulumi.Output<string[] | undefined>;
    /**
     * Create a EnvironmentDebugmask resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: EnvironmentDebugmaskArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering EnvironmentDebugmask resources.
 */
export interface EnvironmentDebugmaskState {
    /**
     * The Apigee environment associated with the debug mask, in the format
     * `organizations/{{org_name}}/environments/{{env_name}}`.
     *
     * ***
     */
    envId?: pulumi.Input<string | undefined>;
    /**
     * List of XPath expressions that specify the XML elements or attributes that the
     * debug mask applies to for fault messages.
     */
    faultXPaths?: pulumi.Input<pulumi.Input<string>[] | undefined>;
    /**
     * The fully qualified name of the debug mask, in the format
     * `organizations/{{org_name}}/environments/{{env_name}}/debugmask`.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * Map of namespace prefixes to URIs used to evaluate the configured XPath
     * expressions.
     */
    namespaces?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * List of JSONPath expressions that specify the JSON elements or attributes that
     * the debug mask applies to for request messages.
     */
    requestJsonPaths?: pulumi.Input<pulumi.Input<string>[] | undefined>;
    /**
     * List of XPath expressions that specify the XML elements or attributes that the
     * debug mask applies to for request messages.
     */
    requestXPaths?: pulumi.Input<pulumi.Input<string>[] | undefined>;
    /**
     * List of JSONPath expressions that specify the JSON elements or attributes that
     * the debug mask applies to for response messages.
     */
    responseJsonPaths?: pulumi.Input<pulumi.Input<string>[] | undefined>;
    /**
     * List of XPath expressions that specify the XML elements or attributes that the
     * debug mask applies to for response messages.
     */
    responseXPaths?: pulumi.Input<pulumi.Input<string>[] | undefined>;
    /**
     * List of flow variables that the debug mask applies to.
     */
    variables?: pulumi.Input<pulumi.Input<string>[] | undefined>;
}
/**
 * The set of arguments for constructing a EnvironmentDebugmask resource.
 */
export interface EnvironmentDebugmaskArgs {
    /**
     * The Apigee environment associated with the debug mask, in the format
     * `organizations/{{org_name}}/environments/{{env_name}}`.
     *
     * ***
     */
    envId: pulumi.Input<string>;
    /**
     * List of XPath expressions that specify the XML elements or attributes that the
     * debug mask applies to for fault messages.
     */
    faultXPaths?: pulumi.Input<pulumi.Input<string>[] | undefined>;
    /**
     * Map of namespace prefixes to URIs used to evaluate the configured XPath
     * expressions.
     */
    namespaces?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * List of JSONPath expressions that specify the JSON elements or attributes that
     * the debug mask applies to for request messages.
     */
    requestJsonPaths?: pulumi.Input<pulumi.Input<string>[] | undefined>;
    /**
     * List of XPath expressions that specify the XML elements or attributes that the
     * debug mask applies to for request messages.
     */
    requestXPaths?: pulumi.Input<pulumi.Input<string>[] | undefined>;
    /**
     * List of JSONPath expressions that specify the JSON elements or attributes that
     * the debug mask applies to for response messages.
     */
    responseJsonPaths?: pulumi.Input<pulumi.Input<string>[] | undefined>;
    /**
     * List of XPath expressions that specify the XML elements or attributes that the
     * debug mask applies to for response messages.
     */
    responseXPaths?: pulumi.Input<pulumi.Input<string>[] | undefined>;
    /**
     * List of flow variables that the debug mask applies to.
     */
    variables?: pulumi.Input<pulumi.Input<string>[] | undefined>;
}
//# sourceMappingURL=environmentDebugmask.d.ts.map