import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * This resource provides the Path Analysi resource in Oracle Cloud Infrastructure Vn Monitoring service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/NetMonitor/latest/PathAnalysis * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/vn_monitoring * * Use this method to initiate a [Network Path Analyzer](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/path_analyzer.htm) analysis. This method returns * an opc-work-request-id, and you can poll the status of the work request until it either fails or succeeds. * * If the work request status is successful, use [ListWorkRequestResults](https://docs.cloud.oracle.com/iaas/api/#/en/VnConfigAdvisor/latest/WorkRequestResult/ListWorkRequestResults) * with the work request ID to ask for the successful analysis results. If the work request status is failed, use * [ListWorkRequestErrors](https://docs.cloud.oracle.com/iaas/api/#/en/VnConfigAdvisor/latest/WorkRequestError/ListWorkRequestErrors) * with the work request ID to ask for the analysis failure information. The information * returned from either of these methods can be used to build a final report. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testPathAnalysi = new oci.vnmonitoring.PathAnalysi("test_path_analysi", { * type: pathAnalysiType, * cacheControl: pathAnalysiCacheControl, * compartmentId: compartmentId, * destinationEndpoint: { * type: pathAnalysiDestinationEndpointType, * address: pathAnalysiDestinationEndpointAddress, * instanceId: testInstance.id, * listenerId: testListener.id, * loadBalancerId: testLoadBalancer.id, * networkLoadBalancerId: testNetworkLoadBalancer.id, * psaId: testPsa.id, * subnetId: testSubnet.id, * vlanId: testVlan.id, * vnicId: testVnicAttachment.id, * }, * pathAnalyzerTestId: testPathAnalyzerTest.id, * protocol: Number(pathAnalysiProtocol), * protocolParameters: { * type: pathAnalysiProtocolParametersType, * destinationPort: Number(pathAnalysiProtocolParametersDestinationPort), * icmpCode: Number(pathAnalysiProtocolParametersIcmpCode), * icmpType: Number(pathAnalysiProtocolParametersIcmpType), * sourcePort: Number(pathAnalysiProtocolParametersSourcePort), * }, * queryOptions: { * isBiDirectionalAnalysis: pathAnalysiQueryOptionsIsBiDirectionalAnalysis === "true", * }, * sourceEndpoint: { * type: pathAnalysiSourceEndpointType, * address: pathAnalysiSourceEndpointAddress, * instanceId: testInstance.id, * listenerId: testListener.id, * loadBalancerId: testLoadBalancer.id, * networkLoadBalancerId: testNetworkLoadBalancer.id, * psaId: testPsa.id, * subnetId: testSubnet.id, * vlanId: testVlan.id, * vnicId: testVnicAttachment.id, * }, * }); * ``` * * ## Import * * PathAnalysis can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:VnMonitoring/pathAnalysi:PathAnalysi test_path_analysi "id" * ``` */ export declare class PathAnalysi extends pulumi.CustomResource { /** * Get an existing PathAnalysi 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?: PathAnalysiState, opts?: pulumi.CustomResourceOptions): PathAnalysi; /** * Returns true if the given object is an instance of PathAnalysi. 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 PathAnalysi; /** * The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses. */ readonly cacheControl: pulumi.Output; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the compartment. */ readonly compartmentId: pulumi.Output; /** * Information describing a source or destination in a `PathAnalyzerTest` resource. */ readonly destinationEndpoint: pulumi.Output; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `PathAnalyzerTest` resource. */ readonly pathAnalyzerTestId: pulumi.Output; /** * The IP protocol to used for the path analysis. */ readonly protocol: pulumi.Output; /** * Defines the IP protocol parameters for a `PathAnalyzerTest` resource. */ readonly protocolParameters: pulumi.Output; /** * Defines the query options required for a `PathAnalyzerTest` resource. */ readonly queryOptions: pulumi.Output; /** * Information describing a source or destination in a `PathAnalyzerTest` resource. */ readonly sourceEndpoint: pulumi.Output; /** * The type of the `PathAnalysis` query. * * ** 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 type: pulumi.Output; /** * Create a PathAnalysi 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: PathAnalysiArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering PathAnalysi resources. */ export interface PathAnalysiState { /** * The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses. */ cacheControl?: pulumi.Input; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the compartment. */ compartmentId?: pulumi.Input; /** * Information describing a source or destination in a `PathAnalyzerTest` resource. */ destinationEndpoint?: pulumi.Input; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `PathAnalyzerTest` resource. */ pathAnalyzerTestId?: pulumi.Input; /** * The IP protocol to used for the path analysis. */ protocol?: pulumi.Input; /** * Defines the IP protocol parameters for a `PathAnalyzerTest` resource. */ protocolParameters?: pulumi.Input; /** * Defines the query options required for a `PathAnalyzerTest` resource. */ queryOptions?: pulumi.Input; /** * Information describing a source or destination in a `PathAnalyzerTest` resource. */ sourceEndpoint?: pulumi.Input; /** * The type of the `PathAnalysis` query. * * ** 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 */ type?: pulumi.Input; } /** * The set of arguments for constructing a PathAnalysi resource. */ export interface PathAnalysiArgs { /** * The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses. */ cacheControl?: pulumi.Input; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the compartment. */ compartmentId?: pulumi.Input; /** * Information describing a source or destination in a `PathAnalyzerTest` resource. */ destinationEndpoint?: pulumi.Input; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `PathAnalyzerTest` resource. */ pathAnalyzerTestId?: pulumi.Input; /** * The IP protocol to used for the path analysis. */ protocol?: pulumi.Input; /** * Defines the IP protocol parameters for a `PathAnalyzerTest` resource. */ protocolParameters?: pulumi.Input; /** * Defines the query options required for a `PathAnalyzerTest` resource. */ queryOptions?: pulumi.Input; /** * Information describing a source or destination in a `PathAnalyzerTest` resource. */ sourceEndpoint?: pulumi.Input; /** * The type of the `PathAnalysis` query. * * ** 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 */ type: pulumi.Input; } //# sourceMappingURL=pathAnalysi.d.ts.map