Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

CaptureFilter

This resource provides the Capture Filter resource in Oracle Cloud Infrastructure Core service.

Creates a virtual test access point (VTAP) capture filter in the specified compartment.

For the purposes of access control, you must provide the OCID of the compartment that contains the VTAP. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.

You may optionally specify a display name for the VTAP, otherwise a default is provided. It does not have to be unique, and you can change it.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testCaptureFilter = new Oci.Core.CaptureFilter("testCaptureFilter", new()
    {
        CompartmentId = @var.Compartment_id,
        FilterType = @var.Capture_filter_filter_type,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        DisplayName = @var.Capture_filter_display_name,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        VtapCaptureFilterRules = new[]
        {
            new Oci.Core.Inputs.CaptureFilterVtapCaptureFilterRuleArgs
            {
                TrafficDirection = @var.Capture_filter_vtap_capture_filter_rules_traffic_direction,
                DestinationCidr = @var.Capture_filter_vtap_capture_filter_rules_destination_cidr,
                IcmpOptions = new Oci.Core.Inputs.CaptureFilterVtapCaptureFilterRuleIcmpOptionsArgs
                {
                    Type = @var.Capture_filter_vtap_capture_filter_rules_icmp_options_type,
                    Code = @var.Capture_filter_vtap_capture_filter_rules_icmp_options_code,
                },
                Protocol = @var.Capture_filter_vtap_capture_filter_rules_protocol,
                RuleAction = @var.Capture_filter_vtap_capture_filter_rules_rule_action,
                SourceCidr = @var.Capture_filter_vtap_capture_filter_rules_source_cidr,
                TcpOptions = new Oci.Core.Inputs.CaptureFilterVtapCaptureFilterRuleTcpOptionsArgs
                {
                    DestinationPortRange = new Oci.Core.Inputs.CaptureFilterVtapCaptureFilterRuleTcpOptionsDestinationPortRangeArgs
                    {
                        Max = @var.Capture_filter_vtap_capture_filter_rules_tcp_options_destination_port_range_max,
                        Min = @var.Capture_filter_vtap_capture_filter_rules_tcp_options_destination_port_range_min,
                    },
                    SourcePortRange = new Oci.Core.Inputs.CaptureFilterVtapCaptureFilterRuleTcpOptionsSourcePortRangeArgs
                    {
                        Max = @var.Capture_filter_vtap_capture_filter_rules_tcp_options_source_port_range_max,
                        Min = @var.Capture_filter_vtap_capture_filter_rules_tcp_options_source_port_range_min,
                    },
                },
                UdpOptions = new Oci.Core.Inputs.CaptureFilterVtapCaptureFilterRuleUdpOptionsArgs
                {
                    DestinationPortRange = new Oci.Core.Inputs.CaptureFilterVtapCaptureFilterRuleUdpOptionsDestinationPortRangeArgs
                    {
                        Max = @var.Capture_filter_vtap_capture_filter_rules_udp_options_destination_port_range_max,
                        Min = @var.Capture_filter_vtap_capture_filter_rules_udp_options_destination_port_range_min,
                    },
                    SourcePortRange = new Oci.Core.Inputs.CaptureFilterVtapCaptureFilterRuleUdpOptionsSourcePortRangeArgs
                    {
                        Max = @var.Capture_filter_vtap_capture_filter_rules_udp_options_source_port_range_max,
                        Min = @var.Capture_filter_vtap_capture_filter_rules_udp_options_source_port_range_min,
                    },
                },
            },
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/Core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Core.NewCaptureFilter(ctx, "testCaptureFilter", &Core.CaptureFilterArgs{
			CompartmentId: pulumi.Any(_var.Compartment_id),
			FilterType:    pulumi.Any(_var.Capture_filter_filter_type),
			DefinedTags: pulumi.AnyMap{
				"Operations.CostCenter": pulumi.Any("42"),
			},
			DisplayName: pulumi.Any(_var.Capture_filter_display_name),
			FreeformTags: pulumi.AnyMap{
				"Department": pulumi.Any("Finance"),
			},
			VtapCaptureFilterRules: core.CaptureFilterVtapCaptureFilterRuleArray{
				&core.CaptureFilterVtapCaptureFilterRuleArgs{
					TrafficDirection: pulumi.Any(_var.Capture_filter_vtap_capture_filter_rules_traffic_direction),
					DestinationCidr:  pulumi.Any(_var.Capture_filter_vtap_capture_filter_rules_destination_cidr),
					IcmpOptions: &core.CaptureFilterVtapCaptureFilterRuleIcmpOptionsArgs{
						Type: pulumi.Any(_var.Capture_filter_vtap_capture_filter_rules_icmp_options_type),
						Code: pulumi.Any(_var.Capture_filter_vtap_capture_filter_rules_icmp_options_code),
					},
					Protocol:   pulumi.Any(_var.Capture_filter_vtap_capture_filter_rules_protocol),
					RuleAction: pulumi.Any(_var.Capture_filter_vtap_capture_filter_rules_rule_action),
					SourceCidr: pulumi.Any(_var.Capture_filter_vtap_capture_filter_rules_source_cidr),
					TcpOptions: &core.CaptureFilterVtapCaptureFilterRuleTcpOptionsArgs{
						DestinationPortRange: &core.CaptureFilterVtapCaptureFilterRuleTcpOptionsDestinationPortRangeArgs{
							Max: pulumi.Any(_var.Capture_filter_vtap_capture_filter_rules_tcp_options_destination_port_range_max),
							Min: pulumi.Any(_var.Capture_filter_vtap_capture_filter_rules_tcp_options_destination_port_range_min),
						},
						SourcePortRange: &core.CaptureFilterVtapCaptureFilterRuleTcpOptionsSourcePortRangeArgs{
							Max: pulumi.Any(_var.Capture_filter_vtap_capture_filter_rules_tcp_options_source_port_range_max),
							Min: pulumi.Any(_var.Capture_filter_vtap_capture_filter_rules_tcp_options_source_port_range_min),
						},
					},
					UdpOptions: &core.CaptureFilterVtapCaptureFilterRuleUdpOptionsArgs{
						DestinationPortRange: &core.CaptureFilterVtapCaptureFilterRuleUdpOptionsDestinationPortRangeArgs{
							Max: pulumi.Any(_var.Capture_filter_vtap_capture_filter_rules_udp_options_destination_port_range_max),
							Min: pulumi.Any(_var.Capture_filter_vtap_capture_filter_rules_udp_options_destination_port_range_min),
						},
						SourcePortRange: &core.CaptureFilterVtapCaptureFilterRuleUdpOptionsSourcePortRangeArgs{
							Max: pulumi.Any(_var.Capture_filter_vtap_capture_filter_rules_udp_options_source_port_range_max),
							Min: pulumi.Any(_var.Capture_filter_vtap_capture_filter_rules_udp_options_source_port_range_min),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.CaptureFilter;
import com.pulumi.oci.Core.CaptureFilterArgs;
import com.pulumi.oci.Core.inputs.CaptureFilterVtapCaptureFilterRuleArgs;
import com.pulumi.oci.Core.inputs.CaptureFilterVtapCaptureFilterRuleIcmpOptionsArgs;
import com.pulumi.oci.Core.inputs.CaptureFilterVtapCaptureFilterRuleTcpOptionsArgs;
import com.pulumi.oci.Core.inputs.CaptureFilterVtapCaptureFilterRuleTcpOptionsDestinationPortRangeArgs;
import com.pulumi.oci.Core.inputs.CaptureFilterVtapCaptureFilterRuleTcpOptionsSourcePortRangeArgs;
import com.pulumi.oci.Core.inputs.CaptureFilterVtapCaptureFilterRuleUdpOptionsArgs;
import com.pulumi.oci.Core.inputs.CaptureFilterVtapCaptureFilterRuleUdpOptionsDestinationPortRangeArgs;
import com.pulumi.oci.Core.inputs.CaptureFilterVtapCaptureFilterRuleUdpOptionsSourcePortRangeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testCaptureFilter = new CaptureFilter("testCaptureFilter", CaptureFilterArgs.builder()        
            .compartmentId(var_.compartment_id())
            .filterType(var_.capture_filter_filter_type())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .displayName(var_.capture_filter_display_name())
            .freeformTags(Map.of("Department", "Finance"))
            .vtapCaptureFilterRules(CaptureFilterVtapCaptureFilterRuleArgs.builder()
                .trafficDirection(var_.capture_filter_vtap_capture_filter_rules_traffic_direction())
                .destinationCidr(var_.capture_filter_vtap_capture_filter_rules_destination_cidr())
                .icmpOptions(CaptureFilterVtapCaptureFilterRuleIcmpOptionsArgs.builder()
                    .type(var_.capture_filter_vtap_capture_filter_rules_icmp_options_type())
                    .code(var_.capture_filter_vtap_capture_filter_rules_icmp_options_code())
                    .build())
                .protocol(var_.capture_filter_vtap_capture_filter_rules_protocol())
                .ruleAction(var_.capture_filter_vtap_capture_filter_rules_rule_action())
                .sourceCidr(var_.capture_filter_vtap_capture_filter_rules_source_cidr())
                .tcpOptions(CaptureFilterVtapCaptureFilterRuleTcpOptionsArgs.builder()
                    .destinationPortRange(CaptureFilterVtapCaptureFilterRuleTcpOptionsDestinationPortRangeArgs.builder()
                        .max(var_.capture_filter_vtap_capture_filter_rules_tcp_options_destination_port_range_max())
                        .min(var_.capture_filter_vtap_capture_filter_rules_tcp_options_destination_port_range_min())
                        .build())
                    .sourcePortRange(CaptureFilterVtapCaptureFilterRuleTcpOptionsSourcePortRangeArgs.builder()
                        .max(var_.capture_filter_vtap_capture_filter_rules_tcp_options_source_port_range_max())
                        .min(var_.capture_filter_vtap_capture_filter_rules_tcp_options_source_port_range_min())
                        .build())
                    .build())
                .udpOptions(CaptureFilterVtapCaptureFilterRuleUdpOptionsArgs.builder()
                    .destinationPortRange(CaptureFilterVtapCaptureFilterRuleUdpOptionsDestinationPortRangeArgs.builder()
                        .max(var_.capture_filter_vtap_capture_filter_rules_udp_options_destination_port_range_max())
                        .min(var_.capture_filter_vtap_capture_filter_rules_udp_options_destination_port_range_min())
                        .build())
                    .sourcePortRange(CaptureFilterVtapCaptureFilterRuleUdpOptionsSourcePortRangeArgs.builder()
                        .max(var_.capture_filter_vtap_capture_filter_rules_udp_options_source_port_range_max())
                        .min(var_.capture_filter_vtap_capture_filter_rules_udp_options_source_port_range_min())
                        .build())
                    .build())
                .build())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_capture_filter = oci.core.CaptureFilter("testCaptureFilter",
    compartment_id=var["compartment_id"],
    filter_type=var["capture_filter_filter_type"],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    display_name=var["capture_filter_display_name"],
    freeform_tags={
        "Department": "Finance",
    },
    vtap_capture_filter_rules=[oci.core.CaptureFilterVtapCaptureFilterRuleArgs(
        traffic_direction=var["capture_filter_vtap_capture_filter_rules_traffic_direction"],
        destination_cidr=var["capture_filter_vtap_capture_filter_rules_destination_cidr"],
        icmp_options=oci.core.CaptureFilterVtapCaptureFilterRuleIcmpOptionsArgs(
            type=var["capture_filter_vtap_capture_filter_rules_icmp_options_type"],
            code=var["capture_filter_vtap_capture_filter_rules_icmp_options_code"],
        ),
        protocol=var["capture_filter_vtap_capture_filter_rules_protocol"],
        rule_action=var["capture_filter_vtap_capture_filter_rules_rule_action"],
        source_cidr=var["capture_filter_vtap_capture_filter_rules_source_cidr"],
        tcp_options=oci.core.CaptureFilterVtapCaptureFilterRuleTcpOptionsArgs(
            destination_port_range=oci.core.CaptureFilterVtapCaptureFilterRuleTcpOptionsDestinationPortRangeArgs(
                max=var["capture_filter_vtap_capture_filter_rules_tcp_options_destination_port_range_max"],
                min=var["capture_filter_vtap_capture_filter_rules_tcp_options_destination_port_range_min"],
            ),
            source_port_range=oci.core.CaptureFilterVtapCaptureFilterRuleTcpOptionsSourcePortRangeArgs(
                max=var["capture_filter_vtap_capture_filter_rules_tcp_options_source_port_range_max"],
                min=var["capture_filter_vtap_capture_filter_rules_tcp_options_source_port_range_min"],
            ),
        ),
        udp_options=oci.core.CaptureFilterVtapCaptureFilterRuleUdpOptionsArgs(
            destination_port_range=oci.core.CaptureFilterVtapCaptureFilterRuleUdpOptionsDestinationPortRangeArgs(
                max=var["capture_filter_vtap_capture_filter_rules_udp_options_destination_port_range_max"],
                min=var["capture_filter_vtap_capture_filter_rules_udp_options_destination_port_range_min"],
            ),
            source_port_range=oci.core.CaptureFilterVtapCaptureFilterRuleUdpOptionsSourcePortRangeArgs(
                max=var["capture_filter_vtap_capture_filter_rules_udp_options_source_port_range_max"],
                min=var["capture_filter_vtap_capture_filter_rules_udp_options_source_port_range_min"],
            ),
        ),
    )])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testCaptureFilter = new oci.core.CaptureFilter("testCaptureFilter", {
    compartmentId: _var.compartment_id,
    filterType: _var.capture_filter_filter_type,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    displayName: _var.capture_filter_display_name,
    freeformTags: {
        Department: "Finance",
    },
    vtapCaptureFilterRules: [{
        trafficDirection: _var.capture_filter_vtap_capture_filter_rules_traffic_direction,
        destinationCidr: _var.capture_filter_vtap_capture_filter_rules_destination_cidr,
        icmpOptions: {
            type: _var.capture_filter_vtap_capture_filter_rules_icmp_options_type,
            code: _var.capture_filter_vtap_capture_filter_rules_icmp_options_code,
        },
        protocol: _var.capture_filter_vtap_capture_filter_rules_protocol,
        ruleAction: _var.capture_filter_vtap_capture_filter_rules_rule_action,
        sourceCidr: _var.capture_filter_vtap_capture_filter_rules_source_cidr,
        tcpOptions: {
            destinationPortRange: {
                max: _var.capture_filter_vtap_capture_filter_rules_tcp_options_destination_port_range_max,
                min: _var.capture_filter_vtap_capture_filter_rules_tcp_options_destination_port_range_min,
            },
            sourcePortRange: {
                max: _var.capture_filter_vtap_capture_filter_rules_tcp_options_source_port_range_max,
                min: _var.capture_filter_vtap_capture_filter_rules_tcp_options_source_port_range_min,
            },
        },
        udpOptions: {
            destinationPortRange: {
                max: _var.capture_filter_vtap_capture_filter_rules_udp_options_destination_port_range_max,
                min: _var.capture_filter_vtap_capture_filter_rules_udp_options_destination_port_range_min,
            },
            sourcePortRange: {
                max: _var.capture_filter_vtap_capture_filter_rules_udp_options_source_port_range_max,
                min: _var.capture_filter_vtap_capture_filter_rules_udp_options_source_port_range_min,
            },
        },
    }],
});
resources:
  testCaptureFilter:
    type: oci:Core:CaptureFilter
    properties:
      #Required
      compartmentId: ${var.compartment_id}
      filterType: ${var.capture_filter_filter_type}
      #Optional
      definedTags:
        Operations.CostCenter: 42
      displayName: ${var.capture_filter_display_name}
      freeformTags:
        Department: Finance
      vtapCaptureFilterRules:
        - trafficDirection: ${var.capture_filter_vtap_capture_filter_rules_traffic_direction}
          destinationCidr: ${var.capture_filter_vtap_capture_filter_rules_destination_cidr}
          icmpOptions:
            type: ${var.capture_filter_vtap_capture_filter_rules_icmp_options_type}
            code: ${var.capture_filter_vtap_capture_filter_rules_icmp_options_code}
          protocol: ${var.capture_filter_vtap_capture_filter_rules_protocol}
          ruleAction: ${var.capture_filter_vtap_capture_filter_rules_rule_action}
          sourceCidr: ${var.capture_filter_vtap_capture_filter_rules_source_cidr}
          tcpOptions:
            destinationPortRange:
              max: ${var.capture_filter_vtap_capture_filter_rules_tcp_options_destination_port_range_max}
              min: ${var.capture_filter_vtap_capture_filter_rules_tcp_options_destination_port_range_min}
            sourcePortRange:
              max: ${var.capture_filter_vtap_capture_filter_rules_tcp_options_source_port_range_max}
              min: ${var.capture_filter_vtap_capture_filter_rules_tcp_options_source_port_range_min}
          udpOptions:
            destinationPortRange:
              max: ${var.capture_filter_vtap_capture_filter_rules_udp_options_destination_port_range_max}
              min: ${var.capture_filter_vtap_capture_filter_rules_udp_options_destination_port_range_min}
            sourcePortRange:
              max: ${var.capture_filter_vtap_capture_filter_rules_udp_options_source_port_range_max}
              min: ${var.capture_filter_vtap_capture_filter_rules_udp_options_source_port_range_min}

Create a CaptureFilter Resource

new CaptureFilter(name: string, args: CaptureFilterArgs, opts?: CustomResourceOptions);
@overload
def CaptureFilter(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  compartment_id: Optional[str] = None,
                  defined_tags: Optional[Mapping[str, Any]] = None,
                  display_name: Optional[str] = None,
                  filter_type: Optional[str] = None,
                  freeform_tags: Optional[Mapping[str, Any]] = None,
                  vtap_capture_filter_rules: Optional[Sequence[_core.CaptureFilterVtapCaptureFilterRuleArgs]] = None)
@overload
def CaptureFilter(resource_name: str,
                  args: CaptureFilterArgs,
                  opts: Optional[ResourceOptions] = None)
func NewCaptureFilter(ctx *Context, name string, args CaptureFilterArgs, opts ...ResourceOption) (*CaptureFilter, error)
public CaptureFilter(string name, CaptureFilterArgs args, CustomResourceOptions? opts = null)
public CaptureFilter(String name, CaptureFilterArgs args)
public CaptureFilter(String name, CaptureFilterArgs args, CustomResourceOptions options)
type: oci:Core:CaptureFilter
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args CaptureFilterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args CaptureFilterArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args CaptureFilterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args CaptureFilterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args CaptureFilterArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

CaptureFilter Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The CaptureFilter resource accepts the following input properties:

CompartmentId string

(Updatable) The OCID of the compartment containing the capture filter.

FilterType string

Indicates which service will use this capture filter

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

FreeformTags Dictionary<string, object>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

VtapCaptureFilterRules List<CaptureFilterVtapCaptureFilterRuleArgs>

(Updatable) The set of rules governing what traffic a VTAP mirrors.

CompartmentId string

(Updatable) The OCID of the compartment containing the capture filter.

FilterType string

Indicates which service will use this capture filter

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

FreeformTags map[string]interface{}

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

VtapCaptureFilterRules []CaptureFilterVtapCaptureFilterRuleArgs

(Updatable) The set of rules governing what traffic a VTAP mirrors.

compartmentId String

(Updatable) The OCID of the compartment containing the capture filter.

filterType String

Indicates which service will use this capture filter

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

freeformTags Map<String,Object>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

vtapCaptureFilterRules List<CaptureFilterVtapCaptureFilterRuleArgs>

(Updatable) The set of rules governing what traffic a VTAP mirrors.

compartmentId string

(Updatable) The OCID of the compartment containing the capture filter.

filterType string

Indicates which service will use this capture filter

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

freeformTags {[key: string]: any}

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

vtapCaptureFilterRules CaptureFilterVtapCaptureFilterRuleArgs[]

(Updatable) The set of rules governing what traffic a VTAP mirrors.

compartment_id str

(Updatable) The OCID of the compartment containing the capture filter.

filter_type str

Indicates which service will use this capture filter

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

display_name str

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

freeform_tags Mapping[str, Any]

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

vtap_capture_filter_rules CaptureFilterVtapCaptureFilterRuleArgs]

(Updatable) The set of rules governing what traffic a VTAP mirrors.

compartmentId String

(Updatable) The OCID of the compartment containing the capture filter.

filterType String

Indicates which service will use this capture filter

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

freeformTags Map<Any>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

vtapCaptureFilterRules List<Property Map>

(Updatable) The set of rules governing what traffic a VTAP mirrors.

Outputs

All input properties are implicitly available as output properties. Additionally, the CaptureFilter resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

State string

The capture filter's current administrative state.

TimeCreated string

The date and time the capture filter was created, in the format defined by RFC3339. Example: 2021-08-25T21:10:29.600Z

Id string

The provider-assigned unique ID for this managed resource.

State string

The capture filter's current administrative state.

TimeCreated string

The date and time the capture filter was created, in the format defined by RFC3339. Example: 2021-08-25T21:10:29.600Z

id String

The provider-assigned unique ID for this managed resource.

state String

The capture filter's current administrative state.

timeCreated String

The date and time the capture filter was created, in the format defined by RFC3339. Example: 2021-08-25T21:10:29.600Z

id string

The provider-assigned unique ID for this managed resource.

state string

The capture filter's current administrative state.

timeCreated string

The date and time the capture filter was created, in the format defined by RFC3339. Example: 2021-08-25T21:10:29.600Z

id str

The provider-assigned unique ID for this managed resource.

state str

The capture filter's current administrative state.

time_created str

The date and time the capture filter was created, in the format defined by RFC3339. Example: 2021-08-25T21:10:29.600Z

id String

The provider-assigned unique ID for this managed resource.

state String

The capture filter's current administrative state.

timeCreated String

The date and time the capture filter was created, in the format defined by RFC3339. Example: 2021-08-25T21:10:29.600Z

Look up an Existing CaptureFilter Resource

Get an existing CaptureFilter resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: CaptureFilterState, opts?: CustomResourceOptions): CaptureFilter
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        display_name: Optional[str] = None,
        filter_type: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        vtap_capture_filter_rules: Optional[Sequence[_core.CaptureFilterVtapCaptureFilterRuleArgs]] = None) -> CaptureFilter
func GetCaptureFilter(ctx *Context, name string, id IDInput, state *CaptureFilterState, opts ...ResourceOption) (*CaptureFilter, error)
public static CaptureFilter Get(string name, Input<string> id, CaptureFilterState? state, CustomResourceOptions? opts = null)
public static CaptureFilter get(String name, Output<String> id, CaptureFilterState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CompartmentId string

(Updatable) The OCID of the compartment containing the capture filter.

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

FilterType string

Indicates which service will use this capture filter

FreeformTags Dictionary<string, object>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

State string

The capture filter's current administrative state.

TimeCreated string

The date and time the capture filter was created, in the format defined by RFC3339. Example: 2021-08-25T21:10:29.600Z

VtapCaptureFilterRules List<CaptureFilterVtapCaptureFilterRuleArgs>

(Updatable) The set of rules governing what traffic a VTAP mirrors.

CompartmentId string

(Updatable) The OCID of the compartment containing the capture filter.

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

FilterType string

Indicates which service will use this capture filter

FreeformTags map[string]interface{}

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

State string

The capture filter's current administrative state.

TimeCreated string

The date and time the capture filter was created, in the format defined by RFC3339. Example: 2021-08-25T21:10:29.600Z

VtapCaptureFilterRules []CaptureFilterVtapCaptureFilterRuleArgs

(Updatable) The set of rules governing what traffic a VTAP mirrors.

compartmentId String

(Updatable) The OCID of the compartment containing the capture filter.

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

filterType String

Indicates which service will use this capture filter

freeformTags Map<String,Object>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

state String

The capture filter's current administrative state.

timeCreated String

The date and time the capture filter was created, in the format defined by RFC3339. Example: 2021-08-25T21:10:29.600Z

vtapCaptureFilterRules List<CaptureFilterVtapCaptureFilterRuleArgs>

(Updatable) The set of rules governing what traffic a VTAP mirrors.

compartmentId string

(Updatable) The OCID of the compartment containing the capture filter.

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

filterType string

Indicates which service will use this capture filter

freeformTags {[key: string]: any}

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

state string

The capture filter's current administrative state.

timeCreated string

The date and time the capture filter was created, in the format defined by RFC3339. Example: 2021-08-25T21:10:29.600Z

vtapCaptureFilterRules CaptureFilterVtapCaptureFilterRuleArgs[]

(Updatable) The set of rules governing what traffic a VTAP mirrors.

compartment_id str

(Updatable) The OCID of the compartment containing the capture filter.

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

display_name str

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

filter_type str

Indicates which service will use this capture filter

freeform_tags Mapping[str, Any]

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

state str

The capture filter's current administrative state.

time_created str

The date and time the capture filter was created, in the format defined by RFC3339. Example: 2021-08-25T21:10:29.600Z

vtap_capture_filter_rules CaptureFilterVtapCaptureFilterRuleArgs]

(Updatable) The set of rules governing what traffic a VTAP mirrors.

compartmentId String

(Updatable) The OCID of the compartment containing the capture filter.

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

filterType String

Indicates which service will use this capture filter

freeformTags Map<Any>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

state String

The capture filter's current administrative state.

timeCreated String

The date and time the capture filter was created, in the format defined by RFC3339. Example: 2021-08-25T21:10:29.600Z

vtapCaptureFilterRules List<Property Map>

(Updatable) The set of rules governing what traffic a VTAP mirrors.

Supporting Types

CaptureFilterVtapCaptureFilterRule

TrafficDirection string

(Updatable) The traffic direction the VTAP is configured to mirror.

DestinationCidr string

(Updatable) Traffic sent to this CIDR block through the VTAP source will be mirrored to the VTAP target.

IcmpOptions CaptureFilterVtapCaptureFilterRuleIcmpOptions

(Updatable) Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in:

Protocol string

(Updatable) The transport protocol used in the filter. If do not choose a protocol, all protocols will be used in the filter. Supported options are:

  • 1 = ICMP
  • 6 = TCP
  • 17 = UDP
RuleAction string

(Updatable) Include or exclude packets meeting this definition from mirrored traffic.

SourceCidr string

(Updatable) Traffic from this CIDR block to the VTAP source will be mirrored to the VTAP target.

TcpOptions CaptureFilterVtapCaptureFilterRuleTcpOptions

(Updatable) Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.

UdpOptions CaptureFilterVtapCaptureFilterRuleUdpOptions

(Updatable) Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.

TrafficDirection string

(Updatable) The traffic direction the VTAP is configured to mirror.

DestinationCidr string

(Updatable) Traffic sent to this CIDR block through the VTAP source will be mirrored to the VTAP target.

IcmpOptions CaptureFilterVtapCaptureFilterRuleIcmpOptions

(Updatable) Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in:

Protocol string

(Updatable) The transport protocol used in the filter. If do not choose a protocol, all protocols will be used in the filter. Supported options are:

  • 1 = ICMP
  • 6 = TCP
  • 17 = UDP
RuleAction string

(Updatable) Include or exclude packets meeting this definition from mirrored traffic.

SourceCidr string

(Updatable) Traffic from this CIDR block to the VTAP source will be mirrored to the VTAP target.

TcpOptions CaptureFilterVtapCaptureFilterRuleTcpOptions

(Updatable) Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.

UdpOptions CaptureFilterVtapCaptureFilterRuleUdpOptions

(Updatable) Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.

trafficDirection String

(Updatable) The traffic direction the VTAP is configured to mirror.

destinationCidr String

(Updatable) Traffic sent to this CIDR block through the VTAP source will be mirrored to the VTAP target.

icmpOptions CaptureFilterVtapCaptureFilterRuleIcmpOptions

(Updatable) Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in:

protocol String

(Updatable) The transport protocol used in the filter. If do not choose a protocol, all protocols will be used in the filter. Supported options are:

  • 1 = ICMP
  • 6 = TCP
  • 17 = UDP
ruleAction String

(Updatable) Include or exclude packets meeting this definition from mirrored traffic.

sourceCidr String

(Updatable) Traffic from this CIDR block to the VTAP source will be mirrored to the VTAP target.

tcpOptions CaptureFilterVtapCaptureFilterRuleTcpOptions

(Updatable) Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.

udpOptions CaptureFilterVtapCaptureFilterRuleUdpOptions

(Updatable) Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.

trafficDirection string

(Updatable) The traffic direction the VTAP is configured to mirror.

destinationCidr string

(Updatable) Traffic sent to this CIDR block through the VTAP source will be mirrored to the VTAP target.

icmpOptions CaptureFilterVtapCaptureFilterRuleIcmpOptions

(Updatable) Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in:

protocol string

(Updatable) The transport protocol used in the filter. If do not choose a protocol, all protocols will be used in the filter. Supported options are:

  • 1 = ICMP
  • 6 = TCP
  • 17 = UDP
ruleAction string

(Updatable) Include or exclude packets meeting this definition from mirrored traffic.

sourceCidr string

(Updatable) Traffic from this CIDR block to the VTAP source will be mirrored to the VTAP target.

tcpOptions CaptureFilterVtapCaptureFilterRuleTcpOptions

(Updatable) Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.

udpOptions CaptureFilterVtapCaptureFilterRuleUdpOptions

(Updatable) Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.

traffic_direction str

(Updatable) The traffic direction the VTAP is configured to mirror.

destination_cidr str

(Updatable) Traffic sent to this CIDR block through the VTAP source will be mirrored to the VTAP target.

icmp_options CaptureFilterVtapCaptureFilterRuleIcmpOptions

(Updatable) Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in:

protocol str

(Updatable) The transport protocol used in the filter. If do not choose a protocol, all protocols will be used in the filter. Supported options are:

  • 1 = ICMP
  • 6 = TCP
  • 17 = UDP
rule_action str

(Updatable) Include or exclude packets meeting this definition from mirrored traffic.

source_cidr str

(Updatable) Traffic from this CIDR block to the VTAP source will be mirrored to the VTAP target.

tcp_options CaptureFilterVtapCaptureFilterRuleTcpOptions

(Updatable) Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.

udp_options CaptureFilterVtapCaptureFilterRuleUdpOptions

(Updatable) Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.

trafficDirection String

(Updatable) The traffic direction the VTAP is configured to mirror.

destinationCidr String

(Updatable) Traffic sent to this CIDR block through the VTAP source will be mirrored to the VTAP target.

icmpOptions Property Map

(Updatable) Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in:

protocol String

(Updatable) The transport protocol used in the filter. If do not choose a protocol, all protocols will be used in the filter. Supported options are:

  • 1 = ICMP
  • 6 = TCP
  • 17 = UDP
ruleAction String

(Updatable) Include or exclude packets meeting this definition from mirrored traffic.

sourceCidr String

(Updatable) Traffic from this CIDR block to the VTAP source will be mirrored to the VTAP target.

tcpOptions Property Map

(Updatable) Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.

udpOptions Property Map

(Updatable) Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.

CaptureFilterVtapCaptureFilterRuleIcmpOptions

Type int

(Updatable) The ICMP type.

Code int

(Updatable) The ICMP code (optional).

Type int

(Updatable) The ICMP type.

Code int

(Updatable) The ICMP code (optional).

type Integer

(Updatable) The ICMP type.

code Integer

(Updatable) The ICMP code (optional).

type number

(Updatable) The ICMP type.

code number

(Updatable) The ICMP code (optional).

type int

(Updatable) The ICMP type.

code int

(Updatable) The ICMP code (optional).

type Number

(Updatable) The ICMP type.

code Number

(Updatable) The ICMP code (optional).

CaptureFilterVtapCaptureFilterRuleTcpOptions

CaptureFilterVtapCaptureFilterRuleTcpOptionsDestinationPortRange

Max int

(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

Min int

(Updatable) The minimum port number, which must not be greater than the maximum port number.

Max int

(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

Min int

(Updatable) The minimum port number, which must not be greater than the maximum port number.

max Integer

(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min Integer

(Updatable) The minimum port number, which must not be greater than the maximum port number.

max number

(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min number

(Updatable) The minimum port number, which must not be greater than the maximum port number.

max int

(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min int

(Updatable) The minimum port number, which must not be greater than the maximum port number.

max Number

(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min Number

(Updatable) The minimum port number, which must not be greater than the maximum port number.

CaptureFilterVtapCaptureFilterRuleTcpOptionsSourcePortRange

Max int

(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

Min int

(Updatable) The minimum port number, which must not be greater than the maximum port number.

Max int

(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

Min int

(Updatable) The minimum port number, which must not be greater than the maximum port number.

max Integer

(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min Integer

(Updatable) The minimum port number, which must not be greater than the maximum port number.

max number

(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min number

(Updatable) The minimum port number, which must not be greater than the maximum port number.

max int

(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min int

(Updatable) The minimum port number, which must not be greater than the maximum port number.

max Number

(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min Number

(Updatable) The minimum port number, which must not be greater than the maximum port number.

CaptureFilterVtapCaptureFilterRuleUdpOptions

CaptureFilterVtapCaptureFilterRuleUdpOptionsDestinationPortRange

Max int

(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

Min int

(Updatable) The minimum port number, which must not be greater than the maximum port number.

Max int

(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

Min int

(Updatable) The minimum port number, which must not be greater than the maximum port number.

max Integer

(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min Integer

(Updatable) The minimum port number, which must not be greater than the maximum port number.

max number

(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min number

(Updatable) The minimum port number, which must not be greater than the maximum port number.

max int

(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min int

(Updatable) The minimum port number, which must not be greater than the maximum port number.

max Number

(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min Number

(Updatable) The minimum port number, which must not be greater than the maximum port number.

CaptureFilterVtapCaptureFilterRuleUdpOptionsSourcePortRange

Max int

(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

Min int

(Updatable) The minimum port number, which must not be greater than the maximum port number.

Max int

(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

Min int

(Updatable) The minimum port number, which must not be greater than the maximum port number.

max Integer

(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min Integer

(Updatable) The minimum port number, which must not be greater than the maximum port number.

max number

(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min number

(Updatable) The minimum port number, which must not be greater than the maximum port number.

max int

(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min int

(Updatable) The minimum port number, which must not be greater than the maximum port number.

max Number

(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min Number

(Updatable) The minimum port number, which must not be greater than the maximum port number.

Import

CaptureFilters can be imported using the id, e.g.

 $ pulumi import oci:Core/captureFilter:CaptureFilter test_capture_filter "id"

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.