import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * This resource provides the Opensearch Cluster Pipeline resource in Oracle Cloud Infrastructure Opensearch service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/opensearch/latest/OpensearchClusterPipeline * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/opensearch * * Creates a new OpensearchCluster Pipeline. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testOpensearchClusterPipeline = new oci.opensearch.OpensearchClusterPipeline("test_opensearch_cluster_pipeline", { * compartmentId: compartmentId, * dataPrepperConfigurationBody: opensearchClusterPipelineDataPrepperConfigurationBody, * displayName: opensearchClusterPipelineDisplayName, * memoryGb: Number(opensearchClusterPipelineMemoryGb), * nodeCount: Number(opensearchClusterPipelineNodeCount), * ocpuCount: Number(opensearchClusterPipelineOcpuCount), * pipelineConfigurationBody: opensearchClusterPipelinePipelineConfigurationBody, * definedTags: { * "foo-namespace.bar-key": "value", * }, * freeformTags: { * "bar-key": "value", * }, * nodeShape: opensearchClusterPipelineNodeShape, * nsgId: testNsg.id, * opcDryRun: opensearchClusterPipelineOpcDryRun === "true", * reverseConnectionEndpoints: [{ * customerFqdn: opensearchClusterPipelineReverseConnectionEndpointsCustomerFqdn, * customerIp: opensearchClusterPipelineReverseConnectionEndpointsCustomerIp, * }], * subnetCompartmentId: testCompartment.id, * subnetId: testSubnet.id, * vcnCompartmentId: testCompartment.id, * vcnId: testVcn.id, * }); * ``` * * ## Import * * OpensearchClusterPipelines can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:Opensearch/opensearchClusterPipeline:OpensearchClusterPipeline test_opensearch_cluster_pipeline "id" * ``` */ export declare class OpensearchClusterPipeline extends pulumi.CustomResource { /** * Get an existing OpensearchClusterPipeline 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?: OpensearchClusterPipelineState, opts?: pulumi.CustomResourceOptions): OpensearchClusterPipeline; /** * Returns true if the given object is an instance of OpensearchClusterPipeline. 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 OpensearchClusterPipeline; /** * The OCID of the compartment to create the pipeline in. */ readonly compartmentId: pulumi.Output; /** * (Updatable) The data prepper config in YAML format. The command accepts the data prepper config as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \. */ readonly dataPrepperConfigurationBody: pulumi.Output; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ readonly definedTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) The name of the cluster pipeline. Avoid entering confidential information. */ readonly displayName: pulumi.Output; /** * (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ readonly freeformTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) The amount of memory in GB, for each pipeline node. */ readonly memoryGb: pulumi.Output; /** * (Updatable) The number of nodes configured for the pipeline. */ readonly nodeCount: pulumi.Output; /** * (Updatable) The pipeline node shape. */ readonly nodeShape: pulumi.Output; /** * (Updatable) The OCID of the NSG where the pipeline private endpoint vnic will be attached. */ readonly nsgId: pulumi.Output; /** * (Updatable) The number of OCPUs configured for each pipeline node. */ readonly ocpuCount: pulumi.Output; /** * (Updatable) Indicates that the request is a dry run, if set to "true". A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data. */ readonly opcDryRun: pulumi.Output; /** * The fully qualified domain name (FQDN) for the cluster's API endpoint. */ readonly opensearchPipelineFqdn: pulumi.Output; /** * The pipeline's private IP address. */ readonly opensearchPipelinePrivateIp: pulumi.Output; /** * (Updatable) The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \. */ readonly pipelineConfigurationBody: pulumi.Output; /** * The current state of the pipeline. */ readonly pipelineMode: pulumi.Output; /** * (Updatable) The customer IP and the corresponding fully qualified domain name that the pipeline will connect to. */ readonly reverseConnectionEndpoints: pulumi.Output; /** * The current state of the cluster backup. */ readonly state: pulumi.Output; /** * (Updatable) The OCID for the compartment where the pipeline's subnet is located. */ readonly subnetCompartmentId: pulumi.Output; /** * (Updatable) The OCID of the pipeline's subnet. */ readonly subnetId: pulumi.Output; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ readonly systemTags: pulumi.Output<{ [key: string]: string; }>; /** * The date and time the cluster pipeline was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ readonly timeCreated: pulumi.Output; /** * The amount of time in milliseconds since the pipeline was updated. */ readonly timeUpdated: pulumi.Output; /** * (Updatable) The OCID for the compartment where the pipeline's VCN is located. */ readonly vcnCompartmentId: pulumi.Output; /** * (Updatable) The OCID of the pipeline's VCN. * * ** 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 vcnId: pulumi.Output; /** * Create a OpensearchClusterPipeline 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: OpensearchClusterPipelineArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering OpensearchClusterPipeline resources. */ export interface OpensearchClusterPipelineState { /** * The OCID of the compartment to create the pipeline in. */ compartmentId?: pulumi.Input; /** * (Updatable) The data prepper config in YAML format. The command accepts the data prepper config as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \. */ dataPrepperConfigurationBody?: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) The name of the cluster pipeline. Avoid entering confidential information. */ displayName?: pulumi.Input; /** * (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) The amount of memory in GB, for each pipeline node. */ memoryGb?: pulumi.Input; /** * (Updatable) The number of nodes configured for the pipeline. */ nodeCount?: pulumi.Input; /** * (Updatable) The pipeline node shape. */ nodeShape?: pulumi.Input; /** * (Updatable) The OCID of the NSG where the pipeline private endpoint vnic will be attached. */ nsgId?: pulumi.Input; /** * (Updatable) The number of OCPUs configured for each pipeline node. */ ocpuCount?: pulumi.Input; /** * (Updatable) Indicates that the request is a dry run, if set to "true". A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data. */ opcDryRun?: pulumi.Input; /** * The fully qualified domain name (FQDN) for the cluster's API endpoint. */ opensearchPipelineFqdn?: pulumi.Input; /** * The pipeline's private IP address. */ opensearchPipelinePrivateIp?: pulumi.Input; /** * (Updatable) The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \. */ pipelineConfigurationBody?: pulumi.Input; /** * The current state of the pipeline. */ pipelineMode?: pulumi.Input; /** * (Updatable) The customer IP and the corresponding fully qualified domain name that the pipeline will connect to. */ reverseConnectionEndpoints?: pulumi.Input[] | undefined>; /** * The current state of the cluster backup. */ state?: pulumi.Input; /** * (Updatable) The OCID for the compartment where the pipeline's subnet is located. */ subnetCompartmentId?: pulumi.Input; /** * (Updatable) The OCID of the pipeline's subnet. */ subnetId?: pulumi.Input; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The date and time the cluster pipeline was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated?: pulumi.Input; /** * The amount of time in milliseconds since the pipeline was updated. */ timeUpdated?: pulumi.Input; /** * (Updatable) The OCID for the compartment where the pipeline's VCN is located. */ vcnCompartmentId?: pulumi.Input; /** * (Updatable) The OCID of the pipeline's VCN. * * ** 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 */ vcnId?: pulumi.Input; } /** * The set of arguments for constructing a OpensearchClusterPipeline resource. */ export interface OpensearchClusterPipelineArgs { /** * The OCID of the compartment to create the pipeline in. */ compartmentId: pulumi.Input; /** * (Updatable) The data prepper config in YAML format. The command accepts the data prepper config as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \. */ dataPrepperConfigurationBody: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) The name of the cluster pipeline. Avoid entering confidential information. */ displayName: pulumi.Input; /** * (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) The amount of memory in GB, for each pipeline node. */ memoryGb: pulumi.Input; /** * (Updatable) The number of nodes configured for the pipeline. */ nodeCount: pulumi.Input; /** * (Updatable) The pipeline node shape. */ nodeShape?: pulumi.Input; /** * (Updatable) The OCID of the NSG where the pipeline private endpoint vnic will be attached. */ nsgId?: pulumi.Input; /** * (Updatable) The number of OCPUs configured for each pipeline node. */ ocpuCount: pulumi.Input; /** * (Updatable) Indicates that the request is a dry run, if set to "true". A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data. */ opcDryRun?: pulumi.Input; /** * (Updatable) The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \. */ pipelineConfigurationBody: pulumi.Input; /** * (Updatable) The customer IP and the corresponding fully qualified domain name that the pipeline will connect to. */ reverseConnectionEndpoints?: pulumi.Input[] | undefined>; /** * (Updatable) The OCID for the compartment where the pipeline's subnet is located. */ subnetCompartmentId?: pulumi.Input; /** * (Updatable) The OCID of the pipeline's subnet. */ subnetId?: pulumi.Input; /** * (Updatable) The OCID for the compartment where the pipeline's VCN is located. */ vcnCompartmentId?: pulumi.Input; /** * (Updatable) The OCID of the pipeline's VCN. * * ** 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 */ vcnId?: pulumi.Input; } //# sourceMappingURL=opensearchClusterPipeline.d.ts.map