import * as pulumi from "@pulumi/pulumi"; /** * This resource provides the Vtap resource in Oracle Cloud Infrastructure Core service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/iaas/latest/Vtap * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/ * * Creates a virtual test access point (VTAP) in the specified compartment. * * For the purposes of access control, you must provide the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the VTAP. * For more information about compartments and access control, see * [Overview of the IAM Service](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm). * For information about OCIDs, see [Resource Identifiers](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). * * 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 * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testVtap = new oci.core.Vtap("test_vtap", { * captureFilterId: testCaptureFilter.id, * compartmentId: compartmentId, * sourceId: testSource.id, * vcnId: testVcn.id, * definedTags: { * "Operations.CostCenter": "42", * }, * displayName: vtapDisplayName, * encapsulationProtocol: vtapEncapsulationProtocol, * freeformTags: { * Department: "Finance", * }, * isVtapEnabled: vtapIsVtapEnabled === "true", * maxPacketSize: Number(vtapMaxPacketSize), * sourcePrivateEndpointIp: vtapSourcePrivateEndpointIp, * sourcePrivateEndpointSubnetId: testSubnet.id, * sourceType: vtapSourceType, * targetId: testTarget.id, * targetIp: vtapTargetIp, * targetType: vtapTargetType, * trafficMode: vtapTrafficMode, * vxlanNetworkIdentifier: vtapVxlanNetworkIdentifier, * }); * ``` * * ## Import * * Vtaps can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:Core/vtap:Vtap test_vtap "id" * ``` */ export declare class Vtap extends pulumi.CustomResource { /** * Get an existing Vtap 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, state?: VtapState, opts?: pulumi.CustomResourceOptions): Vtap; /** * Returns true if the given object is an instance of Vtap. 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 Vtap; /** * (Updatable) The capture filter's Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)). */ readonly captureFilterId: pulumi.Output; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the `Vtap` resource. */ readonly compartmentId: pulumi.Output; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ readonly definedTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ readonly displayName: pulumi.Output; /** * (Updatable) Defines an encapsulation header type for the VTAP's mirrored traffic. */ readonly encapsulationProtocol: pulumi.Output; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ readonly freeformTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) Used to start or stop a `Vtap` resource. * * `TRUE` directs the VTAP to start mirroring traffic. * * `FALSE` (Default) directs the VTAP to stop mirroring traffic. */ readonly isVtapEnabled: pulumi.Output; /** * The VTAP's current running state. */ readonly lifecycleStateDetails: pulumi.Output; /** * (Updatable) The maximum size of the packets to be included in the filter. */ readonly maxPacketSize: pulumi.Output; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the source point where packets are captured. */ readonly sourceId: pulumi.Output; /** * (Updatable) The IP Address of the source private endpoint. */ readonly sourcePrivateEndpointIp: pulumi.Output; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet that source private endpoint belongs to. */ readonly sourcePrivateEndpointSubnetId: pulumi.Output; /** * (Updatable) The source type for the VTAP. */ readonly sourceType: pulumi.Output; /** * The VTAP's administrative lifecycle state. */ readonly state: pulumi.Output; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the destination resource where mirrored packets are sent. */ readonly targetId: pulumi.Output; /** * (Updatable) The IP address of the destination resource where mirrored packets are sent. */ readonly targetIp: pulumi.Output; /** * (Updatable) The target type for the VTAP. */ readonly targetType: pulumi.Output; /** * The date and time the VTAP was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2020-08-25T21:10:29.600Z` */ readonly timeCreated: pulumi.Output; /** * (Updatable) Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT */ readonly trafficMode: pulumi.Output; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN containing the `Vtap` resource. */ readonly vcnId: pulumi.Output; /** * (Updatable) The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ readonly vxlanNetworkIdentifier: pulumi.Output; /** * Create a Vtap 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: VtapArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Vtap resources. */ export interface VtapState { /** * (Updatable) The capture filter's Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)). */ captureFilterId?: pulumi.Input; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the `Vtap` resource. */ compartmentId?: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName?: pulumi.Input; /** * (Updatable) Defines an encapsulation header type for the VTAP's mirrored traffic. */ encapsulationProtocol?: pulumi.Input; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) Used to start or stop a `Vtap` resource. * * `TRUE` directs the VTAP to start mirroring traffic. * * `FALSE` (Default) directs the VTAP to stop mirroring traffic. */ isVtapEnabled?: pulumi.Input; /** * The VTAP's current running state. */ lifecycleStateDetails?: pulumi.Input; /** * (Updatable) The maximum size of the packets to be included in the filter. */ maxPacketSize?: pulumi.Input; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the source point where packets are captured. */ sourceId?: pulumi.Input; /** * (Updatable) The IP Address of the source private endpoint. */ sourcePrivateEndpointIp?: pulumi.Input; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet that source private endpoint belongs to. */ sourcePrivateEndpointSubnetId?: pulumi.Input; /** * (Updatable) The source type for the VTAP. */ sourceType?: pulumi.Input; /** * The VTAP's administrative lifecycle state. */ state?: pulumi.Input; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the destination resource where mirrored packets are sent. */ targetId?: pulumi.Input; /** * (Updatable) The IP address of the destination resource where mirrored packets are sent. */ targetIp?: pulumi.Input; /** * (Updatable) The target type for the VTAP. */ targetType?: pulumi.Input; /** * The date and time the VTAP was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2020-08-25T21:10:29.600Z` */ timeCreated?: pulumi.Input; /** * (Updatable) Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT */ trafficMode?: pulumi.Input; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN containing the `Vtap` resource. */ vcnId?: pulumi.Input; /** * (Updatable) The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ vxlanNetworkIdentifier?: pulumi.Input; } /** * The set of arguments for constructing a Vtap resource. */ export interface VtapArgs { /** * (Updatable) The capture filter's Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)). */ captureFilterId: pulumi.Input; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the `Vtap` resource. */ compartmentId: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName?: pulumi.Input; /** * (Updatable) Defines an encapsulation header type for the VTAP's mirrored traffic. */ encapsulationProtocol?: pulumi.Input; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) Used to start or stop a `Vtap` resource. * * `TRUE` directs the VTAP to start mirroring traffic. * * `FALSE` (Default) directs the VTAP to stop mirroring traffic. */ isVtapEnabled?: pulumi.Input; /** * (Updatable) The maximum size of the packets to be included in the filter. */ maxPacketSize?: pulumi.Input; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the source point where packets are captured. */ sourceId: pulumi.Input; /** * (Updatable) The IP Address of the source private endpoint. */ sourcePrivateEndpointIp?: pulumi.Input; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet that source private endpoint belongs to. */ sourcePrivateEndpointSubnetId?: pulumi.Input; /** * (Updatable) The source type for the VTAP. */ sourceType?: pulumi.Input; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the destination resource where mirrored packets are sent. */ targetId?: pulumi.Input; /** * (Updatable) The IP address of the destination resource where mirrored packets are sent. */ targetIp?: pulumi.Input; /** * (Updatable) The target type for the VTAP. */ targetType?: pulumi.Input; /** * (Updatable) Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT */ trafficMode?: pulumi.Input; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN containing the `Vtap` resource. */ vcnId: pulumi.Input; /** * (Updatable) The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ vxlanNetworkIdentifier?: pulumi.Input; } //# sourceMappingURL=vtap.d.ts.map