@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
307 lines • 13 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* UllMirroringCollectorRule is a resource that defines what traffic should be mirrored.
*
* > **Warning:** This resource is in beta, and should be used with the terraform-provider-google-beta provider.
* See Provider Versions for more details on beta resources.
*
* ## Example Usage
*
* ### Network Security Ull Mirroring Collector Rule 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 subnetwork = new gcp.compute.Subnetwork("subnetwork", {
* name: "example-subnet",
* region: "us-south1",
* ipCidrRange: "10.1.0.0/16",
* network: network.name,
* });
* const healthCheck = new gcp.compute.RegionHealthCheck("health_check", {
* name: "example-hc",
* region: "us-south1",
* httpHealthCheck: {
* port: 80,
* },
* });
* const backendService = new gcp.compute.RegionBackendService("backend_service", {
* name: "example-bs",
* region: "us-south1",
* healthChecks: healthCheck.id,
* protocol: "UDP",
* loadBalancingScheme: "INTERNAL",
* });
* const forwardingRule = new gcp.compute.ForwardingRule("forwarding_rule", {
* name: "example-fwr",
* region: "us-south1",
* network: network.name,
* subnetwork: subnetwork.name,
* backendService: backendService.id,
* loadBalancingScheme: "INTERNAL",
* ports: ["6081"],
* ipProtocol: "UDP",
* isMirroringCollector: true,
* });
* const ullMirroringEngine = new gcp.networksecurity.UllMirroringEngine("ull_mirroring_engine", {
* ullMirroringEngineId: "example-ull-eng",
* location: "us-south1-d",
* });
* const collector = new gcp.networksecurity.UllMirroringCollector("collector", {
* ullMirroringCollectorId: "example-ull-col",
* location: "us-south1-d",
* forwardingRule: forwardingRule.id,
* engine: ullMirroringEngine.id,
* labels: {
* foo: "bar",
* },
* });
* const _default = new gcp.networksecurity.UllMirroringCollectorRule("default", {
* ullMirroringCollectorRuleId: "example-ull-rule",
* location: "us-south1-d",
* ullMirroringCollector: collector.ullMirroringCollectorId,
* match: {
* direction: "INGRESS",
* ipProtocols: ["tcp"],
* srcIpRanges: ["10.0.0.0/8"],
* dstIpRanges: ["192.168.0.0/16"],
* },
* });
* ```
*
* ## Import
*
* UllMirroringCollectorRule can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/ullMirroringCollectors/{{ull_mirroring_collector}}/rules/{{ull_mirroring_collector_rule_id}}`
* * `{{project}}/{{location}}/{{ull_mirroring_collector}}/{{ull_mirroring_collector_rule_id}}`
* * `{{location}}/{{ull_mirroring_collector}}/{{ull_mirroring_collector_rule_id}}`
*
* When using the `pulumi import` command, UllMirroringCollectorRule can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:networksecurity/ullMirroringCollectorRule:UllMirroringCollectorRule default projects/{{project}}/locations/{{location}}/ullMirroringCollectors/{{ull_mirroring_collector}}/rules/{{ull_mirroring_collector_rule_id}}
* $ pulumi import gcp:networksecurity/ullMirroringCollectorRule:UllMirroringCollectorRule default {{project}}/{{location}}/{{ull_mirroring_collector}}/{{ull_mirroring_collector_rule_id}}
* $ pulumi import gcp:networksecurity/ullMirroringCollectorRule:UllMirroringCollectorRule default {{location}}/{{ull_mirroring_collector}}/{{ull_mirroring_collector_rule_id}}
* ```
*/
export declare class UllMirroringCollectorRule extends pulumi.CustomResource {
/**
* Get an existing UllMirroringCollectorRule 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?: UllMirroringCollectorRuleState, opts?: pulumi.CustomResourceOptions): UllMirroringCollectorRule;
/**
* Returns true if the given object is an instance of UllMirroringCollectorRule. 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 UllMirroringCollectorRule;
/**
* [Output only] Create time stamp
*/
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>;
/**
* 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 as key value pairs
* **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>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
readonly location: pulumi.Output<string>;
/**
* Match defines what traffic to mirror.
* Structure is documented below.
*/
readonly match: pulumi.Output<outputs.networksecurity.UllMirroringCollectorRuleMatch>;
/**
* Identifier. The name of the UllMirroringCollectorRule.
*/
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;
}>;
/**
* Whether reconciling is in progress, recommended per
* https://google.aip.dev/128.
*/
readonly reconciling: pulumi.Output<boolean>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
readonly ullMirroringCollector: pulumi.Output<string>;
/**
* ID for the new UllMirroringCollectorRule.
*/
readonly ullMirroringCollectorRuleId: pulumi.Output<string>;
/**
* [Output only] Update time stamp
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a UllMirroringCollectorRule 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: UllMirroringCollectorRuleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering UllMirroringCollectorRule resources.
*/
export interface UllMirroringCollectorRuleState {
/**
* [Output only] Create time stamp
*/
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>;
/**
* 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 as key value pairs
* **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>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
location?: pulumi.Input<string | undefined>;
/**
* Match defines what traffic to mirror.
* Structure is documented below.
*/
match?: pulumi.Input<inputs.networksecurity.UllMirroringCollectorRuleMatch | undefined>;
/**
* Identifier. The name of the UllMirroringCollectorRule.
*/
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>;
/**
* Whether reconciling is in progress, recommended per
* https://google.aip.dev/128.
*/
reconciling?: pulumi.Input<boolean | undefined>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
ullMirroringCollector?: pulumi.Input<string | undefined>;
/**
* ID for the new UllMirroringCollectorRule.
*/
ullMirroringCollectorRuleId?: pulumi.Input<string | undefined>;
/**
* [Output only] Update time stamp
*/
updateTime?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a UllMirroringCollectorRule resource.
*/
export interface UllMirroringCollectorRuleArgs {
/**
* 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>;
/**
* Labels as key value pairs
* **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>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
location: pulumi.Input<string>;
/**
* Match defines what traffic to mirror.
* Structure is documented below.
*/
match: pulumi.Input<inputs.networksecurity.UllMirroringCollectorRuleMatch>;
/**
* 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>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
ullMirroringCollector: pulumi.Input<string>;
/**
* ID for the new UllMirroringCollectorRule.
*/
ullMirroringCollectorRuleId: pulumi.Input<string>;
}
//# sourceMappingURL=ullMirroringCollectorRule.d.ts.map