1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Oda
  5. OdaPrivateEndpoint
Oracle Cloud Infrastructure v1.24.0 published on Thursday, Feb 22, 2024 by Pulumi

oci.Oda.OdaPrivateEndpoint

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.24.0 published on Thursday, Feb 22, 2024 by Pulumi

    This resource provides the Oda Private Endpoint resource in Oracle Cloud Infrastructure Digital Assistant service.

    Starts an asynchronous job to create an ODA Private Endpoint.

    To monitor the status of the job, take the opc-work-request-id response header value and use it to call GET /workRequests/{workRequestID}.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testOdaPrivateEndpoint = new Oci.Oda.OdaPrivateEndpoint("testOdaPrivateEndpoint", new()
        {
            CompartmentId = @var.Compartment_id,
            SubnetId = oci_core_subnet.Test_subnet.Id,
            DefinedTags = 
            {
                { "foo-namespace.bar-key", "value" },
            },
            Description = @var.Oda_private_endpoint_description,
            DisplayName = @var.Oda_private_endpoint_display_name,
            FreeformTags = 
            {
                { "bar-key", "value" },
            },
            NsgIds = @var.Oda_private_endpoint_nsg_ids,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/Oda"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Oda.NewOdaPrivateEndpoint(ctx, "testOdaPrivateEndpoint", &Oda.OdaPrivateEndpointArgs{
    			CompartmentId: pulumi.Any(_var.Compartment_id),
    			SubnetId:      pulumi.Any(oci_core_subnet.Test_subnet.Id),
    			DefinedTags: pulumi.Map{
    				"foo-namespace.bar-key": pulumi.Any("value"),
    			},
    			Description: pulumi.Any(_var.Oda_private_endpoint_description),
    			DisplayName: pulumi.Any(_var.Oda_private_endpoint_display_name),
    			FreeformTags: pulumi.Map{
    				"bar-key": pulumi.Any("value"),
    			},
    			NsgIds: pulumi.Any(_var.Oda_private_endpoint_nsg_ids),
    		})
    		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.Oda.OdaPrivateEndpoint;
    import com.pulumi.oci.Oda.OdaPrivateEndpointArgs;
    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 testOdaPrivateEndpoint = new OdaPrivateEndpoint("testOdaPrivateEndpoint", OdaPrivateEndpointArgs.builder()        
                .compartmentId(var_.compartment_id())
                .subnetId(oci_core_subnet.test_subnet().id())
                .definedTags(Map.of("foo-namespace.bar-key", "value"))
                .description(var_.oda_private_endpoint_description())
                .displayName(var_.oda_private_endpoint_display_name())
                .freeformTags(Map.of("bar-key", "value"))
                .nsgIds(var_.oda_private_endpoint_nsg_ids())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_oci as oci
    
    test_oda_private_endpoint = oci.oda.OdaPrivateEndpoint("testOdaPrivateEndpoint",
        compartment_id=var["compartment_id"],
        subnet_id=oci_core_subnet["test_subnet"]["id"],
        defined_tags={
            "foo-namespace.bar-key": "value",
        },
        description=var["oda_private_endpoint_description"],
        display_name=var["oda_private_endpoint_display_name"],
        freeform_tags={
            "bar-key": "value",
        },
        nsg_ids=var["oda_private_endpoint_nsg_ids"])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testOdaPrivateEndpoint = new oci.oda.OdaPrivateEndpoint("testOdaPrivateEndpoint", {
        compartmentId: _var.compartment_id,
        subnetId: oci_core_subnet.test_subnet.id,
        definedTags: {
            "foo-namespace.bar-key": "value",
        },
        description: _var.oda_private_endpoint_description,
        displayName: _var.oda_private_endpoint_display_name,
        freeformTags: {
            "bar-key": "value",
        },
        nsgIds: _var.oda_private_endpoint_nsg_ids,
    });
    
    resources:
      testOdaPrivateEndpoint:
        type: oci:Oda:OdaPrivateEndpoint
        properties:
          #Required
          compartmentId: ${var.compartment_id}
          subnetId: ${oci_core_subnet.test_subnet.id}
          #Optional
          definedTags:
            foo-namespace.bar-key: value
          description: ${var.oda_private_endpoint_description}
          displayName: ${var.oda_private_endpoint_display_name}
          freeformTags:
            bar-key: value
          nsgIds: ${var.oda_private_endpoint_nsg_ids}
    

    Create OdaPrivateEndpoint Resource

    new OdaPrivateEndpoint(name: string, args: OdaPrivateEndpointArgs, opts?: CustomResourceOptions);
    @overload
    def OdaPrivateEndpoint(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           compartment_id: Optional[str] = None,
                           defined_tags: Optional[Mapping[str, Any]] = None,
                           description: Optional[str] = None,
                           display_name: Optional[str] = None,
                           freeform_tags: Optional[Mapping[str, Any]] = None,
                           nsg_ids: Optional[Sequence[str]] = None,
                           subnet_id: Optional[str] = None)
    @overload
    def OdaPrivateEndpoint(resource_name: str,
                           args: OdaPrivateEndpointArgs,
                           opts: Optional[ResourceOptions] = None)
    func NewOdaPrivateEndpoint(ctx *Context, name string, args OdaPrivateEndpointArgs, opts ...ResourceOption) (*OdaPrivateEndpoint, error)
    public OdaPrivateEndpoint(string name, OdaPrivateEndpointArgs args, CustomResourceOptions? opts = null)
    public OdaPrivateEndpoint(String name, OdaPrivateEndpointArgs args)
    public OdaPrivateEndpoint(String name, OdaPrivateEndpointArgs args, CustomResourceOptions options)
    
    type: oci:Oda:OdaPrivateEndpoint
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args OdaPrivateEndpointArgs
    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 OdaPrivateEndpointArgs
    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 OdaPrivateEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OdaPrivateEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OdaPrivateEndpointArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    OdaPrivateEndpoint 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 OdaPrivateEndpoint resource accepts the following input properties:

    CompartmentId string
    (Updatable) The OCID of the compartment that the ODA private endpoint belongs to.
    SubnetId string

    The OCID of the subnet that the private endpoint belongs to.

    ** 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

    DefinedTags Dictionary<string, object>
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) Description of the ODA private endpoint.
    DisplayName string
    (Updatable) User-defined name for the ODA private endpoint. Avoid entering confidential information. You can change this value.
    FreeformTags Dictionary<string, object>
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
    NsgIds List<string>
    (Updatable) List of OCIDs of network security groups
    CompartmentId string
    (Updatable) The OCID of the compartment that the ODA private endpoint belongs to.
    SubnetId string

    The OCID of the subnet that the private endpoint belongs to.

    ** 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

    DefinedTags map[string]interface{}
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) Description of the ODA private endpoint.
    DisplayName string
    (Updatable) User-defined name for the ODA private endpoint. Avoid entering confidential information. You can change this value.
    FreeformTags map[string]interface{}
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
    NsgIds []string
    (Updatable) List of OCIDs of network security groups
    compartmentId String
    (Updatable) The OCID of the compartment that the ODA private endpoint belongs to.
    subnetId String

    The OCID of the subnet that the private endpoint belongs to.

    ** 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

    definedTags Map<String,Object>
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) Description of the ODA private endpoint.
    displayName String
    (Updatable) User-defined name for the ODA private endpoint. Avoid entering confidential information. You can change this value.
    freeformTags Map<String,Object>
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
    nsgIds List<String>
    (Updatable) List of OCIDs of network security groups
    compartmentId string
    (Updatable) The OCID of the compartment that the ODA private endpoint belongs to.
    subnetId string

    The OCID of the subnet that the private endpoint belongs to.

    ** 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

    definedTags {[key: string]: any}
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    description string
    (Updatable) Description of the ODA private endpoint.
    displayName string
    (Updatable) User-defined name for the ODA private endpoint. Avoid entering confidential information. You can change this value.
    freeformTags {[key: string]: any}
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
    nsgIds string[]
    (Updatable) List of OCIDs of network security groups
    compartment_id str
    (Updatable) The OCID of the compartment that the ODA private endpoint belongs to.
    subnet_id str

    The OCID of the subnet that the private endpoint belongs to.

    ** 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

    defined_tags Mapping[str, Any]
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    description str
    (Updatable) Description of the ODA private endpoint.
    display_name str
    (Updatable) User-defined name for the ODA private endpoint. Avoid entering confidential information. You can change this value.
    freeform_tags Mapping[str, Any]
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
    nsg_ids Sequence[str]
    (Updatable) List of OCIDs of network security groups
    compartmentId String
    (Updatable) The OCID of the compartment that the ODA private endpoint belongs to.
    subnetId String

    The OCID of the subnet that the private endpoint belongs to.

    ** 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

    definedTags Map<Any>
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) Description of the ODA private endpoint.
    displayName String
    (Updatable) User-defined name for the ODA private endpoint. Avoid entering confidential information. You can change this value.
    freeformTags Map<Any>
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
    nsgIds List<String>
    (Updatable) List of OCIDs of network security groups

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current state of the ODA private endpoint.
    TimeCreated string
    When the resource was created. A date-time string as described in RFC 3339, section 14.29.
    TimeUpdated string
    When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current state of the ODA private endpoint.
    TimeCreated string
    When the resource was created. A date-time string as described in RFC 3339, section 14.29.
    TimeUpdated string
    When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current state of the ODA private endpoint.
    timeCreated String
    When the resource was created. A date-time string as described in RFC 3339, section 14.29.
    timeUpdated String
    When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    The current state of the ODA private endpoint.
    timeCreated string
    When the resource was created. A date-time string as described in RFC 3339, section 14.29.
    timeUpdated string
    When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    The current state of the ODA private endpoint.
    time_created str
    When the resource was created. A date-time string as described in RFC 3339, section 14.29.
    time_updated str
    When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current state of the ODA private endpoint.
    timeCreated String
    When the resource was created. A date-time string as described in RFC 3339, section 14.29.
    timeUpdated String
    When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.

    Look up Existing OdaPrivateEndpoint Resource

    Get an existing OdaPrivateEndpoint 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?: OdaPrivateEndpointState, opts?: CustomResourceOptions): OdaPrivateEndpoint
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            compartment_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, Any]] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None,
            nsg_ids: Optional[Sequence[str]] = None,
            state: Optional[str] = None,
            subnet_id: Optional[str] = None,
            time_created: Optional[str] = None,
            time_updated: Optional[str] = None) -> OdaPrivateEndpoint
    func GetOdaPrivateEndpoint(ctx *Context, name string, id IDInput, state *OdaPrivateEndpointState, opts ...ResourceOption) (*OdaPrivateEndpoint, error)
    public static OdaPrivateEndpoint Get(string name, Input<string> id, OdaPrivateEndpointState? state, CustomResourceOptions? opts = null)
    public static OdaPrivateEndpoint get(String name, Output<String> id, OdaPrivateEndpointState 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 that the ODA private endpoint belongs to.
    DefinedTags Dictionary<string, object>
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) Description of the ODA private endpoint.
    DisplayName string
    (Updatable) User-defined name for the ODA private endpoint. Avoid entering confidential information. You can change this value.
    FreeformTags Dictionary<string, object>
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
    NsgIds List<string>
    (Updatable) List of OCIDs of network security groups
    State string
    The current state of the ODA private endpoint.
    SubnetId string

    The OCID of the subnet that the private endpoint belongs to.

    ** 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

    TimeCreated string
    When the resource was created. A date-time string as described in RFC 3339, section 14.29.
    TimeUpdated string
    When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.
    CompartmentId string
    (Updatable) The OCID of the compartment that the ODA private endpoint belongs to.
    DefinedTags map[string]interface{}
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) Description of the ODA private endpoint.
    DisplayName string
    (Updatable) User-defined name for the ODA private endpoint. Avoid entering confidential information. You can change this value.
    FreeformTags map[string]interface{}
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
    NsgIds []string
    (Updatable) List of OCIDs of network security groups
    State string
    The current state of the ODA private endpoint.
    SubnetId string

    The OCID of the subnet that the private endpoint belongs to.

    ** 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

    TimeCreated string
    When the resource was created. A date-time string as described in RFC 3339, section 14.29.
    TimeUpdated string
    When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.
    compartmentId String
    (Updatable) The OCID of the compartment that the ODA private endpoint belongs to.
    definedTags Map<String,Object>
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) Description of the ODA private endpoint.
    displayName String
    (Updatable) User-defined name for the ODA private endpoint. Avoid entering confidential information. You can change this value.
    freeformTags Map<String,Object>
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
    nsgIds List<String>
    (Updatable) List of OCIDs of network security groups
    state String
    The current state of the ODA private endpoint.
    subnetId String

    The OCID of the subnet that the private endpoint belongs to.

    ** 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

    timeCreated String
    When the resource was created. A date-time string as described in RFC 3339, section 14.29.
    timeUpdated String
    When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.
    compartmentId string
    (Updatable) The OCID of the compartment that the ODA private endpoint belongs to.
    definedTags {[key: string]: any}
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    description string
    (Updatable) Description of the ODA private endpoint.
    displayName string
    (Updatable) User-defined name for the ODA private endpoint. Avoid entering confidential information. You can change this value.
    freeformTags {[key: string]: any}
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
    nsgIds string[]
    (Updatable) List of OCIDs of network security groups
    state string
    The current state of the ODA private endpoint.
    subnetId string

    The OCID of the subnet that the private endpoint belongs to.

    ** 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

    timeCreated string
    When the resource was created. A date-time string as described in RFC 3339, section 14.29.
    timeUpdated string
    When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.
    compartment_id str
    (Updatable) The OCID of the compartment that the ODA private endpoint belongs to.
    defined_tags Mapping[str, Any]
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    description str
    (Updatable) Description of the ODA private endpoint.
    display_name str
    (Updatable) User-defined name for the ODA private endpoint. Avoid entering confidential information. You can change this value.
    freeform_tags Mapping[str, Any]
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
    nsg_ids Sequence[str]
    (Updatable) List of OCIDs of network security groups
    state str
    The current state of the ODA private endpoint.
    subnet_id str

    The OCID of the subnet that the private endpoint belongs to.

    ** 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

    time_created str
    When the resource was created. A date-time string as described in RFC 3339, section 14.29.
    time_updated str
    When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.
    compartmentId String
    (Updatable) The OCID of the compartment that the ODA private endpoint belongs to.
    definedTags Map<Any>
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) Description of the ODA private endpoint.
    displayName String
    (Updatable) User-defined name for the ODA private endpoint. Avoid entering confidential information. You can change this value.
    freeformTags Map<Any>
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
    nsgIds List<String>
    (Updatable) List of OCIDs of network security groups
    state String
    The current state of the ODA private endpoint.
    subnetId String

    The OCID of the subnet that the private endpoint belongs to.

    ** 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

    timeCreated String
    When the resource was created. A date-time string as described in RFC 3339, section 14.29.
    timeUpdated String
    When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.

    Import

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

     $ pulumi import oci:Oda/odaPrivateEndpoint:OdaPrivateEndpoint test_oda_private_endpoint "id"
    

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.24.0 published on Thursday, Feb 22, 2024 by Pulumi