@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
315 lines • 13 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* An endpoint is a managed mirroring collector that provides enhanced packet
* enrichment capabilities and support for multiple replica destinations.
* Endpoints are always part of a global endpoint group which represents a
* global "mirroring broker" service.
*
* ## Example Usage
*
* ### Network Security Mirroring Endpoint 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.MirroringDeploymentGroup("deployment_group", {
* mirroringDeploymentGroupId: "example-dg",
* location: "global",
* network: network.id,
* });
* const endpointGroup = new gcp.networksecurity.MirroringEndpointGroup("endpoint_group", {
* mirroringEndpointGroupId: "example-eg",
* location: "global",
* type: "BROKER",
* mirroringDeploymentGroups: [deploymentGroup.id],
* });
* const _default = new gcp.networksecurity.MirroringEndpoint("default", {
* mirroringEndpointId: "example-endpoint",
* location: "us-west2-a",
* mirroringEndpointGroup: endpointGroup.id,
* description: "some description",
* labels: {
* foo: "bar",
* },
* });
* ```
*
* ## Import
*
* MirroringEndpoint can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/mirroringEndpoints/{{mirroring_endpoint_id}}`
* * `{{project}}/{{location}}/{{mirroring_endpoint_id}}`
* * `{{location}}/{{mirroring_endpoint_id}}`
*
* When using the `pulumi import` command, MirroringEndpoint can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:networksecurity/mirroringEndpoint:MirroringEndpoint default projects/{{project}}/locations/{{location}}/mirroringEndpoints/{{mirroring_endpoint_id}}
* $ pulumi import gcp:networksecurity/mirroringEndpoint:MirroringEndpoint default {{project}}/{{location}}/{{mirroring_endpoint_id}}
* $ pulumi import gcp:networksecurity/mirroringEndpoint:MirroringEndpoint default {{location}}/{{mirroring_endpoint_id}}
* ```
*/
export declare class MirroringEndpoint extends pulumi.CustomResource {
/**
* Get an existing MirroringEndpoint 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?: MirroringEndpointState, opts?: pulumi.CustomResourceOptions): MirroringEndpoint;
/**
* Returns true if the given object is an instance of MirroringEndpoint. 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 MirroringEndpoint;
/**
* The timestamp when the resource was created.
* See https://google.aip.dev/148#timestamps.
*/
readonly createTime: pulumi.Output<string>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* User-provided description of the endpoint.
* Used as additional context for the endpoint.
*/
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;
}>;
/**
* 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, e.g. `us-central1-a` or `asia-south1-b`.
*/
readonly location: pulumi.Output<string>;
/**
* The endpoint group that this endpoint belongs to.
* Format is:
* `projects/{project}/locations/{location}/mirroringEndpointGroups/{mirroringEndpointGroup}`
*/
readonly mirroringEndpointGroup: pulumi.Output<string>;
/**
* The ID to use for the new endpoint, which will become the final
* component of the endpoint's resource name.
*/
readonly mirroringEndpointId: pulumi.Output<string>;
/**
* The resource name of this endpoint, for example:
* `projects/123456789/locations/us-central1-a/mirroringEndpoints/my-endpoint`.
* See https://google.aip.dev/122 for more details.
*/
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 part of the normal
* operation (e.g. linking a new association to the parent group).
* See https://google.aip.dev/128.
*/
readonly reconciling: pulumi.Output<boolean>;
/**
* The current state of the endpoint.
* See https://google.aip.dev/216.
* Possible values:
* STATE_UNSPECIFIED
* CREATING
* ACTIVE
* DELETING
* DELETE_FAILED
* 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 MirroringEndpoint 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: MirroringEndpointArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering MirroringEndpoint resources.
*/
export interface MirroringEndpointState {
/**
* The timestamp when the resource was created.
* See https://google.aip.dev/148#timestamps.
*/
createTime?: pulumi.Input<string | undefined>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* User-provided description of the endpoint.
* Used as additional context for the endpoint.
*/
description?: pulumi.Input<string | undefined>;
/**
* 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>;
} | undefined>;
/**
* 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>;
} | undefined>;
/**
* The cloud location of the endpoint, e.g. `us-central1-a` or `asia-south1-b`.
*/
location?: pulumi.Input<string | undefined>;
/**
* The endpoint group that this endpoint belongs to.
* Format is:
* `projects/{project}/locations/{location}/mirroringEndpointGroups/{mirroringEndpointGroup}`
*/
mirroringEndpointGroup?: pulumi.Input<string | undefined>;
/**
* The ID to use for the new endpoint, which will become the final
* component of the endpoint's resource name.
*/
mirroringEndpointId?: pulumi.Input<string | undefined>;
/**
* The resource name of this endpoint, for example:
* `projects/123456789/locations/us-central1-a/mirroringEndpoints/my-endpoint`.
* See https://google.aip.dev/122 for more details.
*/
name?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
pulumiLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* The current state of the resource does not match the user's intended state,
* and the system is working to reconcile them. This part of the normal
* operation (e.g. linking a new association to the parent group).
* See https://google.aip.dev/128.
*/
reconciling?: pulumi.Input<boolean | undefined>;
/**
* The current state of the endpoint.
* See https://google.aip.dev/216.
* Possible values:
* STATE_UNSPECIFIED
* CREATING
* ACTIVE
* DELETING
* DELETE_FAILED
* OUT_OF_SYNC
*/
state?: pulumi.Input<string | undefined>;
/**
* The timestamp when the resource was most recently updated.
* See https://google.aip.dev/148#timestamps.
*/
updateTime?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a MirroringEndpoint resource.
*/
export interface MirroringEndpointArgs {
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* User-provided description of the endpoint.
* Used as additional context for the endpoint.
*/
description?: pulumi.Input<string | undefined>;
/**
* 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>;
} | undefined>;
/**
* The cloud location of the endpoint, e.g. `us-central1-a` or `asia-south1-b`.
*/
location: pulumi.Input<string>;
/**
* The endpoint group that this endpoint belongs to.
* Format is:
* `projects/{project}/locations/{location}/mirroringEndpointGroups/{mirroringEndpointGroup}`
*/
mirroringEndpointGroup: pulumi.Input<string>;
/**
* The ID to use for the new endpoint, which will become the final
* component of the endpoint's resource name.
*/
mirroringEndpointId: 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 | undefined>;
}
//# sourceMappingURL=mirroringEndpoint.d.ts.map