@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
246 lines (245 loc) • 9.24 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to manage traffic mirror filter rule
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@volcengine/pulumi";
*
* const foo = new volcengine.vpc.TrafficMirrorFilter("foo", {
* trafficMirrorFilterName: "acc-test-traffic-mirror-filter",
* description: "acc-test",
* projectName: "default",
* tags: [{
* key: "k1",
* value: "v1",
* }],
* });
* const foo_ingress = new volcengine.vpc.TrafficMirrorFilterRule("foo-ingress", {
* trafficMirrorFilterId: foo.id,
* trafficDirection: "ingress",
* description: "acc-test",
* priority: 1,
* policy: "reject",
* protocol: "all",
* sourceCidrBlock: "10.0.1.0/24",
* sourcePortRange: "-1/-1",
* destinationCidrBlock: "10.0.0.0/24",
* destinationPortRange: "-1/-1",
* });
* const foo_egress = new volcengine.vpc.TrafficMirrorFilterRule("foo-egress", {
* trafficMirrorFilterId: foo.id,
* trafficDirection: "egress",
* description: "acc-test",
* priority: 2,
* policy: "reject",
* protocol: "tcp",
* sourceCidrBlock: "10.0.1.0/24",
* sourcePortRange: "80/80",
* destinationCidrBlock: "10.0.0.0/24",
* destinationPortRange: "88/90",
* });
* ```
*
* ## Import
*
* TrafficMirrorFilterRule can be imported using the id, e.g.
*
* ```sh
* $ pulumi import volcengine:vpc/trafficMirrorFilterRule:TrafficMirrorFilterRule default resource_id
* ```
*/
export declare class TrafficMirrorFilterRule extends pulumi.CustomResource {
/**
* Get an existing TrafficMirrorFilterRule 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?: TrafficMirrorFilterRuleState, opts?: pulumi.CustomResourceOptions): TrafficMirrorFilterRule;
/**
* Returns true if the given object is an instance of TrafficMirrorFilterRule. 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 TrafficMirrorFilterRule;
/**
* The create time of traffic mirror filter rule.
*/
readonly createdAt: pulumi.Output<string>;
/**
* The description of traffic mirror filter rule.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The destination cidr block of traffic mirror filter rule.
*/
readonly destinationCidrBlock: pulumi.Output<string>;
/**
* The destination port range of traffic mirror filter rule. When the protocol is `all` or `icmp`, the value is `-1/-1`.
* When the protocol is `tcp` or `udp`, the value can be `1/200`, `80/80`, which means port 1 to port 200, port 80.
*/
readonly destinationPortRange: pulumi.Output<string>;
/**
* The policy of traffic mirror filter rule. Valid values: `accept`, `reject`.
*/
readonly policy: pulumi.Output<string>;
/**
* The priority of traffic mirror filter rule. Valid values: 1~1000. Default value is 1.
*/
readonly priority: pulumi.Output<number>;
/**
* The protocol of traffic mirror filter rule. Valid values: `tcp`, `udp`, `icmp`, `all`.
*/
readonly protocol: pulumi.Output<string>;
/**
* The source cidr block of traffic mirror filter rule.
*/
readonly sourceCidrBlock: pulumi.Output<string>;
/**
* The source port range of traffic mirror filter rule. When the protocol is `all` or `icmp`, the value is `-1/-1`.
* When the protocol is `tcp` or `udp`, the value can be `1/200`, `80/80`, which means port 1 to port 200, port 80.
*/
readonly sourcePortRange: pulumi.Output<string>;
/**
* The status of traffic mirror filter rule.
*/
readonly status: pulumi.Output<string>;
/**
* The traffic direction of traffic mirror filter rule. Valid values: `ingress`; `egress`.
*/
readonly trafficDirection: pulumi.Output<string>;
/**
* The ID of traffic mirror filter.
*/
readonly trafficMirrorFilterId: pulumi.Output<string>;
/**
* The ID of traffic mirror filter rule.
*/
readonly trafficMirrorFilterRuleId: pulumi.Output<string>;
/**
* The last update time of traffic mirror filter rule.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* Create a TrafficMirrorFilterRule 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: TrafficMirrorFilterRuleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering TrafficMirrorFilterRule resources.
*/
export interface TrafficMirrorFilterRuleState {
/**
* The create time of traffic mirror filter rule.
*/
createdAt?: pulumi.Input<string>;
/**
* The description of traffic mirror filter rule.
*/
description?: pulumi.Input<string>;
/**
* The destination cidr block of traffic mirror filter rule.
*/
destinationCidrBlock?: pulumi.Input<string>;
/**
* The destination port range of traffic mirror filter rule. When the protocol is `all` or `icmp`, the value is `-1/-1`.
* When the protocol is `tcp` or `udp`, the value can be `1/200`, `80/80`, which means port 1 to port 200, port 80.
*/
destinationPortRange?: pulumi.Input<string>;
/**
* The policy of traffic mirror filter rule. Valid values: `accept`, `reject`.
*/
policy?: pulumi.Input<string>;
/**
* The priority of traffic mirror filter rule. Valid values: 1~1000. Default value is 1.
*/
priority?: pulumi.Input<number>;
/**
* The protocol of traffic mirror filter rule. Valid values: `tcp`, `udp`, `icmp`, `all`.
*/
protocol?: pulumi.Input<string>;
/**
* The source cidr block of traffic mirror filter rule.
*/
sourceCidrBlock?: pulumi.Input<string>;
/**
* The source port range of traffic mirror filter rule. When the protocol is `all` or `icmp`, the value is `-1/-1`.
* When the protocol is `tcp` or `udp`, the value can be `1/200`, `80/80`, which means port 1 to port 200, port 80.
*/
sourcePortRange?: pulumi.Input<string>;
/**
* The status of traffic mirror filter rule.
*/
status?: pulumi.Input<string>;
/**
* The traffic direction of traffic mirror filter rule. Valid values: `ingress`; `egress`.
*/
trafficDirection?: pulumi.Input<string>;
/**
* The ID of traffic mirror filter.
*/
trafficMirrorFilterId?: pulumi.Input<string>;
/**
* The ID of traffic mirror filter rule.
*/
trafficMirrorFilterRuleId?: pulumi.Input<string>;
/**
* The last update time of traffic mirror filter rule.
*/
updatedAt?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a TrafficMirrorFilterRule resource.
*/
export interface TrafficMirrorFilterRuleArgs {
/**
* The description of traffic mirror filter rule.
*/
description?: pulumi.Input<string>;
/**
* The destination cidr block of traffic mirror filter rule.
*/
destinationCidrBlock: pulumi.Input<string>;
/**
* The destination port range of traffic mirror filter rule. When the protocol is `all` or `icmp`, the value is `-1/-1`.
* When the protocol is `tcp` or `udp`, the value can be `1/200`, `80/80`, which means port 1 to port 200, port 80.
*/
destinationPortRange?: pulumi.Input<string>;
/**
* The policy of traffic mirror filter rule. Valid values: `accept`, `reject`.
*/
policy: pulumi.Input<string>;
/**
* The priority of traffic mirror filter rule. Valid values: 1~1000. Default value is 1.
*/
priority?: pulumi.Input<number>;
/**
* The protocol of traffic mirror filter rule. Valid values: `tcp`, `udp`, `icmp`, `all`.
*/
protocol: pulumi.Input<string>;
/**
* The source cidr block of traffic mirror filter rule.
*/
sourceCidrBlock: pulumi.Input<string>;
/**
* The source port range of traffic mirror filter rule. When the protocol is `all` or `icmp`, the value is `-1/-1`.
* When the protocol is `tcp` or `udp`, the value can be `1/200`, `80/80`, which means port 1 to port 200, port 80.
*/
sourcePortRange?: pulumi.Input<string>;
/**
* The traffic direction of traffic mirror filter rule. Valid values: `ingress`; `egress`.
*/
trafficDirection: pulumi.Input<string>;
/**
* The ID of traffic mirror filter.
*/
trafficMirrorFilterId: pulumi.Input<string>;
}