@pulumi/gcp/networksecurity/interceptEndpointGroup.d.ts

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

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * An endpoint group is a consumer frontend for a deployment group (backend).
 * In order to configure intercept for a network, consumers must create:
 * - An association between their network and the endpoint group.
 * - A security profile that points to the endpoint group.
 * - A firewall rule that references the security profile (group).
 *
 * ## Example Usage
 *
 * ### Network Security Intercept Endpoint Group Basic
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const network = new gcp.compute.Network("network", {
 *     name: "example-network",
 *     autoCreateSubnetworks: false,
 * });
 * const deploymentGroup = new gcp.networksecurity.InterceptDeploymentGroup("deployment_group", {
 *     interceptDeploymentGroupId: "example-dg",
 *     location: "global",
 *     network: network.id,
 * });
 * const _default = new gcp.networksecurity.InterceptEndpointGroup("default", {
 *     interceptEndpointGroupId: "example-eg",
 *     location: "global",
 *     interceptDeploymentGroup: deploymentGroup.id,
 *     description: "some description",
 *     labels: {
 *         foo: "bar",
 *     },
 * });
 * ```
 *
 * ## Import
 *
 * InterceptEndpointGroup can be imported using any of these accepted formats:
 *
 * * `projects/{{project}}/locations/{{location}}/interceptEndpointGroups/{{intercept_endpoint_group_id}}`
 *
 * * `{{project}}/{{location}}/{{intercept_endpoint_group_id}}`
 *
 * * `{{location}}/{{intercept_endpoint_group_id}}`
 *
 * When using the `pulumi import` command, InterceptEndpointGroup can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:networksecurity/interceptEndpointGroup:InterceptEndpointGroup default projects/{{project}}/locations/{{location}}/interceptEndpointGroups/{{intercept_endpoint_group_id}}
 * ```
 *
 * ```sh
 * $ pulumi import gcp:networksecurity/interceptEndpointGroup:InterceptEndpointGroup default {{project}}/{{location}}/{{intercept_endpoint_group_id}}
 * ```
 *
 * ```sh
 * $ pulumi import gcp:networksecurity/interceptEndpointGroup:InterceptEndpointGroup default {{location}}/{{intercept_endpoint_group_id}}
 * ```
 */
export declare class InterceptEndpointGroup extends pulumi.CustomResource {
    /**
     * Get an existing InterceptEndpointGroup 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?: InterceptEndpointGroupState, opts?: pulumi.CustomResourceOptions): InterceptEndpointGroup;
    /**
     * Returns true if the given object is an instance of InterceptEndpointGroup.  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 InterceptEndpointGroup;
    /**
     * List of associations to this endpoint group.
     * Structure is documented below.
     */
    readonly associations: pulumi.Output<outputs.networksecurity.InterceptEndpointGroupAssociation[]>;
    /**
     * The endpoint group's view of a connected deployment group.
     * Structure is documented below.
     */
    readonly connectedDeploymentGroups: pulumi.Output<outputs.networksecurity.InterceptEndpointGroupConnectedDeploymentGroup[]>;
    /**
     * The timestamp when the resource was created.
     * See https://google.aip.dev/148#timestamps.
     */
    readonly createTime: pulumi.Output<string>;
    /**
     * User-provided description of the endpoint group.
     * Used as additional context for the endpoint group.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
     */
    readonly effectiveLabels: pulumi.Output<{
        [key: string]: string;
    }>;
    /**
     * The deployment group that this endpoint group is connected to, for example:
     * `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`.
     * See https://google.aip.dev/124.
     */
    readonly interceptDeploymentGroup: pulumi.Output<string>;
    /**
     * The ID to use for the endpoint group, which will become the final component
     * of the endpoint group's resource name.
     */
    readonly interceptEndpointGroupId: pulumi.Output<string>;
    /**
     * Labels are key/value pairs that help to organize and filter resources.
     * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
     * Please refer to the field `effectiveLabels` for all of the labels present on the resource.
     */
    readonly labels: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    /**
     * The cloud location of the endpoint group, currently restricted to `global`.
     */
    readonly location: pulumi.Output<string>;
    /**
     * (Output)
     * The connected deployment group's resource name, for example:
     * `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`.
     * See https://google.aip.dev/124.
     */
    readonly name: pulumi.Output<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    readonly project: pulumi.Output<string>;
    /**
     * The combination of labels configured directly on the resource
     * and default labels configured on the provider.
     */
    readonly pulumiLabels: pulumi.Output<{
        [key: string]: string;
    }>;
    /**
     * The current state of the resource does not match the user's intended state,
     * and the system is working to reconcile them. This is part of the normal
     * operation (e.g. adding a new association to the group).
     * See https://google.aip.dev/128.
     */
    readonly reconciling: pulumi.Output<boolean>;
    /**
     * (Output)
     * The current state of the association in this location.
     * Possible values:
     * STATE_UNSPECIFIED
     * ACTIVE
     * OUT_OF_SYNC
     */
    readonly state: pulumi.Output<string>;
    /**
     * The timestamp when the resource was most recently updated.
     * See https://google.aip.dev/148#timestamps.
     */
    readonly updateTime: pulumi.Output<string>;
    /**
     * Create a InterceptEndpointGroup 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: InterceptEndpointGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering InterceptEndpointGroup resources.
 */
export interface InterceptEndpointGroupState {
    /**
     * List of associations to this endpoint group.
     * Structure is documented below.
     */
    associations?: pulumi.Input<pulumi.Input<inputs.networksecurity.InterceptEndpointGroupAssociation>[]>;
    /**
     * The endpoint group's view of a connected deployment group.
     * Structure is documented below.
     */
    connectedDeploymentGroups?: pulumi.Input<pulumi.Input<inputs.networksecurity.InterceptEndpointGroupConnectedDeploymentGroup>[]>;
    /**
     * The timestamp when the resource was created.
     * See https://google.aip.dev/148#timestamps.
     */
    createTime?: pulumi.Input<string>;
    /**
     * User-provided description of the endpoint group.
     * Used as additional context for the endpoint group.
     */
    description?: pulumi.Input<string>;
    /**
     * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
     */
    effectiveLabels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * The deployment group that this endpoint group is connected to, for example:
     * `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`.
     * See https://google.aip.dev/124.
     */
    interceptDeploymentGroup?: pulumi.Input<string>;
    /**
     * The ID to use for the endpoint group, which will become the final component
     * of the endpoint group's resource name.
     */
    interceptEndpointGroupId?: pulumi.Input<string>;
    /**
     * Labels are key/value pairs that help to organize and filter resources.
     * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
     * Please refer to the field `effectiveLabels` for all of the labels present on the resource.
     */
    labels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * The cloud location of the endpoint group, currently restricted to `global`.
     */
    location?: pulumi.Input<string>;
    /**
     * (Output)
     * The connected deployment group's resource name, for example:
     * `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`.
     * See https://google.aip.dev/124.
     */
    name?: pulumi.Input<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string>;
    /**
     * The combination of labels configured directly on the resource
     * and default labels configured on the provider.
     */
    pulumiLabels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * The current state of the resource does not match the user's intended state,
     * and the system is working to reconcile them. This is part of the normal
     * operation (e.g. adding a new association to the group).
     * See https://google.aip.dev/128.
     */
    reconciling?: pulumi.Input<boolean>;
    /**
     * (Output)
     * The current state of the association in this location.
     * Possible values:
     * STATE_UNSPECIFIED
     * ACTIVE
     * OUT_OF_SYNC
     */
    state?: pulumi.Input<string>;
    /**
     * The timestamp when the resource was most recently updated.
     * See https://google.aip.dev/148#timestamps.
     */
    updateTime?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a InterceptEndpointGroup resource.
 */
export interface InterceptEndpointGroupArgs {
    /**
     * User-provided description of the endpoint group.
     * Used as additional context for the endpoint group.
     */
    description?: pulumi.Input<string>;
    /**
     * The deployment group that this endpoint group is connected to, for example:
     * `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`.
     * See https://google.aip.dev/124.
     */
    interceptDeploymentGroup: pulumi.Input<string>;
    /**
     * The ID to use for the endpoint group, which will become the final component
     * of the endpoint group's resource name.
     */
    interceptEndpointGroupId: pulumi.Input<string>;
    /**
     * Labels are key/value pairs that help to organize and filter resources.
     * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
     * Please refer to the field `effectiveLabels` for all of the labels present on the resource.
     */
    labels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * The cloud location of the endpoint group, currently restricted to `global`.
     */
    location: pulumi.Input<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string>;
}